with one click
docs-engineering
// Audit and update all project documentation to stay in sync with the current development status.
// Audit and update all project documentation to stay in sync with the current development status.
| 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, acknowledgementsCHANGELOG.md โ release notes and version historyCLAUDE.md โ stack, architecture, key gotchas, project conventionsdoc/product_design.md, doc/ui-mockups.md, doc/TODOs.md (skip files that don't exist yet)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.