Pathwise

Manuals / Technical Writing / Chapter 2

A · Craft · beginner · Week 1 · Chapter 2 of 8

Structure for skimmers

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

Path progress
25%

Step 1 of 1

Outline first

Outline firstDrag stickies · tap for tips
Study mapDrag stickies · tap for tipsKeep it shortdrag · tap →Name the waitdrag · tap →Scope locatorsdrag · tap →Trace when stuckdrag · tap →One browser firstdrag · tap →Isolate statedrag · tap →Assert the UIdrag · tap →Retry wiselydrag · tap →Seed datadrag · tap →Close the loopdrag · tap →Keep it shortdrag · tap →Name the waitdrag · tap →Scope locatorsdrag · tap →Trace when stuckdrag · tap →One browser firstdrag · tap →Isolate statedrag · tap →Pathwise hackdrag · tap →Outline firstdrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

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.”

Was this step clear?
Chapter learning outcomes
  • Inverted pyramid
  • Headings
  • Task orientation

Clear these before you leave