Approaching Open Source Documentation the Right Way - Uduak Obong-eren

Опубликовано: 28 Сентябрь 2024
на канале: All Things Open
64
2

Presented at All Things Open 2022
Presented by Uduak Obong-eren

Title: Approaching Open Source Documentation the Right Way
Abstract: The importance of effectively documenting an Open Source project can not be overemphasized. When done well, it serves as a source of truth for users, guidance for potential contributors and a sign of that Open Source project's healthiness.

However, very few Open Source projects own documentation and most of the ones that have documentation do not write or maintain them well thereby leading to Open Source documentation being unreadable and difficult to contribute to.

Don't get me wrong, there’s been a significant improvement in the Open Source documentation space, but there’s always room for improvement.

In this talk, I will share the approach I took to update the Mojaloop Open Source documentation, its effectiveness and impact on the Mojaloop project, why other Open Source maintainers should adopt this approach and so much more!

Find more info about All Things Open:
On the web: https://www.allthingsopen.org/
Twitter:   / allthingsopen  
2022 conference: https://2022.allthingsopen.org/