Our review
Updates all project documentation files after code changes.
Strengths
- Automates the documentation update process after code changes.
- Ensures consistency between English and Chinese README versions.
- Automatically runs tests to verify changes.
Limitations
- Requires specific files (KNOWLEDGE_BASE.md, README.md, README_ZH.md) to already exist.
- Depends on sub-skills (update-knowledge-base, sync-readme) being available.
- Does not cover automatically generated documentation (e.g., JSDoc, API docs).
Use this skill after any changes that affect the UI, API, or project configuration.
Avoid using it for purely internal changes or minor fixes with no user-facing impact.
Security analysis
SafeThe skill only instructs to run documentation update skills and 'npm test', which are standard, safe operations for maintaining project docs. No destructive commands, exfiltration, or obfuscation.
No concerns found
Examples
Update all docs after adding OpenCode supportUpdate documentation after modifying CLI commandsname: 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.
Typed Documentation Forms System
Documentation
Add typed comments, documentation, todos, and metadata to Scheme code using `(doc ...)` forms. Doc annotations are authoritative for type inference, extracted by search commands (lf-todo, lf-types), and integrated with the type checker and LSP. Useful for annotating functions, marking deprecations, or tracking localized improvements alongside the code.