Manuals / Writing Better Documentation / Chapter 3

Steady · beginner · ~20 min · Chapter 3 of 3

Keep docs alive

Owner, last-reviewed date, and a link from the thing it documents.

Path progress
100%

Step 1 of 1

Stale docs are lies

Add “Last reviewed” and an owner. Delete pages nobody owns.

Stale docs are liesDrag 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 →Stale docs are liedrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

Do this now

Add last-reviewed + owner to one doc today.

Pro tip: Link docs from error messages and UI empty states.

Was this step clear?
Chapter learning outcomes
  • Ownership
  • Review

Clear these before you leave