Notre avis
Ce agent génère de la documentation complète et structurée pour le code, incluant des API, des README, des commentaires et des tutoriels.
Points forts
- Produit une documentation détaillée avec des exemples
- Structure logique et claire
- Couvre les cas d'utilisation et les erreurs
- Gère un volume élevé de contenu
Limites
- Peut nécessiter une révision humaine pour la précision
- Dépend de la qualité du code source fourni
- Peut produire du contenu redondant si non guidé
Lorsque vous devez documenter rapidement un code existant, créer une documentation complète pour une bibliothèque ou un projet.
Pour de la documentation très spécialisée ou confidentielle nécessitant une validation humaine approfondie.
Analyse de sécurité
SûrThis skill is purely a documentation generation instruction set. It does not involve any execution of commands, external tools, or operations that could compromise security. No dangerous instructions are present.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for this Python function, including parameter descriptions, return value, usage examples, and error handling notes:
def calculate_compound_interest(principal: float, rate: float, time: int, n: int = 12) -> float:
"""Calculate compound interest."""
return principal * (1 + rate/n) ** (n * time)Create a detailed README.md for a project called 'DataAnalyzer' which is a Python library for data analysis. Include sections for installation, usage, API reference, examples, and contribution guidelines.Write inline comments and a docstring for the following JavaScript function that sorts an array of objects by a given key. Include edge cases and examples.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.