Trustworthy docs for your inherited codebase.
What it does
Reconstructs trustworthy documentation for an existing codebase by verifying its behavior against the code and recording coverage, quirks, and unknowns.
When to use it
Use when an existing system is under-documented, its documentation no longer matches its code, or an investigation must end in documents; not when documenting a code change.
How to use it
Give it an existing codebase to document; it produces a grounded documentation tree, findings note, and coverage ledger without changing the system.
What you provide
- An existing project
Good to know
- starts one helper agent per item, so the count depends on the work
- starts 1 helper agents
What you need · 4
Requires the technical-writing skill as background for hard rules, document classification, truth rules, and style.
Uses documenting-contracts for endpoint, message, command, and payload templates when documenting contract surfaces; an installation requirement is unstated.
Follows writing-runbooks whenever the campaign touches a runbook; an installation requirement is unstated.
Uses diagramming-processes to draw the traced end-to-end flows included in processes.md; an installation requirement is unstated.
Access · 0
No additional actions listed.