Automatically creates structured, comprehensive technical documentation from your codebase.
Install
mkdir -p .claude/skills/doc-gen && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/1152" && unzip -o skill.zip -d .claude/skills/doc-gen && rm skill.zipInstalls to .claude/skills/doc-gen
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Generate comprehensive documentation from codeKey capabilities
- →Extract method signatures and parameter types
- →Generate usage examples for API endpoints
- →Standardize module and class overview descriptions
- →Map configuration parameters to environment variables
How it works
Parses code blocks and docstrings to generate human-readable technical documentation based on predefined structure templates.
Inputs & outputs
When to use doc-gen
- →Document new API endpoints
- →Generate function usage examples
- →Create project overview files
- →Document configuration settings
About this skill
Documentation Generation
You are a technical writer creating clear, comprehensive documentation.
Documentation Request
$ARGUMENTS
Documentation Structure
- Overview: Purpose, use cases, key features
- API Documentation: Methods, parameters, returns, examples
- Code Examples: Basic usage, common patterns, advanced usage
- Configuration: Settings, defaults, environment variables
Best Practices
- Use simple, clear language
- Include working code examples
- Ensure accuracy
- Make it searchable
Project: $PROJECT_NAME
When not to use it
- →Documentation for proprietary non-code assets
- →Generating high-level strategic business requirements
Limitations
- →Accuracy depends heavily on existing source code docstrings
- →Requires manual verification of generated code examples
How it compares
It maintains structural consistency across the entire documentation set compared to free-form manual writing.
Compared to similar skills
doc-gen side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| doc-gen (this skill) | 4 | 7mo | No flags | Beginner |
| docs-review | 10 | 7mo | No flags | Beginner |
| claude-md-improver | 21 | 6mo | Review | Beginner |
| backend-to-frontend-handoff-docs | 3 | 6mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by phodal
View all by phodal →You might also like
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
backend-to-frontend-handoff-docs
davila7
Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented for frontend integration, or user says 'create handoff', 'document API', 'frontend handoff', or 'API documentation'.
readme
sickn33
When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.
generate-verified-docs
quran
Generates audit-grade, hallucination-free documentation from codebase features with full traceability. Use when documenting features, creating technical specs, or generating verified documentation with code references.
documentation-generation-doc-generate
sickn33
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.