Doc Sync — Conscience de la dette documentaire
Ce skill s'active quand des changements significatifs sont faits dans le code, pour rappeler que la documentation doit suivre.
Quand se déclencher
- •Nouvelle feature ou nouveau fichier créé
- •Changement d'architecture ou de structure
- •Nouvelle dépendance ajoutée
- •Nouvelle commande ou script ajouté
- •Changement d'API publique (endpoints, exports, props)
- •Modification de la config (env vars, build, CI)
Quoi vérifier
CHANGELOG.md
- •Les changements sont-ils documentés ?
- •Format Keep a Changelog respecté ?
- •Catégories : Added, Changed, Fixed, Removed, Deprecated, Security
- •Version et date à jour ?
CLAUDE.md
- •Section "Structure du projet" reflète l'état réel ?
- •Section "Commandes" à jour (nouvelles commandes, scripts) ?
- •Section "Dépendances clés" à jour ?
- •Section "Contexte actuel" reflète ce qui a été fait ?
- •Section "Conventions" toujours exacte ?
README.md
- •Instructions d'installation encore valides ?
- •Exemples d'utilisation à jour ?
- •API publique documentée correctement ?
- •Prérequis à jour ?
DESIGN_SYSTEM.md (si UI)
- •Nouveaux composants documentés ?
- •Tokens de design à jour ?
- •Changements de couleurs, typo, spacing reflétés ?
Templates disponibles dans references/
Le plugin fournit des templates prêts à copier :
| Template | Usage | Copié par /setup quand... |
|---|---|---|
DESIGN_SYSTEM.md | Design system (couleurs, typo, spacing, composants) | Projet avec UI |
API_DOC.md | Documentation d'API (endpoints, auth, erreurs) | Projet avec backend/API |
CHANGELOG.md | Historique des versions (Keep a Changelog) | Toujours |
Quand un de ces fichiers manque et que le projet en aurait besoin → le signaler.
Comportement
- •Ne pas bloquer le travail pour la doc — signaler, pas imposer
- •Rappel léger : "Les fichiers X et Y ont été modifiés. CHANGELOG et CLAUDE.md sont-ils à jour ?"
- •Ne pas modifier la doc automatiquement sans validation
- •Regrouper les rappels — un seul rappel en fin de tâche, pas à chaque fichier
- •Signaler les templates manquants — si le projet a une API mais pas d'API_DOC.md