Manuals / Technical Writing / Chapter 4

A · Craft · intermediate · ~35 min · Chapter 4 of 8

Procedures & runbooks

Each step: action + expected result. Call out danger. Include rollback.

Path progress
50%

Step 1 of 1

Write a procedure

Write a procedureDrag 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 →Write a proceduredrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

Do this now

5–12 steps someone else can follow cold. Include verify + rollback.

Was this step clear?
Chapter learning outcomes
  • Step design
  • Verification
  • Rollback

Clear these before you leave