Contribute Media
A thank you to everyone who makes this possible: Read More

Docs or it didn't happen

Translations: en


Apologies for the occasional mumbling in the audio over the presenter, a mic was left live next to the mixer for part of Thursday

If you ever skimmed through a README, tried to follow a quickstart tutorial, attempted to decipher an error message, or typed '--help' in your console, congratulations -- you have encountered documentation!

Long gone are the days of massive books with never-ending stories about your software. Today's users are smarter and less patient, which means that we no longer need to document all the things, as long as what we do document is clear, concise, helpful, and accessible. And that's where the real work starts.

Documentation requires some attitude adjustment, since prose doesn't neatly compile into binaries as code does. But Don't Panic(tm)! No matter what your role is in the community, you can apply a few key principles from the technical writing world to make your project more docs-friendly, and therefore more user- and contributor-friendly.

This high-level (and all-level) talk aims to introduce or re-acquaint you with topics such as content strategy, modular content architecture, tone and style, optimized DevOps for docs, and contribution workflows. Open-source projects of all shapes and sizes are welcome!


Improve this page