Our review
Generates comprehensive, well-structured documentation for code, including API docs, READMEs, comments, and tutorials.
Strengths
- Produces high-volume, detailed documentation with examples.
- Covers multiple formats: API, README, architecture guides.
- Uses clear and logical structure to aid understanding.
Limitations
- May generate redundant content if input code is poorly structured.
- Does not automatically adjust tone for different audiences (beginner vs expert).
- Output quality depends on input quality for accurate examples.
Best for quickly documenting an existing project or a new module with clear specifications.
Avoid when minimal or highly specialized documentation is needed, or if the code is still unstable.
Security analysis
SafeThe skill only instructs the AI to generate documentation; no commands, external calls, or dangerous actions.
No concerns found
Examples
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
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.