Our review
Generates comprehensive, well-structured documentation for code, including APIs, READMEs, and tutorials.
Strengths
- High output volume
- Covers multiple documentation types (API, README, guides)
- Includes code examples and use cases
- Logical and clear structure
Limitations
- May produce overly verbose or redundant content
- Requires precise input to avoid generic output
- Not suited for minimal documentation needs
When you need extensive documentation with thorough examples for a complex project.
When you need concise, lightweight documentation or for very small projects.
Security analysis
SafeThis 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.
No concerns found
Examples
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
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Typed Documentation Forms System
Documentation
Add typed comments, documentation, todos, and metadata to Scheme code using `(doc ...)` forms. Doc annotations are authoritative for type inference, extracted by search commands (lf-todo, lf-types), and integrated with the type checker and LSP. Useful for annotating functions, marking deprecations, or tracking localized improvements alongside the code.