Docs or it didn't happen! [FOSS North 2019]

Docs or it didn't happen! [FOSS North 2019]

**This version of the talk was presented at FOSS North 2019**

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, 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.

https://foss-north.se/2019/speakers-and-talks.html#mariel

Cc4eb61ea6ff5b734785c6fc6c4be305?s=128

thatdocslady

April 08, 2019
Tweet