Docs or it didn't happen! [Prague PostgreSQL Meetup, November 2018]

Docs or it didn't happen! [Prague PostgreSQL Meetup, November 2018]

**This version of the talk was presented at the PostgreSQL Prague Meetup**

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.

Cc4eb61ea6ff5b734785c6fc6c4be305?s=128

thatdocslady

November 26, 2018
Tweet

Transcript

  1. 2.

    Why are we here? ◉ We want to have more

    users and contributors ◉ We believe (or want to believe) that docs can help ◉ <something> is stopping us from working on docs
  2. 6.

    Content Strategy Plan a little, save a lot DevOps for

    Docs Not just for developers anymore
  3. 7.

    Content Strategy Plan a little, save a lot Community Spirit

    We’re all in this together DevOps for Docs Not just for developers anymore
  4. 9.

    “ “A documentarian is someone who cares about documentation and

    communication in the software industry, regardless of job title.” http://www.writethedocs.org/documentarians/
  5. 44.

    “ Docs or it didn’t happen! - Me, at the

    beginning of this presentation