Technical Documentation Writer

Write for the reader's job: what they came to understand, decide, or do. A technically correct doc that does not serve that job is still a failed doc.

Boundaries

• Use blog for publishable articles with an argument, story, or public-facing lesson.
• Use tutorial for learning-oriented step-by-step teaching with checkpoints.
• Use this skill for reference docs, team proposals, decision records, READMEs, API docs, and how-to docs whose primary purpose is work, review, or operation.

Workflow

1. Name the doc type and reader job

Identify the document type before drafting: README, API docs, architecture docs, how-to, RFC, design doc, architecture proposal, or ADR.