The primary key to success for any open source library is having a great documentation. If you ever found yourself implementing and releasing your own

Why Open Source libraries are missing documentation

submited by
Style Pass
2022-05-12 16:30:08

The primary key to success for any open source library is having a great documentation. If you ever found yourself implementing and releasing your own open source library (like I do ✍️) you may know how the process works.

You, the developer, work countless hours on your own "project". You create everything. You know by heart every single line of code. One day you decide that to make the world a better place, you must release your project to the public, the "Open Source" dream.

Nonetheless, your project is not ready for "production". So you put more and more hours to make the code decent, addressing things like performance, abstractions, security.

After this brutal process, you literally know your code like as if it was your child. You designed it, you created it, you grew it. And finally the day comes in which your "child" is a grown man and you release it for the world to use.

We all know too well all those amazing libraries that are not usable. If only they had some documentation that tells you what they do...

Leave a Comment