Manuals / Technical Writing / Ch 2

A · CraftBeginner30 min read

2. Structure for skimmers

Technical Writing · 32 pages source format

Purpose up top. Prerequisites. Numbered steps. Expected results. Troubleshooting. Links out.

What you'll learn

  • Inverted pyramid
  • Headings
  • Task orientation

Outline first

Do this now

Outline your doc with H2s only. No paragraphs yet.

Pro tip. Prefer verbs in headings: “Rotate the API key” not “API keys.”

Clear?

Checklist