Ask HN: What's the best documentation you've ever read (or written)?
I've been thinking a lot about documentation and how to get a user up to speed on a code base as quickly and effortlessly (on the part of the user) as possible.
I know "best" can be somewhat arbitrary or subjective, but use whichever metric you think is most relevant (organization, clarity, etc...). And, if you'd like, let me know what you think "best" should mean in relation to documentation quality.
Also, I know this question has been asked before, but those threads are all several years old, so in that time the documentation pool has obviously changed (and hopefully improved).
5 comments
[ 3.5 ms ] story [ 22.7 ms ] threadIt's a comprehensive, yet not too dense, set of documentation for getting people up to speed on how to do things with FreeBSD. You may not find a better one even today.
It's a recently written tech interview for a startup named Baatna. Good read!
https://git-scm.com/doc
I also like Stripe documentation
https://stripe.com/docs
http://zguide.zeromq.org/
It is useful not just for using ZeroMQ, but about learning about distributed systems in general.
Online version here [1] is not evaluatable and is rendered to images, but otherwise it's the same content as the desktop version. Specific example [2].
[1] http://reference.wolfram.com/language/ [2] http://reference.wolfram.com/language/ref/Histogram.html