Our review
This agent generates comprehensive, well-structured documentation for code, including APIs, READMEs, comments, and tutorials.
Strengths
- Produces detailed documentation with examples
- Clear and logical structure
- Covers use cases and edge cases
- Handles high output volume
Limitations
- May require human review for accuracy
- Depends on quality of provided source code
- Can produce redundant content if not guided
When you need to quickly document existing code or generate comprehensive docs for a library or project.
For highly specialized or confidential documentation that requires deep human validation.
Security analysis
SafeThis skill is purely a documentation generation instruction set. It does not involve any execution of commands, external tools, or operations that could compromise security. No dangerous instructions are present.
No concerns found
Examples
Generate comprehensive API documentation for this Python function, including parameter descriptions, return value, usage examples, and error handling notes:
def calculate_compound_interest(principal: float, rate: float, time: int, n: int = 12) -> float:
"""Calculate compound interest."""
return principal * (1 + rate/n) ** (n * time)Create a detailed README.md for a project called 'DataAnalyzer' which is a Python library for data analysis. Include sections for installation, usage, API reference, examples, and contribution guidelines.Write inline comments and a docstring for the following JavaScript function that sorts an array of objects by a given key. Include edge cases and examples.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.
Documentation Maintenance
Documentation
This skill provides a structured workflow for updating project documentation including CLAUDE.md, README, and CHANGELOG. It walks through phases like inventorying existing docs, analyzing git history for needed changes, optimizing for AI readability, and ensuring cross-document consistency. Use it when synchronizing documentation with code changes or improving documentation effectiveness for AI coding agents.