3 ms·
I have noticed the increasing paucity of documentation in many open source projects. In the past, this would annoy me when I had to context switch from a perfec
by gyepi 13y ago
I have noticed the increasing paucity of documentation in many open source projects. In the past, this would annoy me when I had to context switch from a perfectly good flow state to a documentation reading state. However, I realized that I was doing it wrong; it meant that I was not spending enough time analyzing the code I was about to "adopt" and depend on for my project. Now, I read the documentation and source code for every open source program before I choose to use it. I also find correlations between the quality of the code and the documentation; good quality code sometimes lacks documentation but poor quality code rarely has good documentation.
Reading the code also provides the opportunity for learning beyond the documentation; there's a wealth of really good code out there just waiting to be read.
- bttf 13y agoI can agree with this. There have been times when I thought I understood the concept of something after reading the documentation, only to find myself gaining a deeper understanding when reading the code.