# Keep the docs true

Keep the docs true: Have an agent check a doc page against the code it describes, and fix the parts that drifted.

Source: https://codeherder.com/use-cases/keep-the-docs-true/

Use cases

Have an agent check a doc page against the code it describes, and fix the parts that drifted.

[Request access →](https://codeherder.com/get-started/#request-access)

## The work

Point an agent at a doc page and the code it claims to describe. It checks each statement against the current code, corrects what has drifted, and opens a pull request. A person confirms each correction is right before it merges.

## Why it stalls

Code changes on every merge. A doc only changes when a person remembers to update it, so it falls behind quietly, and nobody notices until a reader hits the gap first.

How it runs

## Plan, code, review, merge, verify

1. plan Reads the doc page and the code it describes, and lists every claim that needs checking.
2. code Corrects each claim that no longer matches the code, and cites the symbol it checked against.
3. review Re-checks every correction against the current code, ignoring the doc's old wording.
4. merge Opens a pull request limited to the doc page named.
5. verify Confirms the doc's claims now match the code, and nothing it corrected was already right.

## What you need on hand

- The doc page that might be stale
- The code it should describe
- A person to confirm each correction before it ships

## Proof, not a promise

No example task or measured figure fits this job yet. What's real is the mechanism: an agent reads the code a doc page claims to describe, corrects each statement that no longer matches, and a person confirms the correction before it merges.

Don't know what to write

## Two ready-to-file briefs for this job

[One doc page no longer matches the product Point at the doc page and the feature it describes, and get the drifted parts corrected.](https://codeherder.com/starter-briefs/doc-page-out-of-date/) [A code example in the docs no longer runs Point at the broken example, and get a version that actually runs against the current code.](https://codeherder.com/starter-briefs/code-example-that-no-longer-runs/)

[See every starter brief →](https://codeherder.com/starter-briefs)

Keep going

## Related jobs

[Cover untested code Point an agent at a file with no tests, and get a real test suite back instead of a promise to write one later.](https://codeherder.com/use-cases/cover-untested-code/) [Run the routine chores Hand off dependency bumps, migrations, and lint fixes: the chores every repo needs and nobody wants to own.](https://codeherder.com/use-cases/run-the-routine-chores/) [Clear the bug backlog Send the small bugs nobody has time for to an agent, and get them fixed the same day.](https://codeherder.com/use-cases/clear-the-bug-backlog/)

[← See every job](https://codeherder.com/use-cases)