vendeesign

doc-sync

"Rappel de synchronisation documentaire. Activer quand des changements significatifs viennent d'être faits dans le code : ajout de feature, création de fichier/dossier, changement d'architecture, ajout de dépendance, modification d'API, nouvelle commande ou script. Se manifeste en fin de tâche avec un rappel léger — ne bloque pas le travail. Ne pas activer pour des corrections mineures (typo, formatage, renommage local, commentaires) ni quand seuls des fichiers de test sont modifiés."

vendeesign 3 1 Updated 2mo ago
GitHub

Install

npx skillscat add vendeesign/codebloom/doc-sync

Install via the SkillsCat registry.

SKILL.md

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)

Quand NE PAS se déclencher

  • Corrections mineures : typo, formatage, renommage de variable locale
  • Modifications de commentaires uniquement
  • Fichiers de test ajoutés ou modifiés (sans changement de code source)
  • Refactoring interne sans impact sur l'API ou la structure publique
  • L'utilisateur demande explicitement de sauter la doc ("skip doc", "pas de doc")

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 /codebloom: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