Live data from Hacker News

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

news.ycombinator.com

41–50 of 51 posts

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

#41

I find the Qt documentation to be excellent. If only Microsoft rose to the same level of helpfulness.

I agree, Qt is excellent. I would actually say Qt and MSDN are the best (maybe MDN too) but I have to qualify MSDN with "back when Visual Studio 6 was new". Shortly afterwards they reorganised it so everything was impossible to find and mixed in all the crap docs with the good ones.

Rust docs are decent too but not quite as good as Qt.

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

#42
post #26
post #5

The Android SDK is well documented with examples throughout and hyperlinked to examples and posts which explain some content in greater depth.

Really? Most of it seems to be machine generated from the code definitions - very little explanation, very little usage info. I find it terrible.

Yeah that's been my experience too. Tons of "flobinate(bool yes): If yes is set to true, enables flobination. Otherwise it disables it. Returns void.". Completely unhelpful.

I think this is particularly a problem with Java docs because Java IDEs auto-insert useless documentation and people think "oh great it's documented".

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

#43
Django, because there are no missing parts. Everything is documented and comes with examples, that work and most importantly it anticipates additional steps and often guides you in the right direction (if you want to dive deeper) or clearly states what's out of Django's scope.

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

#44
post #11
post #7

For C and C++: cppreference.com. Why? - Very good overview pages. - Everything is cross-referenced. - Almost everything comes with an example of how to use it. - It's a wiki, so you can edit it yourself if you find anything lacking.

Maybe it’s just me being stupid, but cppreference, while absolutely of great quality, some c++ pages can be as cryptic as it gets. I know, the language is very much not trivial due to all these features, but for example the page about the different kind of l/rvalues is very very complex.

Is there a simpler way to explain them, though, or is that level of complexity required for the explanation to be both 100% correct and complete?

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

#46
post #11

Earlier quoted context omitted.

Maybe it’s just me being stupid, but cppreference, while absolutely of great quality, some c++ pages can be as cryptic as it gets. I know, the language is very much not trivial due to all these features, but for example the page about the different kind of l/rvalues is very very complex.

Is there a simpler way to explain them, though, or is that level of complexity required for the explanation to be both 100% correct and complete?

Good question and I’m afraid I’m not knowledgeable enough about the topic to know it.

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

#47
Any SDK docs that links to, or preferably displays inline, the source code. I use the ruby docs often and they do this, displaying the ruby or C code for the method documented. Really useful, as I wouldn't be motivated to hunt for the source, but if it's right there then I'll read it.

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

#48
I like https://text-generator.io because the main SDK is either using the playground then clicking the "get code" button, or there is a one line change for people migrating in from OpenAI text generation.

Lots of good docs have you visually doing the setup/work, then you realise you can download/see a bunch of code for all the actions you did (e.g. everything UI doable is programmable and the tools taught you all the concepts), it minimises the actual programming, it is really hard/time consuming to mentaly translate API docs to code.

Post reply on HN