Writing Clear and Interesting Technical Content and Documentation

A presentation at PyCaribbean 2017 in in 100 Ave Ramon L Rodriguez, Bayamón, 00959, Puerto Rico by Tracy Osborn

You’re smart, educated, and you’ve been working in this industry for years. You’ve created amazing open-source packages and great documentation. But all that flies out the window if what you write about your project isn’t being read.

“But it’s comprehensive! It has all the info that I would need!” you may reply.

The problem is not writing for people like you; it’s writing and creating documentation that anyone can read, understand, and get excited about. This is true for projects aimed at beginners, but it goes double for projects and writing aimed at intermediate/expert programmers. Your projects will benefit when you write something that everyone can understand and would want to read. More readers = more users = perhaps more contributors!