docs-system — v1.0.0
Installe et maintient un système de documentation complet dans n'importe quel dépôt. Utilisez ce skill lorsqu'un projet a besoin que ses docs soient organisés, classifiés, indexés et maintenus synchronisés — ou lorsque l'on vous demande de "mettre en place le système de documentation / la taxonomie des docs / les recueils de documentation".
Le skill est implémenté par quatre scripts (dans scripts/) ; ils sont invoqués dans l'ordre. Tous sont idempotents et préservent l'historique (git mv) ; la migration est validée avec --dry-run d'abord.
Quand l'utiliser
- Un dépôt contient des documents épars, non classifiés → installez le système et migrez-les.
- Un document a été créé ou modifié → régénérez le recueil de ce dossier (étape obligatoire).
- Quelqu'un demande un index / glossaire / "mémorial" / taxonomie des documents.
Commandes (scripts)
| Commande | Script | Objectif |
|---|---|---|
| bootstrap | scripts/docs-bootstrap.sh <dépôt> | Installer le kit : créer les dossiers de catégories, copier les documents de gouvernance (taxonomie/modèles/guide-démarrage/registre/glossaire), installer les 4 scripts, ajouter la règle doc au fichier rules de l'agent. Idempotent. |
| migrate | `scripts/docs-migrate.sh [--dry-run | --apply] <dépôt>` |
| compile | scripts/docs-compile.sh <dossier> | (Re)construire <dossier>/MEMORIAL.md — un recueil ordonné par date de chaque document avec index + lien de glossaire + corps complets. Reconstruction déterministe : idempotent / ajout automatique / déduplication / réorganisation. --clean <dossier> le supprime. |
| append | scripts/docs-append.sh <doc> ["résumé"] | Ajouter une ligne de lien pour un document à l'index README.md de son dossier (idempotent). |
Workflow standard
# 1. configuration (une fois par dépôt)
cp docs-system.conf.example .docs-system.conf # éditer PROJET_NOM, RÈGLES_AGENT, BUCKET_PLAN
# 2. installation
scripts/docs-bootstrap.sh .
# 3. migration des documents existants — DRY-RUN D'ABORD, vérifier, puis appliquer
scripts/docs-migrate.sh --dry-run .
scripts/docs-migrate.sh --apply .
# 4. construction des recueils
pour d in documentation fonctionnalités tests modifications plans; do
scripts/docs-compile.sh "docs/$d"
done
# 5. finaliser : régénérer docs/documentation/REGISTRE-DOCUMENTATION.md, éditer GLOSSAIRE.md avec les termes du projet
RÈGLE CONTINUE OBLIGATOIRE
Après avoir créé ou modifié un document dans docs/<dossier>/, exécutez
scripts/docs-compile.sh docs/<dossier> et commitez le MEMORIAL.md régénéré avec le document.
Ne modifiez jamais MEMORIAL.md à la main (il est généré). Cette règle est également écrite dans le fichier de règles de l'agent du dépôt cible par bootstrap.
Marqueurs d'en-tête de document (imposés)
Chaque fichier .md porte, sous son H1 :
<!-- version --> · <!-- classification: TYPE --> · <!-- date --> · <!-- dernière-mise-à-jour -->.
date est défini une fois (création) ; seul dernière-mise-à-jour change lors des modifications. Types :
FONCTIONNALITÉ / TEST / CONCEPTION / LACUNES / ANALYSE / MODIFICATION / ÉTUDE / REVUE / ARCHITECTURE / RÉSUMÉ / PLAN.
Sécurité / annulation
docs-migrate.shutilise par défaut--dry-run; vérifiez le tableau avant--apply.- Annuler les recueils :
scripts/docs-compile.sh --clean docs/<dossier>oufind docs -name MEMORIAL.md -delete. - Tout est suivi par git ;
git revertannule une exécution. Les déplacements sont des renommages (historique préservé).
Références
references/LIVRET-DE-BORD.md— procédure complète, paramètres de configuration, vérification, annulation.