documentation

name	documentation
description	Documentation generation workflow covering API docs, architecture docs, README files, code comments, and technical writing.
category	workflow-bundle
risk	safe
source	personal
date_added	2026-02-27

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

Limitations

• Use this skill only when the task clearly matches the scope described above.
• Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
• Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.