Главная
Study mode:
on
1
Intro
2
What is Tech Writing?
3
Why is Technical Writing Important?
4
Mason's Top 10 Trips for Improving
5
Make Your End Goal Clear
6
Don't Be Overly Verbose
7
Use Inclusive Language
8
Limit Technical Jargon
9
Define ALL Acronyms
10
Avold Memes/Idioms and Regional Language
11
Tip #4 - Use Meaningful Code Samples and Variable Names
12
Don't Make Your Reader Leave
13
Make Your Content Scannable
14
Verify Your Instructions! Test, Test
15
Bonus Tip! - Practice, Practice, Practice
16
How You Can Get Started in Technical
Description:
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.

Write Docs Devs Love - Ten Tricks To Level Up Your Tech Writing

EuroPython Conference
Add to list