Notre avis
Met à jour toute la documentation du projet après des modifications de code, en analysant les changements et en synchronisant les fichiers README et base de connaissances.
Points forts
- Automatise le processus de mise à jour documentaire en une commande
- Assure la cohérence entre les versions anglaise et chinoise du README
- Vérifie que les modifications ne cassent pas les tests
- Inclut une revue des changements avant validation
Limites
- Nécessite une configuration préalable (fichiers KNOWLEDGE_BASE.md, README.md, README_ZH.md)
- Ne gère que les documentations textuelles, pas les diagrammes ou autres formats
- Peut être trop générique pour des projets avec une documentation très spécifique
Après tout changement impactant l'interface utilisateur ou l'architecture, comme l'ajout d'un adaptateur ou la modification de commandes CLI.
Pour des modifications mineures ou internes qui n'affectent pas l'expérience utilisateur ou la documentation existante.
Analyse de sécurité
SûrThe 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.
Aucun point d'attention détecté
Exemples
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
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.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.