Discover ten essential tricks to elevate your technical writing skills in this 27-minute conference talk from EuroPython 2022. Learn why effective documentation is crucial for developers and explore strategies to create clear, inclusive, and user-friendly content. Gain insights on setting clear goals, using concise language, avoiding jargon, and crafting meaningful code samples. Master the art of keeping readers engaged, making information easily scannable, and rigorously testing your instructions. Explore opportunities to start your technical writing journey and leave with practical tips to produce documentation that developers will love and appreciate.
Overview
Syllabus
Intro
What is Tech Writing?
Why is Technical Writing Important?
Mason's Top 10 Trips for Improving
Make Your End Goal Clear
Don't Be Overly Verbose
Use Inclusive Language
Limit Technical Jargon
Define ALL Acronyms
Avold Memes/Idioms and Regional Language
Tip #4 - Use Meaningful Code Samples and Variable Names
Don't Make Your Reader Leave
Make Your Content Scannable
Verify Your Instructions! Test, Test
Bonus Tip! - Practice, Practice, Practice
How You Can Get Started in Technical
Taught by
EuroPython Conference
