1.7 KiB
Documentation Templates
Copy-paste ready templates for API documentation, architecture docs, and OpenAPI specifications.
Available Templates
API Endpoint Documentation
Complete template for documenting a single API endpoint with all required sections.
Includes: Method/path, description, authentication, request/response formats, error codes, rate limits, code examples
Use when: Documenting REST API endpoints, creating API reference pages
Architecture Document
Comprehensive template for system architecture documentation with Mermaid diagrams.
Includes: Executive summary, system overview, component descriptions, data flow, ADRs, security model
Use when: Documenting new systems, onboarding materials, architecture reviews
OpenAPI Specification
Starter OpenAPI 3.1 specification with common patterns and best practices.
Includes: Info object, servers, authentication, common schemas (errors, pagination), example endpoint
Use when: Starting new API documentation, generating from scratch
Quick Start
- Copy template file to your documentation directory
- Replace all
[FILL IN]placeholders - Remove optional sections if not needed
- Validate and test
Template Customization
For your project:
- Update company/project names
- Adjust authentication schemes
- Add project-specific error codes
- Include relevant examples
For your team:
- Add team-specific sections
- Include internal links
- Reference team tools/dashboards
Related: Examples | Reference | Return to Agent