Notre avis

Génère ou met à jour la documentation pour une fonctionnalité en cours de développement, assurant le liage entre documents et la mise à jour du README principal.

Points forts

Automatise la création d'une documentation Markdown cohérente et structurée.
Identifie et met à jour les documents connexes, évitant les documents orphelins.
S'intègre à Git pour extraire le contexte et les modifications de la fonctionnalité.
Génère un rapport clair des modifications effectuées.

Limites

Dépend d'une structure de répertoire de documentation prédéfinie (ex. docs/).
Peut ne pas gérer des projets très volumineux ou non conventionnels sans personnalisation.
Les exemples générés peuvent nécessiter une vérification manuelle de leur exactitude.

Quand l'utiliser

Lors de l'ajout d'une nouvelle fonctionnalité ou de changements importants nécessitant une mise à jour de la documentation du projet.

Quand l'éviter

Lorsque seules des modifications mineures sont effectuées ne nécessitant pas une mise à jour complète de la documentation, ou lorsque le projet déconseille explicitement la documentation automatisée.

Exemples

Generate documentation for a new authentication feature

Generate documentation for the user authentication feature I just implemented. Use the standard docs directory and update the README if needed.

Update documentation after refactoring a module

I've refactored the payment processing module. Please update its documentation and check if any related documents need to be linked.

Add documentation for a new API endpoint

Document the new /api/v2/orders endpoint. Ensure the README and related docs are updated and linked.

name: doc:update description: Crées la documentation pour la fonctionnalité en cours. Mets à jour le readme global du projet si nécessaire. Lie les documents entre eux pour ne pas avoir de documentation orpheline. La documentation est générée dans les répertoire de documentation du projet. model: sonnet allowed-tools: [Bash, Read, Write, Edit, Glob, Grep] version: 1.0.0 license: MIT

Documentation de fonctionnalité

Instructions à Exécuter

IMPORTANT : Exécute ce workflow étape par étape :

Génère ou met à jour la documentation pour la fonctionnalité en cours de développement, en s'assurant que tous les documents sont liés et que le README principal est à jour.

Purpose

Maintenir une documentation cohérente, à jour et bien interconnectée pour le projet.

Variables

CURRENT_BRANCH: Branche Git en cours
DOC_DIR: Répertoire de documentation du projet (détection automatique)
README_PATH: Chemin vers le README principal du projet
FEATURE_NAME: Nom de la fonctionnalité extraite de la branche et des modifications

Relevant Files

README.md - Documentation principale du projet
docs/ - Répertoire de documentation standard
Fichiers source de la fonctionnalité
Fichiers de tests associés

Workflow

1. Analyse du contexte

Identifie la branche Git en cours (git branch --show-current)
Analyse les modifications de la branche :
- Fichiers modifiés (git status)
- Diff par rapport à main/master (git diff)
- Commits de la branche (git log)
Extrait le nom de la fonctionnalité depuis :
- Le nom de la branche (ex: feature/user-auth → User Authentication)
- Les commits de la branche
- Les prompts récents de la session
Détermine le répertoire de documentation :
- Cherche docs/, documentation/, ou équivalent
- Crée le répertoire si nécessaire
Identifie les informations clés :
- Fichiers principaux modifiés
- Tests associés
- Dépendances ajoutées/modifiées

2. Génération de la documentation

Crée ou met à jour le fichier de documentation :
- Titre et description claire
- Utilisation et exemples
- Architecture et composants
- Configuration nécessaire
- Tests et validation
- Limitations et notes
Format Markdown structuré avec :
- Table des matières si nécessaire
- Blocs de code avec syntaxe
- Liens vers fichiers sources
- Exemples d'utilisation concrets

3. Mise à jour du README principal

Vérifie si la fonctionnalité doit être mentionnée dans le README
Ajoute ou met à jour la section appropriée :
- Fonctionnalités principales
- Structure du projet
- Documentation disponible
Maintient la cohérence du format existant
Préserve l'ordre et la hiérarchie

4. Liaison des documents

Identifie les documents connexes :
- Documentation de fonctionnalités liées
- Guides d'architecture
- Tutoriels
- ADRs (Architecture Decision Records)
Ajoute des liens bidirectionnels :
- Depuis le nouveau document vers les connexes
- Depuis les connexes vers le nouveau document
Vérifie l'absence de liens cassés
Crée un index si nécessaire pour les projets volumineux

5. Validation et rapport

Vérifie la qualité de la documentation :
- Tous les exemples sont fonctionnels
- Les liens sont valides
- Le formatage Markdown est correct
- Pas de typos évidentes
Génère un rapport de ce qui a été créé/modifié

Report

Affiche un résumé structuré :

Documentation générée :
- Fonctionnalité : [NOM]
- Fichier créé/modifié : [CHEMIN]
- Taille : [LIGNES] lignes

Modifications README :
- Section modifiée : [SECTION]
- Ajouts : [DESCRIPTION]

Liens créés :
- [DOC1] ↔ [DOC2]
- [DOC3] ↔ [DOC4]

Documents liés :
- [LISTE DES DOCS CONNEXES]

Best Practices

Documentation focalisée sur l'utilisation, pas l'implémentation
Exemples concrets et testés
Langage clair et concis (style bullet points)
Liens relatifs pour la portabilité
Pas de duplication entre README et docs détaillées
README = vue d'ensemble, docs/ = détails
Maintenir la cohérence du ton et du format

Génération de documentation de fonctionnalité

Recommandé pour