It's a common refrain you hear when it comes to documentation for open source projects. It typically sucks! In part, because nobody wants to work on docs. But also in part because good documentation is challenging to write. What is good documentation in the first place? The following is a list of some qualities that make for great documentation. This list is by no means complete. Good docs are. Written for the right audience Comprehensive and accurate Easily browsable and searchable Written in a clear and concise language Laid out in a readable format Versioned with the source code While it's challenging to write and maintain great documentation, my co-worker Matthew was up to the challenge of building a simple Markdown based system to help...(read more) ...
Go to the complete details ...