Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Just curious - as a contrary example, I would like to see links to a few OSS projects with exemplar documentation done "right". As an example, the Django project does a great job of treating its documentation as a "first-class citizen". While I have used OSS software and not developed, I would guess there are some good best practices / checklists out there for documentation (e.g. "what a good README should contain"; recommended tools to ensure documentation is easily contributable, versioned, and so on; "how to deploy this software", "how to install", architecture overview, "meta" documentation on how to contribute to the project, and so on). Would be good to see examples of those too. Thanks!



My understanding is that Docker has great documentation.

However, as a corporate sponsored project with multiple full time employees working on the documentation, it most likely fails your criteria in spirit.


Beets has great documentation:

http://beets.readthedocs.org/




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: