Agents
Technical Writer
Technical documentation, API references, user guides, and SDK docs
- Mode:
subagent - Quality: 4.25/5 (Good)
- Tags: technical-writing, documentation, api-reference, user-guides, sdk
API Documenter
API documentation, OpenAPI specs, and interactive documentation portals
- Mode:
subagent - Quality: 4.62/5 (Excellent)
- Tags: api-docs, openapi, swagger, documentation, code-examples
Documentation Engineer
Documentation systems architecture including guides, tutorials, and APIs
- Mode:
subagent - Quality: 4.38/5 (Good)
- Tags: documentation, architecture, tutorials, guides, developer-docs
Diagram Architect
C4 models, Mermaid diagrams, PlantUML, and architecture visualization
- Mode:
subagent - Quality: 4.62/5 (Excellent)
- Tags: diagrams, c4, mermaid, plantuml, architecture, visualization
Usage Examples
Quality Stats
- Average score: 4.47/5
- 2 Excellent, 2 Good rating
- Total tokens: ~4,500 (avg ~1,125 per agent)
- Coverage: Writing + API docs + architecture + systems
Common Workflows
Architecture & Documentation Pack
Architecture & Documentation Pack
Complete documentation + architecture:Includes: microservices-architect, api-architect, database-architect, diagram-architect, documentation-engineer
API Documentation Workflow
API Documentation Workflow
- API Architect — Design API
- API Documenter — Write API documentation and OpenAPI spec
- Technical Writer — User guides and tutorials
- Diagram Architect — API flow diagrams
System Documentation
System Documentation
- Diagram Architect — Architecture diagrams (C4 model)
- Documentation Engineer — Documentation site structure
- Technical Writer — Guides and tutorials
- API Documenter — API reference
Developer Portal
Developer Portal
- Documentation Engineer — Information architecture
- API Documenter — Interactive API reference
- Technical Writer — Getting started guides
- Diagram Architect — Visual explanations
When to Use
Choose Technical Writer when...
Choose Technical Writer when...
- Writing user guides and tutorials
- Creating SDK documentation
- Documenting features for end users
- Writing release notes
- Creating README files
Choose API Documenter when...
Choose API Documenter when...
- Writing API reference documentation
- Creating OpenAPI/Swagger specs
- Building interactive API explorers
- Documenting REST/GraphQL APIs
- Generating code examples
Choose Documentation Engineer when...
Choose Documentation Engineer when...
- Designing documentation systems
- Building docs-as-code pipelines
- Selecting documentation tools (Docusaurus, MkDocs, etc.)
- Information architecture
- Documentation site maintenance
Choose Diagram Architect when...
Choose Diagram Architect when...
- Creating C4 architecture models
- Writing Mermaid diagrams
- Designing PlantUML diagrams
- Visualizing system architecture
- Creating flow diagrams
Documentation Types
API Reference
Agent: API Documenter
- OpenAPI/Swagger specs
- Endpoint descriptions
- Request/response examples
- Authentication guides
User Guides
Agent: Technical Writer
- Getting started tutorials
- How-to guides
- Concept explanations
- Troubleshooting guides
Architecture Docs
Agent: Diagram Architect
- C4 models (Context, Container, Component, Code)
- Sequence diagrams
- Data flow diagrams
- Infrastructure diagrams
Developer Portal
Agent: Documentation Engineer
- Site structure and navigation
- Search and discovery
- Version management
- Content organization
Integration with Development
Docs in CI/CD
Docs in CI/CD
Integrate documentation into your development workflow:
- API Documenter — Generate OpenAPI spec from code
- Documentation Engineer — Deploy docs site
- CI/CD Engineer — Automate docs builds
- Code Reviewer — Review docs in PRs
Docs-as-Code
Docs-as-Code
Treat documentation like code:
- Version control (Git)
- Code review process
- Automated testing (broken links, examples)
- CI/CD deployment
Best Practices
Documentation quality matters. Well-written docs reduce support burden, improve developer experience, and accelerate adoption.
Keep Docs Current
- Update docs in the same PR as code changes
- Use automated testing for code examples
- Review docs during code review
Multiple Formats
- Tutorials (learning-oriented)
- How-to guides (task-oriented)
- Reference (information-oriented)
- Explanation (understanding-oriented)
Tools & Formats
Diagram Formats
Diagram Formats
Diagram Architect supports:
- Mermaid — Text-based diagrams (flowcharts, sequence, ER, C4)
- PlantUML — UML diagrams
- C4 Model — Architecture documentation (Context, Container, Component, Code)
- Graphviz — Graph visualization
Documentation Platforms
Documentation Platforms
Documentation Engineer works with:
- Docusaurus — React-based docs sites
- MkDocs — Python-based static sites
- GitBook — Modern documentation platform
- Mintlify — Beautiful API documentation
- ReadTheDocs — Open source documentation hosting
API Specification Formats
API Specification Formats
API Documenter supports:
- OpenAPI 3.x (Swagger) — REST APIs
- GraphQL Schema — GraphQL APIs
- AsyncAPI — Event-driven APIs
- JSON Schema — Data validation