Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Docs or it didn't happen! [PyCon Balkan 2018]

Docs or it didn't happen! [PyCon Balkan 2018]

**This version of the talk was presented at PyCon Balkan 2018**

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.



November 16, 2018

More Decks by thatdocslady

Other Decks in Technology


  1. DOCS OR IT DIDN’T HAPPEN! Mikey Ariel @ThatDocsLady @WriteTheDocs @HappinessPacket

    PyCon Balkan, November 2018
  2. Why are we here? We are *not* here to argue

    whether documentation is important (or to argue about anything, really). Please leave your flamewars at the door, documentation is communication so let’s remember how to do that. This talk will run the full 30 minutes, with no on-stage questions. Personal interaction is recommended (talk to me afterwards!), or you can email, Slack, or tweet @ThatDocsLady with your questions any time. ◉ 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
  3. Who is That Docs Lady? @ThatDocsLady docs@docsideofthemoon.com @WriteTheDocs


  5. Content Strategy Plan a little, save a lot

  6. Content Strategy Plan a little, save a lot DevOps for

    Docs Not just for developers anymore
  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

  9. “ “A documentarian is someone who cares about documentation and

    communication in the software industry, regardless of job title.” http://www.writethedocs.org/documentarians/
  10. Community Writers DevOps Testers Designers Marketing Developers Support DOCUMENTARIANS

  11. CONTENT STRATEGY Asking the right questions in advance can save

    a lot of time later 1
  12. NEED-TO-KNOW DOCS (and no, you don’t need to know everything)

  13. Need-to-Know Documentation

  14. Need-to-Know Documentation Why

  15. Need-to-Know Documentation Why Who

  16. Need-to-Know Documentation Why What Who

  17. Need-to-Know Documentation Why When What Who

  18. Need-to-Know Documentation Why Where When What Who

  19. EXAMPLES (because screenshots are awesome)

  20. GNOME Help help.gnome.org help.gnome.org

  21. GNOME Help help.gnome.org

  22. GNOME Help help.gnome.org

  23. GNOME Help help.gnome.org

  24. Arch Linux Wiki wiki.archlinux.org

  25. Arch Linux Wiki wiki.archlinux.org

  26. Minishift README github.com/minishift/minishift

  27. Minishift Troubleshooting github.com/minishift/minishift/issues/1152

  28. Minishift Troubleshooting github.com/minishift/minishift-centos-iso/pull/119

  29. Minishift Troubleshooting docs.openshift.org/latest/minishift/troubleshooting/troubleshooting-misc

  30. DEVOPS FOR DOCS Let’s geek out about processes, tools, and

    workflows, oh my! 2
  31. INTEGRATION If you can’t beat them, join them!

  32. Docs-as-Code github.com/minishift/minishift

  33. Modular Source Content github.com/minishift/minishift

  34. Issue Tracking github.com/minishift/minishift

  35. Issue Tracking github.com/minishift/minishift

  36. CONTINUOUS PUBLICATION No need to stop the press anymore!

  37. Publication Tools

  38. Continuous Deployment readthedocs.org/projects/writethedocs-www/builds

  39. Live-Preview Staging github.com/writethedocs/www/pulls/<YOUR-PR-HERE>

  40. TESTING AUTOMATION More than a just a spell-checker!

  41. Linguistic Validation www.hemingwayapp.com

  42. Test Automation Framework github.com/emender/emender

  43. COMMUNITY SPIRIT Let’s help our contributors help us and help

    each other 3
  44. “ Docs or it didn’t happen! - Me, at the

    beginning of this presentation
  45. Django Project Linux Kernel OpenStack Documentation as a Deliverable

  46. Contribution Process nixos.wiki/wiki/Contributing_to_Nix_documentation

  47. Templates www.writethedocs.org/guide/writing/beginners-guide-to-docs

  48. The Documentarian community is growing!

  49. Documentation Conferences

  50. Doc-to-Dev Outreach Find me for a chat! (I have stickers)

  51. @ThatDocsLady docs@docsideofthemoon.com @WriteTheDocs WELCOME TO THE CLUB!