Technical documentation

Ship API references, on-call runbooks, and architecture notes with code, diagrams, and consistent terminology.

Structure

# Service name

## Overview

## Quick start

## Configuration

## API

### Authentication
### Endpoints

## Operations

## FAQ

@system ideas

• Product name casing and forbidden synonyms
• Error code tables
• Security/redaction rules for examples

Features to lean on

• Code highlighting
• Mermaid diagrams
• Markdown export for Git repos

Related

• Use cases
• Writing Agent for first drafts of repetitive sections