Documentation
Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
mkdir -p ./skills/documentation && curl -sfL https://raw.githubusercontent.com/mayurrathi/awesome-agent-skills/main/skills/documentation/SKILL.md -o ./skills/documentation/SKILL.mdRun in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).
Skill Content
# 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
🎯 Best For
- Technical writers
- API documentation teams
- Claude users
- Software engineers
- Development teams
💡 Use Cases
- Generating JSDoc/TSDoc comments
- Writing README files for new projects
- Code quality improvement
- Best practice enforcement
📖 How to Use This Skill
- 1
Install the Skill
Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.
- 2
Load into Your AI Assistant
Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.
- 3
Apply Documentation to Your Work
Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.
- 4
Review and Refine
Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.
❓ Frequently Asked Questions
Does it follow my documentation style?
Most documentation skills respect existing style. Provide a style guide or example in your prompt.
Is Documentation compatible with Cursor and VS Code?
Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.
Do I need specific dependencies for Documentation?
Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.
How do I install Documentation?
Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/documentation/SKILL.md, ready to use.
Can I customize this skill for my team?
Absolutely. Edit the SKILL.md file to add team-specific instructions, examples, or workflows.
⚠️ Common Mistakes to Avoid
Auto-generating without reviewing
AI documentation can contain inaccuracies. Always verify technical accuracy.
Skipping validation
Always test AI-generated code changes, even for simple refactors.
Missing dependency updates
Check if the skill requires updated dependencies or new packages.