Notre avis
Garantit que la documentation du dépôt reste alignée avec les changements de code en vérifiant les documents pertinents, en les mettant à jour avec le code, et en consignant les décisions durables.
Points forts
- Favorise une mise à jour immédiate de la doc dans la même modification que le code, limitant la dérive documentaire.
- Encourage la traçabilité des décisions dans un journal persistant ou une ADR plutôt que dans les conversations.
- Prône une documentation concise et opérationnelle.
- Évite les réécritures inutiles et respecte les décisions historiques.
Limites
- Dépend de la structure documentaire existante (README, docs/DECISIONS.md, ADR) ; si absente, il faut les créer.
- Ne précise pas de format ou de modèle exact pour les ADR.
- Demande une certaine appréciation pour déterminer ce qui relève du comportement public ou d'une décision durable.
Lorsque des modifications de code affectent le comportement visible, les commandes, les preuves de validation ou le flux de travail, et que la documentation doit rester à jour.
En cas de refactoring interne mineur sans impact visible, ou lorsque la documentation est volontairement gelée pour une publication.
Analyse de sécurité
SûrThe skill only provides documentation synchronization guidance; it does not instruct execution of destructive, exfiltrating, or obfuscated actions, and declares no allowed tools.
Aucun point d'attention détecté
Exemples
I've added a `--dry-run` flag to the deploy command. Please update the README and any relevant docs to reflect the new option, and add a note in DECISIONS.md.We decided to switch from REST to gRPC. Record this decision in docs/DECISIONS.md or a new ADR, and update all affected documentation as part of this change.The test suite now requires a local Postgres instance. Update the setup instructions in README and note the validation change in the docs.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.
Créer un DESIGN.md
Documentation
Générez un fichier DESIGN.md complet pour tout site ou application afin de documenter les systèmes de conception dans un format lisible par les agents IA.