Synthèse automatique
Génère de la documentation technique (API, architecture, guides utilisateur) en analysant le code, les configurations et les commentaires d'un dépôt.
Points forts
- Couvre plusieurs types de documentation : référence API, schémas d'architecture, guides utilisateur et documentation d'architecture
- Met l'accent sur une documentation « vivante » synchronisée avec le code et sur la standardisation à l'échelle du dépôt
- Inclut l'automatisation (linting, CI) et une étape de validation de l'exactitude
- Rappelle explicitement d'éviter d'exposer secrets, URL internes ou données sensibles
Limites
- Suppose un accès au code source et aux exigences ; inutilisable sans base de code de référence
- La qualité dépend fortement des commentaires et de la structure existants du projet
- Les détails de mise en œuvre et modèles sont renvoyés vers un fichier de ressources externe non fourni ici
À utiliser lorsqu'il faut produire ou industrialiser une documentation complète et cohérente à partir d'un dépôt de code existant.
À éviter pour une simple explication ponctuelle ou lorsque le code source et les exigences ne sont pas accessibles.
Analyse de sécurité
SûrThis is a pure prompt/instruction file for documentation generation. No tools are declared, no shell commands, network calls, file deletions, or secret exfiltration are instructed. It even includes an explicit safety note to avoid exposing secrets or internal URLs in generated docs. The only external reference is a local resources/implementation-playbook.md, which is benign.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Analyse le dossier src/api de ce dépôt et génère une référence API complète : endpoints, paramètres, codes de réponse et exemples d'appels. Propose aussi une config CI pour vérifier que la doc reste à jour.Génère un document d'architecture pour ce projet : décris les modules principaux, leurs dépendances et produis un schéma en Mermaid, avec une section sur les choix de conception observés dans le code.Uniformise la documentation de ce monorepo : définis une structure et une terminologie communes, puis liste les fichiers à créer ou réécrire avec les chemins exacts.name: documentation-generation-doc-generate description: "You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices." risk: safe source: community date_added: "2026-02-27"
Automated Documentation Generation
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.
Use this skill when
- Generating API, architecture, or user documentation from code
- Building documentation pipelines or automation
- Standardizing docs across a repository
Do not use this skill when
- The project has no codebase or source of truth
- You only need ad-hoc explanations
- You cannot access code or requirements
Context
The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency across documentation types. Focus on creating living documentation that stays synchronized with code.
Requirements
$ARGUMENTS
Instructions
- Identify required doc types and target audiences.
- Extract information from code, configs, and comments.
- Generate docs with consistent terminology and structure.
- Add automation (linting, CI) and validate accuracy.
- If detailed examples are required, open
resources/implementation-playbook.md.
Safety
- Avoid exposing secrets, internal URLs, or sensitive data in docs.
Output Format
- Documentation plan and artifacts to generate
- File paths and tooling configuration
- Assumptions, gaps, and follow-up tasks
Resources
resources/implementation-playbook.mdfor detailed examples and templates.
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
mkdir -p '.skill-downloads/automated-documentation-generation-mrzxura2' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/automated-documentation-generation-mrzxura2/download' --output '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md.part' && mv '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md.part' '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md'2. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Extrait original : Requirements
$ARGUMENTS
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/documentation-generation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxura2' '.claude/skills/documentation-generation-doc-generate'Cursor
test -f '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/documentation-generation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxura2' '.cursor/skills/documentation-generation-doc-generate'Codex
test -f '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && test -s '.skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/documentation-generation-doc-generate' && cp -R '.skill-downloads/automated-documentation-generation-mrzxura2' '.agents/skills/documentation-generation-doc-generate'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/automated-documentation-generation-mrzxura2'openskills read 'automated-documentation-generation-mrzxura2'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/automated-documentation-generation-mrzxura2/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.