Notre avis
Génère une documentation complète et structurée pour du code, avec un volume élevé de contenu.
Points forts
- Production de documentation volumineuse et détaillée
- Inclusion d'exemples de code et de cas d'utilisation
- Structure logique et claire
Limites
- Peut être verbeux ou générer du contenu redondant
- Nécessite une relecture humaine pour la précision
- Ne remplace pas une documentation maintenue manuellement
Utilisez cet agent lorsque vous devez générer rapidement une documentation de base pour une API, un module ou un projet.
Évitez de l'utiliser pour une documentation nécessitant un style très spécifique ou une intégration étroite avec un système de documentation existant.
Analyse de sécurité
SûrThe skill is a pure text-generation prompt for documentation. It does not involve any tool execution, file system access, network calls, or system commands. There are no destructive or exfiltration instructions.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following function, including description, parameters, return values, usage examples, and error handling notes. Function: def calculate_tax(income: float, deductions: list[float] = []) -> float: ...Create a detailed README.md for my project. It should include an overview, installation instructions, usage examples, configuration options, and contribution guidelines. The project is a Python CLI tool for data analysis.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.