/update-docs

4 steps v1.9.0

Synchronise toute la documentation du projet avec l'état actuel du code. Scanne tous les fichiers markdown, audite leur contenu, et dispatche des agents en parallèle pour mettre à jour les docs obsolètes.

Quand l'utiliser

• Après un refactoring important
• Avant une release
• Quand la doc est désynchronisée du code
• Après l'ajout de nouveaux skills, agents ou features

Quand NE PAS l'utiliser

Utilisez plutôt :

• Écrire une doc from scratch → créez-la manuellement
• Mettre à jour du code → /kensho ou /oneshot

Usage

# Mettre à jour TOUTE la documentation
/update-docs

# Cibler des fichiers spécifiques
/update-docs README.md CLAUDE.md

# Mode autonome avec sauvegarde
/update-docs -a -s

Flags

Flag	Nom	Description
-a	auto	Sauter les confirmations, appliquer toutes les mises à jour
-s	save	Sauvegarder le rapport d'audit dans docs/update-docs/

Pipeline

/update-docs
      │
 ┌────┴────┐
 │ 01-Scan │  Découvrir tous les .md, catégoriser
 └────┬────┘
      │
 ┌────┴─────┐
 │ 02-Audit │  Comparer chaque doc vs code actuel
 └────┬─────┘    (agents explore × N en parallèle)
      │
 ┌────┴──────┐
 │ 03-Update │  Mettre à jour les docs obsolètes
 └────┬──────┘    (1 agent executor par fichier, parallèle)
      │
 ┌────┴──────┐
 │ 04-Verify │  Cohérence croisée (compteurs, liens, versions)
 └───────────┘

Steps détaillés

Step 01 — Scan

• Découvre tous les fichiers .md du projet (Glob **/*.md)
• Catégorise par type : project-root, claude-config, skill-docs, agent-docs, specs, templates, workflows, profiles
• Exclut node_modules/, dist/, .git/, vendor/
• Si des fichiers sont passés en argument, utilise uniquement ceux-là

Step 02 — Audit

• Dispatche des agents explore (haiku) pour auditer chaque fichier
• Chaque agent vérifie :
  • Les chemins/fichiers référencés existent encore
  • Les noms de fonctions, classes, variables sont corrects
  • Les compteurs et statistiques sont à jour
  • Les exemples de code sont fonctionnels
  • Les liens internes sont valides
• Produit un rapport avec sévérité : critical | stale | minor

Step 03 — Update

• 1 agent executor (sonnet) par fichier à mettre à jour
• Tous les agents tournent en parallèle
• Utilise Edit (pas Write) pour des changements chirurgicaux
• Si un changement est ambigu : ajoute un <!-- TODO --> au lieu de deviner

Step 04 — Verify

• Vérifications croisées entre fichiers :
  • Compteur de skills cohérent partout
  • Compteur d'agents cohérent partout
  • Tous les skills listés dans les catalogues existent réellement
  • Liens internes valides
  • Numéros de version cohérents
• Rapport final avec statistiques

Fichiers ciblés

Le skill cible tous les markdowns du projet, notamment :

Catégorie	Exemples
Racine	README.md, CHANGELOG.md, CONTRIBUTING.md
Claude Code	CLAUDE.md, AGENTS.md, .claude/**/*.md
Skills	framework/skills/*/SKILL.md
Steps	framework/skills/*/steps/*.md
Agents	framework/agents/*.md
Specs	docs/specs/**/*.md
Templates	framework/templates/*.md
Workflows	framework/workflows/*.md
Profiles	framework/profiles/*.md

Outputs

Avec -s, les rapports sont sauvegardés dans docs/update-docs/{date}/ :

docs/update-docs/2026-03-27/
├── audit.md       ← rapport d'audit complet
├── updates.md     ← log des modifications appliquées
└── verify.md      ← rapport de vérification croisée