documentation
Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
Best use case
documentation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
Teams using documentation should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/documentation/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation Compares
| Feature / Agent | documentation | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
# Documentation Workflow Bundle ## Overview Comprehensive documentation workflow for generating API documentation, architecture documentation, README files, code comments, and technical content from codebases. ## When to Use This Workflow Use this workflow when: - Creating project documentation - Generating API documentation - Writing architecture docs - Documenting code - Creating user guides - Maintaining wikis ## Workflow Phases ### Phase 1: Documentation Planning #### Skills to Invoke - `docs-architect` - Documentation architecture - `documentation-templates` - Documentation templates #### Actions 1. Identify documentation needs 2. Choose documentation tools 3. Plan documentation structure 4. Define style guidelines 5. Set up documentation site #### Copy-Paste Prompts ``` Use @docs-architect to plan documentation structure ``` ``` Use @documentation-templates to set up documentation ``` ### Phase 2: API Documentation #### Skills to Invoke - `api-documenter` - API documentation - `api-documentation-generator` - Auto-generation - `openapi-spec-generation` - OpenAPI specs #### Actions 1. Extract API endpoints 2. Generate OpenAPI specs 3. Create API reference 4. Add usage examples 5. Set up auto-generation #### Copy-Paste Prompts ``` Use @api-documenter to generate API documentation ``` ``` Use @openapi-spec-generation to create OpenAPI specs ``` ### Phase 3: Architecture Documentation #### Skills to Invoke - `c4-architecture-c4-architecture` - C4 architecture - `c4-context` - Context diagrams - `c4-container` - Container diagrams - `c4-component` - Component diagrams - `c4-code` - Code diagrams - `mermaid-expert` - Mermaid diagrams #### Actions 1. Create C4 diagrams 2. Document architecture 3. Generate sequence diagrams 4. Document data flows 5. Create deployment docs #### Copy-Paste Prompts ``` Use @c4-architecture-c4-architecture to create C4 diagrams ``` ``` Use @mermaid-expert to create architecture diagrams ``` ### Phase 4: Code Documentation #### Skills to Invoke - `code-documentation-code-explain` - Code explanation - `code-documentation-doc-generate` - Doc generation - `documentation-generation-doc-generate` - Auto-generation #### Actions 1. Extract code comments 2. Generate JSDoc/TSDoc 3. Create type documentation 4. Document functions 5. Add usage examples #### Copy-Paste Prompts ``` Use @code-documentation-code-explain to explain code ``` ``` Use @code-documentation-doc-generate to generate docs ``` ### Phase 5: README and Getting Started #### Skills to Invoke - `readme` - README generation - `environment-setup-guide` - Setup guides - `tutorial-engineer` - Tutorial creation #### Actions 1. Create README 2. Write getting started guide 3. Document installation 4. Add usage examples 5. Create troubleshooting guide #### Copy-Paste Prompts ``` Use @readme to create project README ``` ``` Use @tutorial-engineer to create tutorials ``` ### Phase 6: Wiki and Knowledge Base #### Skills to Invoke - `wiki-architect` - Wiki architecture - `wiki-page-writer` - Wiki pages - `wiki-onboarding` - Onboarding docs - `wiki-qa` - Wiki Q&A - `wiki-researcher` - Wiki research - `wiki-vitepress` - VitePress wiki #### Actions 1. Design wiki structure 2. Create wiki pages 3. Write onboarding guides 4. Document processes 5. Set up wiki site #### Copy-Paste Prompts ``` Use @wiki-architect to design wiki structure ``` ``` Use @wiki-page-writer to create wiki pages ``` ``` Use @wiki-onboarding to create onboarding docs ``` ### Phase 7: Changelog and Release Notes #### Skills to Invoke - `changelog-automation` - Changelog generation - `wiki-changelog` - Changelog from git #### Actions 1. Extract commit history 2. Categorize changes 3. Generate changelog 4. Create release notes 5. Publish updates #### Copy-Paste Prompts ``` Use @changelog-automation to generate changelog ``` ``` Use @wiki-changelog to create release notes ``` ### Phase 8: Documentation Maintenance #### Skills to Invoke - `doc-coauthoring` - Collaborative writing - `reference-builder` - Reference docs #### Actions 1. Review documentation 2. Update outdated content 3. Fix broken links 4. Add new features 5. Gather feedback #### Copy-Paste Prompts ``` Use @doc-coauthoring to collaborate on docs ``` ## Documentation Types ### Code-Level - JSDoc/TSDoc comments - Function documentation - Type definitions - Example code ### API Documentation - Endpoint reference - Request/response schemas - Authentication guides - SDK documentation ### Architecture Documentation - System overview - Component diagrams - Data flow diagrams - Deployment architecture ### User Documentation - Getting started guides - User manuals - Tutorials - FAQs ### Process Documentation - Runbooks - Onboarding guides - SOPs - Decision records ## Quality Gates - [ ] All APIs documented - [ ] Architecture diagrams current - [ ] README up to date - [ ] Code comments helpful - [ ] Examples working - [ ] Links valid ## Related Workflow Bundles - `development` - Development workflow - `testing-qa` - Documentation testing - `ai-ml` - AI documentation
Related Skills
update-oo-component-documentation
Update existing object-oriented component documentation following industry best practices and architectural documentation standards.
documentation-writer
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
documentation-templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
documentation-generation-doc-generate
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...
create-oo-component-documentation
Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards.
code-documentation
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
code-documentation-doc-generate
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...
code-documentation-code-explain
You are a code education expert specializing in explaining complex code through clear narratives, visual diagrams, and step-by-step breakdowns. Transform difficult concepts into understandable expl...
notion-research-documentation
Searches across your Notion workspace, synthesizes findings from multiple pages, and creates comprehensive research documentation saved as new Notion pages. Turns scattered information into structured reports with proper citations and actionable insights.
api-documentation
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
api-documentation-generator
Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices
writing-skills
Use when creating new skills, editing existing skills, or verifying skills work before deployment