Manuals / Technical Writing / Ch 3

A · CraftBeginner35 min read

3. Clarity edits

Technical Writing · 32 pages source format

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

What you'll learn

  • Active voice
  • Jargon budget
  • Examples

Edit pass

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.

Clear?

Checklist