Open source and documentation go hand in hand. In fact, the wide adoption of open source libraries depend on the availability of good documentation. As users, we demand documentation from open source libraries we use. As contributors, we rely on contributing guides in order to get onboarded and start contributing to the project.
Whereas, in my 15+ years of working in the tech industry, I’ve seen teams and private organizations do poorly at technical documentation. The teams either did not have technical documentation at all, or they did not know how to do it well. If there’s any documentation, it would be unmaintained and out of date.
Open source collaboration is fascinating. As a professional software engineer and volunteer open source contributor, I get to learn the best from both worlds. In the past year, my team has been working towards building a culture of documentation by learning from best practises in the open source community. Learn how we’re doing it in this talk.
You can check out Mariatta's talk slides here: https://bit.ly/mariatta-pyconapac21