Technical Writing for Developers and Engineers
summary
Argues that technical writing is any writing readers find complex and gives a practical workflow: do pre-writing and outlines, write a draft in a separate doc, then revise for missing context, assumptions and flow, and finally copy into the target place. Calls out common failures—no glossary, overloaded acronyms, missing parameter types in API docs, and forgetting assume junior engineers or future readers. Recommends glossary and defined acronyms, links to tickets and code, and iterative revision.
AI-written summary · about
chapters (13)
- 0:00Intro
- 0:14Basics of Communication
- 3:25Examples of Technical Writing
- 5:15Qualities of Good Technical Writing
- 7:27Communicate to Readers
- 10:49The Information They Need
- 13:13What They Need to Do Next • Why Is each reader reading your writing • What is each reader doing when they read your writing
- 15:10Anti-Patterns
- 18:54Before You Write
- 19:46Writing a Draft
- 20:57Revising Your Document
- 22:27Finishing Touches
- 23:59Recap
related talks
32mApplying Engineering Principles to Technical Writing
36mTechnical writing in English
12mWhy Work with a Tech Writer?
27mWrite Docs Devs Love: Ten Tips To Level Up Your Tech Writing
33mHow to Write Useful Technical Texts
21m7 Values of Effective Tech Writing Teams
13mTechnical documentation – how can I write them better and why should I care?
39mTackling Technical Writing