Tweet
Tweet

Slide 1

Slide 1 text

Building Documentation Cultur e by Learning from Open Source Community 1 Mariatta Wijaya

Slide 2

Slide 2 text

Mariatta Wijaya @mariatta she/her Vancouver, Canada UTC - 7 Staff Software Engineer @ Uplight

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

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

Slide 6

Slide 6 text

@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

Slide 7

Slide 7 text

@mariatta What is Documentation? What Nobody Tells You about Documentation, talk by Daniele Procida https://www.youtube.com/watch?v=t4vKPhjcMZg

Slide 8

Slide 8 text

@mariatta Documentation in Open Source Tutorials API Reference Change log Docs for Users PEPs / RFCs

Slide 9

Slide 9 text

@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

Slide 10

Slide 10 text

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

Slide 11

Slide 11 text

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

Slide 12

Slide 12 text

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

Slide 13

Slide 13 text

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

Slide 14

Slide 14 text

@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

Slide 15

Slide 15 text

@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

Slide 16

Slide 16 text

@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

Slide 17

Slide 17 text

@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

Slide 18

Slide 18 text

@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

Slide 19

Slide 19 text

@mariatta Building Documentation Culture Documentatio n i s Communication

Slide 20

Slide 20 text

@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

Slide 21

Slide 21 text

@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

Slide 22

Slide 22 text

@mariatta Documentation Resources Write The Docs community, https://www.writethedocs.org/about/learning-resources/

Slide 23

Slide 23 text

@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/

Slide 24

Slide 24 text

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

Slide 25

Slide 25 text

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