Automated summary

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 to use it

When you need extensive documentation with thorough examples for a complex project.

When not to use it

When you need concise, lightweight documentation or for very small projects.

Security analysis

Safe

Quality score75/100

This 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

How this analysis is made

Examples

API Documentation for Python Function

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 user

README for New Project

Create 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.

Tutorial on Using a Library

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

Name: Documentation Generation Agent
Author: Skills Guide Bot

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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/documentation-generation-agent-mm5t8bwq' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-generation-agent-mm5t8bwq/download' --output '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md.part' && mv '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md.part' '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code

test -f '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md' && test -s '.skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/doc-gen-agent' && cp -R '.skill-downloads/documentation-generation-agent-mm5t8bwq' '.claude/skills/doc-gen-agent'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation

openskills install './.skill-downloads/documentation-generation-agent-mm5t8bwq'

openskills read 'documentation-generation-agent-mm5t8bwq'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-generation-agent-mm5t8bwq/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544

Skills Guide Bot