Notre avis
Génère une documentation complète incluant la documentation d'API, les README, les commentaires de code, les tutoriels et la documentation d'architecture.
Points forts
- Volume de sortie élevé
- Couvre tous les aspects importants et les cas limites
- Inclut des exemples de code
- Structure logique
Limites
- Peut nécessiter une vérification manuelle pour l'exactitude
- Peut ne pas capturer les nuances sans contexte
- Peut être trop verbeux
Lorsque vous avez besoin de générer rapidement une documentation pour du code ou des API existants.
Lorsque vous avez besoin d'une documentation hautement personnalisée ou spécifique à une marque nécessitant une connaissance approfondie du domaine.
Analyse de sécurité
SûrThis skill is a static instruction file for an AI agent to generate documentation. It contains no executable commands, network requests, file system access, or any other potential security risks.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following function: function add(a, b) { return a + b; }Create a detailed README.md file for this project. Include installation steps, usage examples, and API reference. The project is a Python library for data validation.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.