---
name: technical-documentation
description: Write, edit, and structure technical documentation. Use for README files, API docs, architecture docs, runbooks, setup guides, developer guides, release notes, migration guides, troubleshooting docs, and documentation generated from code or product behavior.
---

# Technical Documentation

Create documentation that helps a real operator, developer, or stakeholder complete a task.

## Workflow

1. Identify the reader, prerequisite knowledge, and job-to-be-done.
2. Inspect the implementation, commands, schemas, or product behavior before documenting it.
3. Prefer task-oriented structure: overview, prerequisites, steps, validation, troubleshooting.
4. Include exact commands, paths, configuration keys, and expected outputs when useful.
5. Separate confirmed facts from assumptions or TODOs.
6. Keep docs maintainable: avoid duplicating source-of-truth content unnecessarily.

## Style

- Be concise and specific.
- Use examples for ambiguous APIs or workflows.
- Put warnings near the risky step, not in a detached section.