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

Building Documentation Culture by Learning from...

Mariatta
November 20, 2021

Building Documentation Culture by Learning from Open Source Community

Mariatta

November 20, 2021
Tweet

More Decks by Mariatta

Other Decks in Technology

Transcript

  1. About Me @mariatta PSF Community Service Award 2018 and PSF

    Fellow Member since 2020 Google Open Source Peer Bonus Award 2017 and 2020 🇨🇦 Python Core Developer GitHub Sponsors Maintainer Spotlight GitHub The ReadME Project
  2. @mariatta Why Open Source? Learn and use new tech, new

    libraries, new features Continuously Learning
  3. @mariatta Why Open Source? Learn and use new tech, new

    libraries, new features Continuously Learning Improve communication skills and be more effective
  4. @mariatta Why Open Source? Learn and use new tech, new

    libraries, new features Continuously Learning Improve communication skills and be more effective Appreciate documentation more
  5. @mariatta What is Documentation? What Nobody Tells You about Documentation,

    talk by Daniele Procida https://www.youtube.com/watch?v=t4vKPhjcMZg
  6. @mariatta Documentation in Open Source How to get the source

    code Local environment set up guide How to run the test suite Communication channels Docs for Contributors etc
  7. @mariatta Docs in Private Org Lacking / just the bare

    minimum Outdated “Not my job”
  8. @mariatta Docs in Private Org Lacking / just the bare

    minimum Outdated “Not my job” “We all know this already, no need to document”
  9. @mariatta Docs in Private Org Lacking / just the bare

    minimum Outdated “Not my job” “We all know this already, no need to document” Loss of knowledge when someone leaves
  10. @mariatta Docs in Private Org Lacking / just the bare

    minimum Outdated “Not my job” “We all know this already, no need to document” Loss of knowledge when someone leaves Needing to spend resources for knowledge recovery
  11. @mariatta Building Documentation Culture Demand documentation Include docs in work

    estimation Document questions asked (and answered) in Slack / in person Default to finding the docs before asking Value and reward documentation effort
  12. @mariatta Building Documentation Culture Demand documentation Include docs in work

    estimation Document questions asked (and answered) in Slack / in person Default to finding the docs before asking Value and reward documentation effort
  13. @mariatta Building Documentation Culture Demand documentation Include docs in work

    estimation Document questions asked (and answered) in Slack / in person Default to finding the docs before asking Value and reward documentation effort
  14. @mariatta Documentation Resources What Nobody Tells You about Documentation, talk

    by Daniele Procida https://www.youtube.com/watch?v=t4vKPhjcMZg Diatáxis Framework https://diataxis.fr
  15. @mariatta Documentation Resources Docs for Developers: An Engineer’s Field Guide

    to Technical Writing, by Jared Bhatti, Zachary Sarah Corleissen, et al. | Oct 1 2021
  16. @mariatta Innersourcing The use of open source best practises for

    software development within the confines on an organization. https://innersourcecommons.org/ https://resources.github.com/whitepapers/introduction-to-innersource/