DEV Community

Discussion on: What are some examples of great documentation?

Collapse
 
nick profile image
Nick Rameau

Well, it's cool that people are sharing popular documentations. It's mostly a result of a lot of contributions from a lot of people or a dedicated team.

What about documentations of a small team about a small to medium sized project? Nobody? I gotta say I'm disappointed.

Well, I'm shamelessly going to share one of mines because I believe you don't come up with documentations almost as perfect as the ones shared here, you build upon them.

My project documentations are definitely not the best out here, we already have enough great recommendations here to satisfy this post so I thought it would be okay to be different at this point.

I believe you have to start somewhere and I recommend, for a small to medium project, to take example of the documentation of my project called Libft as an example:

github.com/r4meau/libft

It's hosted on Github as README file and extended in a Wiki. I'm open to any critic :)