Best for
- Projects whose README lies about how to run them
- Onboarding that takes a week of asking colleagues
- APIs documented only by their source code
What you give it
- The project, and who the documentation is for
- Answers about intent where the code cannot tell the why
What you get back
- Documentation verified by execution — setup steps that were actually run
- The right document types: getting-started, how-to, reference, explanation — not one swamp
- A drift report: everywhere existing docs contradict the code today
How it works
- Reads the code first, then the existing docs, and lists where they disagree.
- Runs every setup step and command it documents — unverified instructions are marked as such.
- Separates document types by the question they answer: get started, solve a task, look up, understand.
- Writes for the named reader, defining terms a newcomer will not know.
- Leaves the docs maintainable: structure, ownership notes, and what to update when things change.
Example
You: Document the service properly: new developers take days to get it running.
Result: A verified getting-started (every command executed while writing it, two broken steps found and fixed), an environment-variables reference generated from what the code actually reads, and a short architecture note explaining the three decisions newcomers always question.
Limits — please read
- It documents what is; design intent only you know gets captured by asking you.
- Docs rot — it can set up the structure that slows rot, not stop time.
- Generated references match code at generation time; it wires regeneration in where possible.