# Technical Documentation & OpenAPI Spec Design

> Guidelines for writing developer-first documentation, OpenAPI 3.0 specs, interactive curl snippets, and Mermaid architecture diagrams.

Canonical: https://www.agentickit.co/skills/technical-docs
Last updated: 2026-11-18

## Key practices
- Maintain single source of truth for API contracts using OpenAPI 3.0 YAML/JSON
- Provide copy-pasteable request and response examples for every endpoint
- Include interactive Mermaid architecture diagrams illustrating data flows
- Keep documentation synchronized with code changes during the feature PR review

## Related
- [technical-writer](https://www.agentickit.co/agents/technical-writer)
- [tech-lead](https://www.agentickit.co/agents/tech-lead)
- [/write-docs](https://www.agentickit.co/commands/write-docs)
- [/release](https://www.agentickit.co/commands/release)
