Our review
Updates all project documentation after code changes in one command.
Strengths
- Automates updates across multiple documentation files
- Verifies documented commands work via tests
- Syncs English and Chinese README versions
- Leverages git to detect changes accurately
Limitations
- Requires existence of KNOWLEDGE_BASE.md, README.md, and README_ZH.md
- Relies on git analysis which may miss subtle changes
- Only syncs Chinese translation, not other languages
After any user-facing change like new adapters, CLI commands, or config format modifications.
For purely internal changes or when documentation maintenance is not a priority.
Security analysis
CautionThe skill runs `npm test`, which executes code from the project's test suite. While this is a common development practice, it could inadvertently cause harm if the test suite contains destructive commands. No other risky operations are present, and the purpose is legitimate (documentation update).
- •Executes `npm test` which runs arbitrary test code from the repository; could potentially have unintended side effects if the test suite is malicious or buggy.
Examples
Update all docs after adding OpenCode supportI've modified the CLI command flags for the build command. Please update all project documentation accordingly.The configuration format has changed to include a new 'timeout' field. Update all relevant documentation files.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.
Documentation Maintenance
Documentation
This skill provides a structured workflow for updating project documentation including CLAUDE.md, README, and CHANGELOG. It walks through phases like inventorying existing docs, analyzing git history for needed changes, optimizing for AI readability, and ensuring cross-document consistency. Use it when synchronizing documentation with code changes or improving documentation effectiveness for AI coding agents.