Our review
Updates project documentation in sync with code changes, including README, DECISIONS.md, and ADRs.
Strengths
- Ensures code and documentation stay consistent
- Prevents burying decisions only in chat
- Provides clear rules for what and when to update
Limitations
- Does not rewrite unrelated documentation
- May require human review for tone and clarity
- Focuses on operational docs, not user-facing manuals
When changing public behavior, commands, validation, or making durable decisions that affect the codebase.
For cosmetic or unrelated documentation improvements not tied to recent code changes.
Security analysis
SafeThe skill only provides documentation update guidelines with no executable commands, network activity, or file system modifications beyond editing docs, presenting no security risk.
No concerns found
Examples
I added a new CLI command `analyze` that takes a file path and outputs statistics. Update README.md and any relevant docs under docs/ to document this command, including usage example and output format.We decided to switch from using SQLite to PostgreSQL for the data store. Add a new decision record in docs/DECISIONS.md explaining the rationale, date, and what remains out of scope.name: docs-sync description: Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository documentation may need to be updated.
Docs Sync
- Check
README.md,docs/DECISIONS.md, relevant docs underdocs/, and any ADRs. - Update docs in the same change as code when public behavior, commands, assumptions, or validation evidence changes.
- Record durable decisions in
docs/DECISIONS.mdor a new ADR; do not bury decisions only in chat. - Keep docs concise and operational: what changed, why, how to run it, and what remains out of scope.
- Avoid rewriting unrelated docs or changing historical decisions except to add a dated superseding note.
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Hono Documentation Search
Documentation
Use the hono CLI to search and view Hono framework documentation. It provides commands like hono search and hono docs to quickly find and browse documentation directly from the terminal. This is useful when developing with Hono and needing instant access to API references or guides.