Write Docs Devs Love: Ten Tips To Level Up Your Tech Writing
summary
Ten concrete moves: a numbered set of 10 actionable tips (plus a bonus), aim for a low reading level (he says third grade), and test in a fresh environment with someone else to catch gaps. Use include complete copyable code — imports, a final full block, realistic variable names — and make docs scannable with headings and a table of contents. Define acronyms on first use, avoid memes/idioms, keep prerequisites linked up front, and practice via blogs or Hacktoberfest.
AI-written summary · about
chapters (15)
- 0:00Intro
- 1:32What is Tech Writing?
- 2:29Why is Technical Writing Important?
- 4:25Mason's Top 10 Trips for Improving Your Tec Writing
- 5:14Make Your End Goal Clear
- 7:57Tip 88 - Use Inclusive Language
- 9:56Limit Technical Jargon
- 11:19Define ALL Acronyms
- 13:02Tip 85 - Avoid Memes/Idioms and Regional Language
- 14:40Use Meaningful Code Samples and Variable Names
- 16:54Tip #3 - Avoid Making Your Reader Leave Your Docs
- 19:01Make Your Content Scannable
- 21:41Verify Your Instructions Test, Test
- 23:29Bonus Tipl - Practice. Practice. Practice
- 24:15How You Can Get Started in Technical Writing
related talks
13mTechnical documentation – how can I write them better and why should I care?
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
33mHow to Write Useful Technical Texts
28mImproving Your Documentation: A talk for developers who want to write stuff good
01h 14mTechnically speaking: Improve Your Code With Documentation
39mTackling Technical Writing
43m"How To Write Tech Documentation That Will Save Your Career"
01h 24mWriting Documentation - Practices and Theory