Live data from Hacker News

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

news.ycombinator.com

11–20 of 79 posts

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

#15
The TeXbook, and the Exim spec.

The thing the latter gets right is that, as well as the usual long list of options with an explanation of what their effects are, it also describes in full detail what the program actually does, rather than leaving you to deduce it from the options.

So each option is normally described twice: once in an alphabetical list, and once where the operation it affects is described.

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

#16

Redux is good given how small the library is. Rust stands out as well

I'm underwhelmed by the Rust docs.

The tutorial is OK-ish, but the reference docs are weak. If I have a specific question about some detail of the language, the answer is very rarely there.

Sometimes the answer is written up in the bug-tracking system or an RFC. They don't seem to have a culture where someone making a behaviour change, or a language-definition decision, is expected to update the reference manual at the same time.

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

#18
QT wasn't so bad as far as I remember.

But as jolmg pointed out, some projects are just simple readme and that is more than enough. Love those. But the total opposite is also common, a wall of text that is meaningless and in the end, you have to go through the source code to get some answers...

Post reply on HN