Maintaining Documentation After Code Changes

What problem does it solve?

Code evolves rapidly, causing documentation to become stale and inaccurate, leading to confusion and increased support burden. This Skill provides a two-phase workflow to systematically synchronize project documentation with code changes, saving you time and reducing complexity.

Core Features & Use Cases

• Two-Phase Workflow: Guides through analysis of changes (using git diff) and systematic updating/restructuring of documentation.
• Combats Rationalizations: Explicitly addresses common excuses for skipping doc updates (e.g., "later PR," "code is self-documenting"), ensuring compliance.
• Comprehensive Doc Check: Ensures all relevant documentation (READMEs, CLAUDE.md, practices, examples) is reviewed and updated.
• Use Case: After implementing a new API endpoint, use this Skill to ensure the README, API documentation, and any relevant usage examples are updated, preventing developers from using outdated information and reducing support queries.

Quick Start

After completing a feature or bugfix:

/doc-review

The Skill will guide you through:

1. Reviewing recent code changes (git diff [base-branch]...HEAD)

2. Checking all relevant documentation files (README.md, CLAUDE.md, docs/)

3. Identifying and updating documentation gaps (new features, changed APIs)

4. Restructuring for clarity and consistency