hn.today

We have LLMs now. Why are the docs still wrong?

amendary.com11 points3 comments
Screenshot of We have LLMs now. Why are the docs still wrong?

Large language models make creating initial documentation fast, but keeping docs correct as code changes remains hard because context and audience matter. A simple code change - like a timeout moving from 30 to 60 seconds - can require different treatments across an engineering reference, a customer guide, a runbook, or an incident report. Retrieval techniques or vector indexes surface candidate passages but cannot decide whether a passage describes current defaults, a historical state, an override, or a different service. Models can produce polished rewrites that introduce incorrect options or remove important caveats, and diffs can mislead if they touch tests or conditional logic. That means evidence must come from the exact change and the live document, and reviewers need to see the old text, the proposed edit, and the supporting code context to trust a correction.

Amendary addresses this by mapping specific documentation pages to the repositories or release signals they document, then checking those pages against code changes and drafting corrections that attach the source evidence. Corrections appear in a review queue (or as a GitHub PR) so humans can inspect the precise passage, supporting diff, and rationale before merging; paid plans allow owners to auto-apply eligible edits but do not eliminate the need for ownership and judgment. The aim is fewer Slack queries and smaller, explainable documentation edits that match product changes rather than generating more noisy work.

Read on amendary.com3 comments on Hacker News

Summary generated by AI from the linked article. hn.today is not affiliated with Hacker News or Y Combinator.

More in Web

Bevy 0.20

Bevy 0.20

Bevy 0.20 introduces faster and more accurate Solari rendering with macOS support, along with numerous UI widget additions and shader language updates. The release also features syntax improvements, event triggers, and quality-of-life enhancements for the Rust-based game engine. (bevy.org)

Agents in the Cloud

Agents in the Cloud

Agents in the Cloud enables developers to run coding agents in isolated cloud environments, freeing them from traditional hardware constraints. It offers a free, open-source platform that supports various models and subscriptions, with easy setup on Mac or servers using providers like Hetzner or DigitalOcean. (agentsinthecloud.com)

Bootstrap 6 Alpha 1

Bootstrap 6 Alpha 1

Bootstrap 6 Alpha 1 introduces a framework-agnostic design toolkit with updated components, visual design, and powerful JavaScript plugins. It is built to be accessible for all users, including AI and developers, and is available via npm as version 6.0.0-alpha.1. (getbootstrap.com)

The daily digest

Today's best Hacker News stories, summarized and screenshotted, one email a day.