Our review
Updates all project documentation after code changes by analyzing git status and syncing README and knowledge base files.
Strengths
- One-command automation of the documentation update workflow
- Ensures consistency between English and Chinese README versions
- Includes verification (tests and command checks) before committing
- Reviews differences to avoid unintended changes
Limitations
- Requires pre-existing documentation files (KNOWLEDGE_BASE.md, README.md, README_ZH.md)
- Only covers text documentation, not diagrams or other media
- May be too broad for projects with highly specialized documentation needs
After any user-facing or architectural change, such as adding a new adapter, modifying CLI commands, or changing configuration format.
For purely internal or minor changes that do not affect user experience or existing documentation.
Security analysis
SafeThe skill instructs running git status, 'npm test', and invoking other documentation skills. These actions are common development tasks and do not pose a security risk of data exfiltration or system damage in a trusted environment.
No concerns found
Examples
Update all docs after adding OpenCode support.I've modified the CLI commands for the project. Please update the documentation accordingly.We changed the config format. Update all documentation files including README, README_ZH, and KNOWLEDGE_BASE.name: update-docs description: Update all project documentation after code changes.
Update Documentation
Instructions
One-click command to update all project documentation after code changes.
Steps
-
Analyze Changes
- Check git status for modified files
- Review recent commits if no uncommitted changes
- Identify what documentation needs updating
-
Update KNOWLEDGE_BASE.md
- Run the
update-knowledge-baseskill - Document any architectural or feature changes
- Run the
-
Update README.md
- Add new features or commands
- Update examples if API changed
- Ensure accuracy of all documented commands
-
Sync README_ZH.md
- Run the
sync-readmeskill - Ensure Chinese documentation matches English
- Run the
-
Verify
- Run tests to ensure nothing broken:
npm test - Check that all documented commands work
- Review diff before committing
- Run tests to ensure nothing broken:
When to Use
- After adding a new adapter
- After adding or modifying CLI commands
- After changing the configuration format
- After any user-facing changes
Output
All documentation files updated and in sync:
- KNOWLEDGE_BASE.md (if exists)
- README.md
- README_ZH.md
Examples
Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.