Thoughts On: Two open source projects with great documentation
I read this article on Open Source Documentation by John Jago:
Two open source projects with great documentation
My Takeaways:
- Having a "Why" or simple explanation of the project is beneficial.
- Having good setup documentation is beneficial
- Having a overall vision for the architecture and goals of the project is beneficial.
Most projects I've worked with have very, very inadequate documentation. It is always a frustrating experience to have to spend "guess and check" with an API to see what it is doing. No one wants to read a 500 line function to figure out what it's inputs should be. Another reason I like strongly typed languages or, at the very least, type hints.