Pathwise

Manuals / Technical Writing / Chapter 3

A · Craft · beginner · ~35 min · Chapter 3 of 8

Clarity edits

Short sentences. Active voice. Defined jargon. Concrete examples. Cut throat-clearing.

Path progress
38%

Step 1 of 1

Edit pass

Edit passDrag 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 →Edit passdrag · tap →Try thisdrag · tap →Follow the dashed drag · tap →

Example

Weak: The system should be configured appropriately prior to execution.
Strong: Before you run the job, set `ENV=staging` in `.env`.

Do this now

Rewrite one page with: ≤20-word average sentence target, examples for each abstract claim.

Was this step clear?
Chapter learning outcomes
  • Active voice
  • Jargon budget
  • Examples

Clear these before you leave