Ask HN: What's the best documentation you've ever read? • Hacker News Board

Re: Ask HN: What's the best documentation you've ever read?

#21

Post by superasn » Wed, Jun 27, 2018, 7:18 AM UTC

deadcoder0904 wrote: post #8

Vue JS docs are the best. I don't think anything beats it :)

100% agree. They are the most comprehensive docs I've ever seen. So many examples, nice clean design and they cover edge cases too.

It's the only doc that generally comes before SO in finding solutions for me.

Re: Ask HN: What's the best documentation you've ever read?

#22

Post by programmarchy » Wed, Jun 27, 2018, 7:23 AM UTC

The node-postgres docs are very nice. https://node-postgres.com/

Gives you examples right off the bat to get started, is organized well so it's easy to dive deeper, and the author includes some conventions for incorporating the module into your app.

Re: Ask HN: What's the best documentation you've ever read?

#23

Post by cellover » Wed, Jun 27, 2018, 7:25 AM UTC

PostgreSQL's documentation to me is a reference.

Complex concepts are told in a very simple and concise fashion. There is just the right amount of text for what is told, it does not make you feel dumb and instead invites you to dig deeper in a very welcoming manner.

Re: Ask HN: What's the best documentation you've ever read?

#24

Post by manugarri » Wed, Jun 27, 2018, 7:26 AM UTC

It has to be the scikit-learn documentation (http://scikit-learn.org/). Not only its great in terms of proper code documentations with a ton of examples, but it also explains the theory behind each algorithm. You can literally learn Machine Learning just by reading the docs

Re: Ask HN: What's the best documentation you've ever read?

#25

Post by altschuler » Wed, Jun 27, 2018, 7:29 AM UTC

I learned a lot from the SQLite documentation. It's not only very thorough, but it's full of insightful bits of information that is not strictly necessary but which gives a deeper understanding of the engine.

It was also the first time I encountered the flow diagram type of syntax explanation which I found to be a fantastic way to grasp the details of each command. Eg https://sqlite.org/lang_createtable.html.

https://sqlite.org/docs.html

Re: Ask HN: What's the best documentation you've ever read?

#26

Post by rajangdavis » Wed, Jun 27, 2018, 7:31 AM UTC

IMHO Twilio's documentation is pretty nice

Re: Ask HN: What's the best documentation you've ever read?

#27

Post by akskos » Wed, Jun 27, 2018, 7:32 AM UTC

Go

Re: Ask HN: What's the best documentation you've ever read?

#28

Post by Theodores » Wed, Jun 27, 2018, 7:34 AM UTC

Stack Overflow.

Re: Ask HN: What's the best documentation you've ever read?

#29

Post by hakanito » Wed, Jun 27, 2018, 7:34 AM UTC

throwmeaway1532 wrote: post #7

The best docs on the planet are now held by Mozilla on Javascript.

Agreed. I’m referring to it as the Truth

Re: Ask HN: What's the best documentation you've ever read?

#30

Post by amarant » Wed, Jun 27, 2018, 7:36 AM UTC

I really like the elasticsearch docs. They seem to cover everything, it's easy to find what you're looking for, and they contain a lot of detail! the feature where you can switch ES version without leaving the page you're on is a nice touch too :)