Notre avis
Génère une documentation complète et structurée pour le code, avec un volume de sortie élevé.
Points forts
- Production rapide de documentation volumineuse
- Inclusion d'exemples de code et de cas d'utilisation
- Structure logique et couverture des cas limites
Limites
- Peut générer du contenu redondant ou verbeux
- Nécessite une relecture humaine pour l'exactitude
- Manque de compréhension contextuelle avancée
Quand vous avez besoin de créer rapidement une documentation exhaustive pour un code existant.
Quand la documentation nécessite une adaptation fine au domaine ou une expertise spécialisée.
Analyse de sécurité
SûrThis skill is a prompt-based documentation generator with no declared tools or executable actions. It instructs an AI to produce text output only, with no access to shell, network, or file system. There is no risk of destructive or exfiltrating behavior.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following Python module. Include function descriptions, parameter types, return values, and usage examples for each public function.Create a detailed README.md for my project. Include an overview, installation instructions, usage examples, API reference, and contribution guidelines.Write Google-style docstrings for all functions in this file. Include descriptions of parameters, return values, and raise exceptions.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
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Architecte de Documentation Technique
Documentation
Analyse un code source existant pour produire une documentation technique complète (10 à 100+ pages), inclant des vues d'architecture, des décisions de conception et des guides de dépannage. Idéal pour la documentation système, les guides d'architecture ou les plongées techniques.