Pathwise

Manuals / Writing Better Documentation / Chapter 1

Start · beginner · ~25 min · Chapter 1 of 3

Docs serve a job

“Install X”, “Debug Y”, “Understand Z” — pick one job per page.

Path progress
33%

Step 1 of 1

One page, one job

Tutorials teach. How-tos accomplish. References look up. Explanations deepen. Don’t mash them.

One page, one jobDrag 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 →One page, one jobdrag · tap →Go deeperdrag · tap →Follow the dashed drag · tap →
Docs

Do this now

Label your last doc as tutorial / how-to / reference / explanation.

Was this step clear?
Chapter learning outcomes
  • Audience
  • Job

Clear these before you leave