Notre avis
Génère une documentation complète et structurée pour le code, y compris des fichiers README, des API, des commentaires et des didacticiels.
Points forts
- Produit des volumes élevés de documentation bien organisée
- Inclut des exemples de code et des cas d'utilisation
- Couvre les aspects importants et les cas limites
Limites
- Peut nécessiter un réglage fin pour s'adapter aux normes spécifiques du projet
- La génération automatique peut manquer de contexte métier
- Risque de documentation générique si les instructions ne sont pas précises
Lorsque vous devez rapidement créer ou mettre à jour une documentation de code existant pour améliorer la maintenabilité et l'expérience développeur.
Pour une documentation très spécialisée nécessitant une expertise humaine approfondie ou lorsque la base de code change trop fréquemment.
Analyse de sécurité
SûrThis skill instructs an AI to generate documentation; it does not interact with the system, execute commands, or handle sensitive data. No security concerns.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following function: def calculate_interest(principal, rate, time):
return principal * rate * time / 100
Include parameter descriptions, return value, usage example, and error handling notes.Generate a README.md file for a Python project that calculates compound interest. Include sections for description, installation, usage, API reference, and contributing guidelines.Write Google-style docstrings for each function in the following module:
def add(a, b):
return a + b
def subtract(a, b):
return a - b
def multiply(a, b):
return a * bname: 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.