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

Building Documentation Culture by Learning from Open Source Community

6b6e72d297aa0270654a0d4575f1287e?s=47 Mariatta
PRO
November 20, 2021

Building Documentation Culture by Learning from Open Source Community

6b6e72d297aa0270654a0d4575f1287e?s=128

Mariatta
PRO

November 20, 2021
Tweet

More Decks by Mariatta

Other Decks in Technology

Transcript

  1. Building Documentation Cultur e by Learning from Open Source Community

    1 Mariatta Wijaya
  2. Mariatta Wijaya @mariatta she/her Vancouver, Canada UTC - 7 Staff

    Software Engineer @ Uplight
  3. 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
  4. @mariatta Why Open Source? Learn and use new tech, new

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

    libraries, new features Continuously Learning Improve communication skills and be more effective
  6. @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
  7. @mariatta What is Documentation? What Nobody Tells You about Documentation,

    talk by Daniele Procida https://www.youtube.com/watch?v=t4vKPhjcMZg
  8. @mariatta Documentation in Open Source Tutorials API Reference Change log

    Docs for Users PEPs / RFCs
  9. @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
  10. @mariatta Docs in Private Org Lacking / just the bare

    minimum
  11. @mariatta Docs in Private Org Lacking / just the bare

    minimum Outdated
  12. @mariatta Docs in Private Org Lacking / just the bare

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

    minimum Outdated “Not my job” “We all know this already, no need to document”
  14. @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
  15. @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
  16. @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
  17. @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
  18. @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
  19. @mariatta Building Documentation Culture Documentatio n i s Communication

  20. @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
  21. @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
  22. @mariatta Documentation Resources Write The Docs community, https://www.writethedocs.org/about/learning-resources/

  23. @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/
  24. THANK YOU Sponsor on GitHub 24 https://github.com/sponsors/Mariatta @mariatta https://github.com/sponsors/python

  25. THANK YOU Sponsor on GitHub 24 https://github.com/sponsors/Mariatta @mariatta https://github.com/sponsors/python