News for hackers. Stuff that matters.
Re:Free software is suffering because coders don’t know how ... by 5ilv3r on Friday June 02, 2017 @02:26PM (#14472229)
I see a lot of documentation describing how it works, not what it does. I think most README.md files would be better as code comments. Personally, the most useful documentation contains a brief summery of purpose, usage, and then a few examples. Dependencies should be called out if they are significant.

There are no comments on this comment yet.