Documentation Update

Maintain project documentation — changelog, architecture docs, user guides, API references. Use when this capability is needed.

tomevault-io 9983996 2 files · 1.8 KB Updated

File contents

Documentation Update Skill

Update project documentation to reflect current state of the codebase.

Steps

  1. Review changes — Check recent commits, merged PRs, and sprint results for documentable changes.
  2. Update CHANGELOG.md — Add entries for new features, fixes, and breaking changes.
  3. Check architecture docs — Flag if architectural changes need documentation updates.
  4. Update user guides — Ensure CLI usage, dashboard features, and config options are documented.
  5. 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.

Source: trsdn/aiscrum-pro — distributed by TomeVault.

tomevault-io/skills-registry/tree/main/trsdn--aiscrum-pro--documentation-update commit 9983996a91

Frequently asked questions

npx skillmds@latest add tomevault-io/documentation-update