Notre avis
Génère une documentation complète et structurée pour le code, incluant API, README, commentaires et tutoriels.
Points forts
- Produit une documentation volumineuse et détaillée avec exemples.
- Couvre plusieurs formats : API, README, guides d'architecture.
- Utilise un langage clair et structuré pour faciliter la compréhension.
Limites
- Peut générer du contenu redondant si le code est mal structuré.
- N'adapte pas automatiquement le ton à l'audience cible (débutant vs expert).
- Dépend de la qualité des entrées pour produire des exemples précis.
Idéal pour documenter rapidement un projet existant ou un nouveau module avec des spécifications claires.
À éviter quand une documentation minimaliste ou très spécialisée est préférable, ou si le code est encore instable.
Analyse de sécurité
SûrThe skill only instructs the AI to generate documentation; no commands, external calls, or dangerous actions.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following function: def calculate_discount(price: float, discount_rate: float, is_member: bool = False) -> float: ... Include function description, parameter docs, return value, usage examples, and error handling notes.Create a detailed README.md for a Python library named 'textutils' that provides string manipulation functions. Include installation, quick start, API reference, and contribution guidelines.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.
Maintenance de la documentation
Documentation
Cette compétence propose un workflow structuré pour mettre à jour la documentation du projet, notamment CLAUDE.md, README et CHANGELOG. Elle guide à travers des phases comme l'inventaire des documents existants, l'analyse de l'historique Git pour identifier les changements nécessaires, l'optimisation pour la lisibilité par l'IA et la cohérence entre les documents. À utiliser lors de la synchronisation de la documentation avec les modifications de code ou pour améliorer l'efficacité de la documentation pour les agents de codage IA.