How to Improve Open Source Software’s Documentation
June 27th, 2012 7 comments
In my experience, documentation is one of the weakest points of open source software. It’s often incomplete, unstructured and/or outdated. There are never enough examples. When examples are present, they often do not follow best practices for the sake of brevity. Another big issue is to distinguish between software versions, as it is seldom clear to what version(s) the current document applies. Digging through the source code should not be seen as a positive user experience.
I have prepared a list of suggestions that open source project leaders can implement to help their users get the most out of their software.
Read more…
Recent comments