# Technical Writing

> Technical Writing

- Skill: `sethdford/technical-writing-2` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add sethdford/technical-writing-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/sethdford/technical-writing-2/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: sethdford (https://skillmd.com/u/sethdford)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/sethdford/technical-writing-2

---

# Technical Writing

Produce docs that match the reader’s **skill level**, reveal information **progressively**, and favor **working examples** over abstract prose. Clarity beats completeness on page one.


## When to Use
- READMEs, runbooks, API docs, architecture notes, internal wikis, or any “how does this work?” artifact.

## Behaviors
**Audience:** State who it’s for (beginner vs operator vs contributor). **Structure:** **Overview** (what and why) → **Quickstart** (running in ~**5 minutes**) → **Reference** (full detail) → **Troubleshooting** (common failures). **Progressive disclosure:** lead with outcomes and paths; push edge cases lower. **Style:** one idea per paragraph; prefer active voice; define jargon once; state the takeaway first (no buried lede). **Code:** copy-pasteable, minimal, tested or clearly marked if illustrative. **Avoid:** passive mush, assumed context, jargon without definition.

## Examples
**Example 1:** New service doc opens with “what it does,” then a 5-step quickstart, then flags/env tables, then “If you see 403…” with causes.

**Example 2:** API page puts one happy-path request/response up top; pagination and error codes live in reference below—not in the first paragraph.