| name | documentation-update |
| description | Maintain project documentation — changelog, architecture docs, user guides, API references. |
Documentation Update Skill
Update project documentation to reflect current state of the codebase.
Steps
- Review changes — Check recent commits, merged PRs, and sprint results for documentable changes.
- Update CHANGELOG.md — Add entries for new features, fixes, and breaking changes.
- Check architecture docs — Flag if architectural changes need documentation updates.
- Update user guides — Ensure CLI usage, dashboard features, and config options are documented.
- Verify accuracy — Cross-check documented features against actual codebase.
Rules
- Never modify ADRs without explicit stakeholder confirmation.
- Follow existing documentation style and formatting conventions.
- Document the "what" and "why", not just the "how".
- Keep examples up to date with current API/CLI signatures.