Write Docs Devs Love: Ten Tricks to Level Up Your Tech Writing

You're read good tutorials, you've read bad tutorials. In this talk I'll discuss 10 tips and tricks to level up your technical writing.

Introduction

Think of that feeling you get when you follow an online tutorial or documentation and the code works on the first run. Now think of all the hours spent wasted following broken, outdated, or incomplete documentation. From our favorite tutorials to bad product docs we all consume technical writing. Tutorials, blog posts, and product docs help developers learn new things, build projects, and debug issues. But what makes one tutorial better than another? In this talk I’ll discuss how you can write the documentation that developers love and I’ll share 10 tips and tricks to improve your technical writing.

This talk was given at:

  • PyGotham 2021

Presentation Slides


Like this content? Follow me (@masonegger) on Twitter or join me on Twitch for live coding and discussions on my channel CodingWithMason.