Where have all the good docs gone, and where are all the repos?

đź‘Ą Working Groups Documentation
1

Hi folks! I was looking for examples of good Open Source docs, but I was having a hard time finding lists of good docs. Does anyone know of an aggregate list of good open source docs, or do you know a specific project that does an awesome job at writing docs?

I get a lot of questions in my work from folks asking for good examples of Open Source documentation. I have a handful of examples I know of. But before I went off on a big journey to find the best of the best Open Source docs, I thought I would ask here first in case someone already did that. :slightly_smiling_face: Note, I am looking for an awesome-list style of real-world projects with docs. I am not looking for different docs tool-chains or frameworks.

Also… not sure if the thread title pun was lost or not. :grinning:

2

Long time lurker, first-time poster. Short answer: No, there isn’t one.

I am yet to see an explicit list of examples of only open-source documentation through my work in docs. There are several blogs I share when folks ask me if they are looking for collections that include both OSS and proprietory examples. Most organizations tend to keep documentation open-source for folks to contribute and improve as they wish. So, the tide is turning slowly. I maintain an extensive list of categorized examples depending on use-cases which I use as an inspiration for client work and such. Have to check how many of them are open-source. Good open-source documentation is hard to find but it shouldn’t have to be and we get your pun :wink:

Never thought of converting it to an awesome styled list but never a bad time to get started I guess. So here you go, Porting my list to GitHub .. 64% :hourglass_flowing_sand:
Let me know if you want to jump in.

1 Like
3

Here you go, https://github.com/vipulgupta2048/awesome-documentation will add more from my Notion list tomorrow. Only had time to this up and running. Looking forward to all your contributions, folks. This is in no way complete, so feel free to edit anything you like through a pull request or pass it up to fellow documentarians. Maybe we can have more diverse examples in one of the headings I have thought off.

2 Likes
4

Depending of what kind of docs you are looking for (one dimension could be “user”, admin, developer, …) there is a list of aswesome READMEs: https://project-awesome.org/matiassingers/awesome-readme / https://github.com/matiassingers/awesome-readme .

1 Like
5

Thanks for sharing @vipulgupta2048 and @felix.wolfsteller! I confess my motivation in asking was because I have an Open Source knowledgebase I maintain. I was looking to add more examples of projects with good documentation. I added your GitHub repos to my aggregator:

You can find the full page published here:

6

somewhat related:

(~> where is the documentation stored and how is it distributed? Here from the viewpoint of a developer)

1 Like