| name | docs-engineering |
| description | Audit and update all project documentation to stay in sync with the current development status. |
When performing documentation engineering, always follow these steps:
-
Survey recent changes by running git log --oneline -20 and skimming the diff of recent commits. This surfaces new features, removed dependencies, and behavioral changes that documentation may not yet reflect.
-
Audit all documentation against the current codebase and development status. The review scope must include — without exception:
README.md — features list, prerequisites, acknowledgements
CHANGELOG.md — release notes and version history
CLAUDE.md — stack, architecture, key gotchas, project conventions
doc/development.md, doc/user-guide.md (landing page) and doc/user-guide/*.md (chapters), doc/api.md, doc/troubleshooting.md, doc/TODOs.md
samples/README.md — sample scripts and their required features/phases
- Code comments for human developers
-
Revise and update any documentation that is stale, incomplete, or inconsistent with the current code. Ensure new features, removed dependencies, behavioral changes, and architectural decisions are reflected accurately.
-
Remove completed items from doc/TODOs.md. If a summary of completed work is warranted, add a brief note before removing the items.
-
Commit documentation changes using the commit-and-push skill, grouped by topic. Do not mix unrelated documentation changes in a single commit.