Notre avis
Met à jour automatiquement toute la documentation du projet après des modifications de code.
Points forts
- Automatise la mise à jour de plusieurs fichiers de documentation
- Vérifie l'intégrité des commandes documentées avec des tests
- Synchronise les versions anglaise et chinoise du README
- S'appuie sur git pour détecter précisément les changements
Limites
- Nécessite que les fichiers KNOWLEDGE_BASE.md, README.md et README_ZH.md existent
- Dépend de la précision de l'analyse git
- Ne gère pas les mises à jour de traductions autres que le chinois
Après tout changement impactant l'utilisateur (nouvel adaptateur, commandes CLI, format de configuration).
Pour des modifications internes uniquement ou lorsque la documentation n'est pas prioritaire.
Analyse de sécurité
PrudenceThe 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.
Exemples
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
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Décision de Pivot Stratégique
Documentation
Documente une décision stratégique de pivot ou de persévérance avec preuves, analyse et justification. À utiliser pour évaluer s'il faut changer de cap sur un produit, une fonctionnalité ou une stratégie en fonction des retours du marché.