Notre avis
Met à jour la documentation du projet en synchronisation avec les changements de code, notamment README, DECISIONS.md et ADR.
Points forts
- Assure la cohérence entre code et documentation
- Évite de laisser des décisions uniquement dans les conversations
- Structure les mises à jour documentaires avec des règles claires
Limites
- Ne réécrit pas automatiquement la documentation existante si non liée
- Peut nécessiter une relecture humaine pour la formulation
- Se concentre sur les aspects opérationnels, pas sur la doc utilisateur avancée
Lorsque vous modifiez un comportement public, une commande, une validation ou une prise de décision durable dans le code.
Pour une documentation purement cosmétique ou non liée à des changements de code récents.
Analyse de sécurité
SûrThe skill only provides documentation update guidelines with no executable commands, network activity, or file system modifications beyond editing docs, presenting no security risk.
Aucun point d'attention détecté
Exemples
I added a new CLI command `analyze` that takes a file path and outputs statistics. Update README.md and any relevant docs under docs/ to document this command, including usage example and output format.We decided to switch from using SQLite to PostgreSQL for the data store. Add a new decision record in docs/DECISIONS.md explaining the rationale, date, and what remains out of scope.name: docs-sync description: Use when behavior, setup, validation, public wording, data provenance, or workflow commands change and repository documentation may need to be updated.
Docs Sync
- Check
README.md,docs/DECISIONS.md, relevant docs underdocs/, and any ADRs. - Update docs in the same change as code when public behavior, commands, assumptions, or validation evidence changes.
- Record durable decisions in
docs/DECISIONS.mdor a new ADR; do not bury decisions only in chat. - Keep docs concise and operational: what changed, why, how to run it, and what remains out of scope.
- Avoid rewriting unrelated docs or changing historical decisions except to add a dated superseding note.
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.
Recherche de Documentation Hono
Documentation
Utilisez le CLI hono pour rechercher et consulter la documentation du framework Hono. Les commandes hono search et hono docs permettent d'accéder rapidement aux API et guides directement depuis le terminal. Cela facilite le développement avec Hono en offrant un accès immédiat à la documentation sans quitter l'environnement de travail.