Notre avis
Génère une documentation complète et structurée pour le code, y compris des API, des README et des tutoriels.
Points forts
- Production de documentation très volumineuse
- Couverture de plusieurs types de documents (API, README, guides)
- Inclusion d'exemples de code et de cas d'utilisation
- Structure logique et claire
Limites
- Peut générer du contenu trop verbeux ou redondant
- Nécessite des entrées précises pour éviter des généralités
- Pas adapté aux besoins de documentation minimaliste
Quand vous avez besoin d'une documentation exhaustive avec des exemples détaillés pour un projet complexe.
Lorsque vous voulez une documentation courte et simple, ou pour des projets très petits.
Analyse de sécurité
SûrThis skill instructs the AI to generate documentation content only. It does not involve any execution of system commands, network access, file operations, or data exfiltration. No dangerous tools are used or called.
Aucun point d'attention détecté
Exemples
Generate comprehensive API documentation for the following Python function, including description, parameters, return values, usage examples, and error handling notes:
def get_user(user_id: int, db: Session) -> User:
user = db.query(User).filter(User.id == user_id).first()
if not user:
raise HTTPException(status_code=404, detail="User not found")
return userCreate a detailed README file for a new web application project called 'TaskManager'. Include sections for project description, installation instructions, usage examples, API endpoints, configuration, and contribution guidelines.Write a step-by-step tutorial for beginners on how to use the 'requests' library in Python. Cover making GET and POST requests, handling headers, and error handling. Include code examples for each step.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.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.