2025 · lightning
And It Was Written ~ An Introspective in the Importance of ReadMes
Situation: You build this awesome project, providing the answers to the universe.... but no one can use it as you have no documentation. Problem: In the world of open-source tooling, a lot of tools are built without any documentation on how to use them. Why Talk About This: As the software ecosystem becomes more dependent on open-sourced development, it becomes a greater need to have better and clearly documented software. This talk aims to share tips to enhance documentation, and templates to make the process easier and why this is one of the important habits to develop as a developer/ software craftsman. Why listen to me: As a former science educator turned full-stack developer, I have gained some insights into the importance of proper documentation and its effectiveness as a communication tool./skill.