Technical Documentation
When to use
- Generate API documentation (OpenAPI 3.1)
- Create architecture guides and ADRs
- Write tutorials and onboarding guides
- Build reference documentation
- Create Mermaid diagrams
- Automate changelogs
API documentation
- OpenAPI 3.1 specification generation
- Interactive API docs (Swagger UI, Redoc)
- SDK generation from specs
- Developer portal design
Architecture documentation
- Architecture Decision Records (ADRs)
- System design documents
- Component diagrams
- Data flow documentation
Diagrams (Mermaid)
- Flowcharts and sequence diagrams
- Entity-relationship diagrams
- Class diagrams
- State machines
- Deployment architecture
Tutorials
- Step-by-step guides
- Progressive learning paths
- Code examples with explanations
- Quickstart guides