Notre avis
Met à jour tous les fichiers de documentation du projet après des modifications de code.
Points forts
- Automatise le processus de mise à jour de la documentation après chaque changement.
- Assure la cohérence entre les versions anglaise et chinoise du README.
- Vérifie automatiquement les modifications avec les tests.
Limites
- Nécessite que des fichiers spécifiques (KNOWLEDGE_BASE.md, README.md, README_ZH.md) existent déjà.
- Dépend de sous-compétences (update-knowledge-base, sync-readme) qui doivent être disponibles.
- Ne couvre pas la documentation générée automatiquement (ex: JSDoc, API docs).
Utilisez cette compétence après toute modification affectant l'interface utilisateur, l'API ou la configuration du projet.
Évitez de l'utiliser pour des changements purement internes ou des corrections mineures sans impact utilisateur.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
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.
Architecte de Documentation Technique
Documentation
Analyse un code source existant pour produire une documentation technique complète (10 à 100+ pages), inclant des vues d'architecture, des décisions de conception et des guides de dépannage. Idéal pour la documentation système, les guides d'architecture ou les plongées techniques.