Discover how to create technical documentation that developers will love in this 27-minute PyCon US talk by Mason Egger. Learn ten essential tips to elevate your technical writing skills, including making your end goal clear, using inclusive language, limiting jargon, defining acronyms, and avoiding regional expressions. Explore the importance of meaningful code samples, keeping readers engaged, creating scannable content, and thoroughly testing instructions. Gain insights on getting started in technical writing and understand why it's crucial for developers. Access accompanying slides for a comprehensive overview of the strategies discussed.
Write Docs Devs Love - Ten Tips to Level Up Your Tech Writing
Overview
Syllabus
Intro
What is Tech Writing?
Why is Technical Writing Important?
Mason's Top 10 Trips for Improving Your Tec Writing
Make Your End Goal Clear
Tip 88 - Use Inclusive Language
Limit Technical Jargon
Define ALL Acronyms
Tip 85 - Avoid Memes/Idioms and Regional Language
Use Meaningful Code Samples and Variable Names
Tip #3 - Avoid Making Your Reader Leave Your Docs
Make Your Content Scannable
Verify Your Instructions Test, Test
Bonus Tipl - Practice. Practice. Practice
How You Can Get Started in Technical Writing
Taught by
PyCon US
