Synthèse automatique
Génère et met à jour la documentation technique du code, des API et des projets en respectant le style déjà présent dans le dépôt.
Points forts
- Détecte automatiquement le format de documentation adapté au langage (JSDoc, docstrings, GoDoc, Rustdoc, Markdown)
- Recherche le style existant avec Grep pour rester cohérent avec le projet
- Relit le code pour vérifier que les paramètres, types de retour et exemples correspondent au comportement réel
- Signale explicitement les points ambigus nécessitant une relecture humaine
Limites
- Ne gère pas la coordination documentaire sur de nombreux fichiers, renvoyée vers doc-orchestration
- Ne couvre pas la rédaction de contenu utilisateur ou de textes d'interface
- La vérification des exemples reste une relecture manuelle, sans exécution automatique des blocs de code
À utiliser lorsqu'il faut ajouter des commentaires en ligne, écrire un README ou documenter une fonction ou un endpoint précis.
À éviter pour coordonner la documentation sur l'ensemble d'un dépôt ou pour rédiger des textes destinés aux utilisateurs finaux.
Analyse de sécurité
SûrThe skill is purely a documentation-writing guide constrained to Read, Write, Edit, Grep, and Glob. It contains no bash execution, network calls, credential handling, obfuscated payloads, or instructions to disable safety. File modification is limited to writing documentation content that the user explicitly requests, so execution risk is minimal.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Add JSDoc to the exported functions in src/utils/parse.ts, including params, return values, and a short usage example.Write a README for this project: one-line description, installation, quick start, usage, and configuration.Document the POST /api/orders endpoint in our Express router, listing the request body, responses, and error cases.name: documentation description: >- Generate and update technical documentation for code, APIs, and projects. Triggers on "document this", "add docs", "write a README", "add JSDoc", "generate API docs". NOT for multi-file doc coordination — use doc-orchestration. allowed-tools: Read, Write, Edit, Grep, Glob
When to Use
- Adding inline documentation (JSDoc, docstrings, GoDoc comments)
- Writing or updating a README
- Documenting an API endpoint or function signature
- Adding architecture or design documentation
When NOT to Use
- Coordinating docs across many files at once — use
doc-orchestration - Writing user-facing copy or UI text — use
copywriting - Creating an implementation plan — use
plan
Instructions
1. Detect What Needs Documentation
Read the target code or file. Determine the appropriate doc format:
| Language | Format | Example |
|----------|--------|---------|
| TypeScript/JavaScript | JSDoc | /** @param {string} name */ |
| Python | Docstrings | """Description.\n\nArgs:\n name: ...""" |
| Go | GoDoc | // FunctionName does X. |
| Rust | Rustdoc | /// Description |
| General | Markdown | README.md, docs/*.md |
2. Read Existing Documentation Style
Use Grep to find existing doc comments in the project. Match the format, level of detail, and tone already established. Check for a style guide in docs/ or CONTRIBUTING.md.
3. Write Documentation
Follow these principles:
- Lead with what and why, not how
- Keep descriptions concise — one sentence for simple items
- Document parameters, return values, and thrown errors
- Include a usage example for public APIs
- Note any side effects or important constraints
For README files:
- Start with project name and one-line description
- Include: installation, quick start, usage, configuration
- Add badges, links to full docs if applicable
4. Verify Accuracy
Re-read the code to confirm the documentation matches actual behavior. Check that:
- Parameter names and types are correct
- Return types match the implementation
- Examples compile/run if they are code blocks
Output
- List of files updated with documentation
- Summary of what was documented
- Any items that need manual review (ambiguous behavior, missing context)
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/documentation-generator-mrx3xxwk/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/documentation-generator-mrx3xxwk' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-generator-mrx3xxwk/download' --output '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md.part' && mv '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md.part' '.skill-downloads/documentation-generator-mrx3xxwk/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.
Outils déclarés par l’auteur (à vérifier dans votre agent) : Read, Write, Edit, Grep, Glob
Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.
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/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.claude/skills/documentation'Cursor
test -f '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.cursor/skills/documentation'Codex
test -f '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && test -s '.skill-downloads/documentation-generator-mrx3xxwk/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/documentation' && cp -R '.skill-downloads/documentation-generator-mrx3xxwk' '.agents/skills/documentation'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/documentation-generator-mrx3xxwk'openskills read 'documentation-generator-mrx3xxwk'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/documentation-generator-mrx3xxwk/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.