doc-updates

What problem does it solve?

Keeping documentation in sync with code changes is a constant challenge, often leading to outdated or inconsistent information. This skill automates the process of updating documentation files while enforcing project writing guidelines.

Core Features & Use Cases

• Context Collection: Gathers change context from git-workspace-review to understand deltas.
• Target Identification: Lists relevant files (README, wiki, docstrings) and prioritizes updates.
• Edit Application: Updates files with grounded language, referencing commands and configurations.
• ADR Management: Ensures new architectural decisions are captured in Architecture Decision Records (ADRs).
• Use Case: After implementing a new feature, use this skill to automatically update the README.md with new usage instructions, add a docstring to the affected function, and draft a new ADR if an architectural decision was made.

Quick Start

Run git-workspace-review to understand code changes, then use this skill to identify documentation targets for updates.