Mason's Top 10 Trips for Improving Your Tec Writing
5
Make Your End Goal Clear
6
Tip 88 - Use Inclusive Language
7
Limit Technical Jargon
8
Define ALL Acronyms
9
Tip 85 - Avoid Memes/Idioms and Regional Language
10
Use Meaningful Code Samples and Variable Names
11
Tip #3 - Avoid Making Your Reader Leave Your Docs
12
Make Your Content Scannable
13
Verify Your Instructions Test, Test
14
Bonus Tipl - Practice. Practice. Practice
15
How You Can Get Started in Technical Writing
Description:
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