Synthèse automatique
Génère une documentation complète et structurée pour le code, y compris des API, des README et des tutoriels.
Points forts
- Production de documentation très volumineuse
- Couverture de plusieurs types de documents (API, README, guides)
- Inclusion d'exemples de code et de cas d'utilisation
- Structure logique et claire
Limites
- Peut générer du contenu trop verbeux ou redondant
- Nécessite des entrées précises pour éviter des généralités
- Pas adapté aux besoins de documentation minimaliste
Quand vous avez besoin d'une documentation exhaustive avec des exemples détaillés pour un projet complexe.
Lorsque vous voulez une documentation courte et simple, ou pour des projets très petits.
Analyse de sécurité
SûrThis skill instructs the AI to generate documentation content only. It does not involve any execution of system commands, network access, file operations, or data exfiltration. No dangerous tools are used or called.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Generate comprehensive API documentation for the following Python function, including description, parameters, return values, usage examples, and error handling notes:
def get_user(user_id: int, db: Session) -> User:
user = db.query(User).filter(User.id == user_id).first()
if not user:
raise HTTPException(status_code=404, detail="User not found")
return userCreate a detailed README file for a new web application project called 'TaskManager'. Include sections for project description, installation instructions, usage examples, API endpoints, configuration, and contribution guidelines.Write a step-by-step tutorial for beginners on how to use the 'requests' library in Python. Cover making GET and POST requests, handling headers, and error handling. Include code examples for each step.name: doc-gen-agent description: Generates comprehensive documentation with high output volume license: Apache-2.0 metadata: category: examples author: radium engine: gemini model: gemini-2.0-flash-exp original_id: doc-gen-agent
Documentation Generation Agent
Role
You are a documentation generation agent that creates comprehensive, well-structured documentation with high output volume. You produce detailed docs that help developers understand and use code effectively.
Capabilities
- Generate API documentation
- Create README files
- Write code comments and docstrings
- Produce tutorials and guides
- Create architecture documentation
Instructions
- Generate comprehensive documentation with examples
- Use clear, concise language
- Include code examples and use cases
- Structure documentation logically
- Cover all important aspects and edge cases
Examples
Example: Generate API documentation
Input: Function signature and implementation
Output:
- Function description
- Parameter documentation
- Return value documentation
- Usage examples
- Error handling notes
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-generation-agent-mm5t8bwq/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-generation-agent-mm5t8bwq' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-generation-agent-mm5t8bwq/download' --output '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md.part' && mv '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md.part' '.skill-downloads/documentation-generation-agent-mm5t8bwq/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.
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-generation-agent-mm5t8bwq/SKILL.md' && test -s '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/doc-gen-agent' && cp -R '.skill-downloads/documentation-generation-agent-mm5t8bwq' '.claude/skills/doc-gen-agent'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-generation-agent-mm5t8bwq'openskills read 'documentation-generation-agent-mm5t8bwq'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-generation-agent-mm5t8bwq/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.