| name | doc-updater |
| description | Update project documentation after implementing a feature. Use when: updating docs, documentation, update docs after implementation, sync docs with code. |
Doc Updater
Update documentation in docs/ after a feature is implemented.
When to Use
- After finishing a feature implementation
- When specs, code, or architecture changed and docs are stale
- When onboarding docs need to reflect new patterns
Procedure
- Read the spec for the implemented feature (from
specs/ or the conversation)
- Read the implemented code to understand what actually shipped
- Search
docs/ for existing documentation that may need updates
- For each affected doc:
- If it exists: update the relevant sections, preserving the existing format
- If it doesn't exist: create it following the format of neighboring docs
- Check for broken references (links to moved/renamed files)
What to Document
- API changes: new endpoints, changed parameters, updated responses
- Architecture changes: new modules, changed boundaries, new patterns
- Setup changes: new dependencies, changed build steps, new env vars
- Configuration changes: new settings, changed defaults
Rules
- Match the existing documentation style and format
- Do NOT rewrite docs that don't need changes
- Keep docs concise — one paragraph per concept, not walls of text
- Update the table of contents if the doc has one
- If no
docs/ directory exists, create it with a README