Engage or Die: Four Techniques for Writing Indispensible Docs
summary
Four concrete tactics: identify reader needs and trade developer interest for task focus, choose tone deliberately (converted a frightened nontechnical audience with an informal voice), organize by problems so readers see what’s in it for me up front, and use pointer sentences to keep context. Examples: a 60‑page manual rewritten from “editorial workflow” to a problem‑focused heading, a 100‑step workaround compressed into chunks of 6–10 steps, a Gliffy diagram and six test accounts used to verify procedures.
AI-written summary · about
chapters (11)
- 0:00Start
- 1:25Engaging Your Readers
- 4:16.Death by Apathy
- 7:09Figuring Out Who Your Readers Are
- 7:42.Death by Alienation
- 8:24Tone of Voice in Your Notification
- 8:54Tone of Voice
- 11:32The Company Culture
- 13:49Leave the Problem
- 18:00Death by Disorientation
- 25:39Pointer Sentences
related talks
31m7 Essential Tips for the Enlightened Tech Writer
38mSeven habits of increasingly technical technical writers
45mTelling Your Technical Story
31mBack to the Future: What Can Documentarians Learn From The Past?
37mFailing Well: A Practical Guide to Growth for Technical Writers
32mI Read It But Don’t Get It, or How to Tackle Technical Texts
36mOvercoming the Plight of Lone Writers
40mHow to Write. A Craftsman's Guide