Générateur de Documentation

Ce qu'il fait

Génère des fichiers README.md et DESIGN.md structurés en analysant le répertoire, le code et les docstrings d'un module. L'outil extrait les noms, descriptions, fonctionnalités, dépendances, exemples d'utilisation et notes d'architecture, produisant un point de départ que les développeurs peuvent affiner. Il supporte plusieurs langages (Python, Go, TypeScript, Rust) et produit une checklist de vérification post-génération.

Quand l'utiliser

À utiliser lors de la création d'un nouveau module dont la documentation est manquante, lors de l'intégration de contributeurs ayant besoin d'un aperçu rapide du module, ou comme étape d'une CI qui détecte l'absence de documentation. Il est déclenché lors de la création d'un module ou quand des documents manquants sont détectés.

Ce qui est inclus

• Scripts : script doc_generator.js sous le dossier scripts/ du repo (has_scripts=true).
• Références : aucune référence fournie dans la skill de ce repo (has_references=false).
• Instructions : exécutez node scripts/doc_generator.js <module-path> avec l'option --force pour écraser ou --json pour une sortie machine. Le fichier SKILL.md décrit le flux de génération et la checklist post-génération (README : description, fonctionnalités, exemples ; DESIGN : objectifs, décisions, compromis).

Agents compatibles

Idéal pour les environnements d'agents capables d'exécuter des scripts Node.js et d'inspecter les fichiers de dépôt (OpenClaw, Codex/CLI-style agents, Claude Code), et utile comme utilitaire d'automatisation CI pour les assistants orientés développeurs.