Document
Module specified
- Find all docs mentioning the module
- Update for accuracy against current code
- Align terminology across files
- Add or refresh
docs/status/[module]-status.mdif the project uses status docs - Update public API docs (OpenAPI, typedoc, rustdoc) when the project maintains them
organize (or whole docs tree)
- Scan for overlap — merge or cross-link when >50% duplicate
- Archive obsolete docs if the project has an
archive/convention - Fix broken links and index files (
README,DOCUMENT-INDEX, etc.) - Ensure each doc has a Related or navigation section if that is the norm
- Accuracy pass — signatures, CLI flags, env vars, test counts vs real code
- Report: merged, archived, fixed, still stale
No docs tree yet
If the project has no docs/ but needs one, propose a minimal layout (README index + module page) — do not create sprawl without user approval.
Always
- Document only what exists — no wishlist features
- Prefer updating existing docs over sprawl
Related skills
- audit — status docs and gap tables
- release — changelog and release docs
- discover-project — find docs layout and conventions