TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

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

70 点作者 selmat将近 7 年前

42 条评论

manugarri将近 7 年前
It has to be the scikit-learn documentation (<a href="http:&#x2F;&#x2F;scikit-learn.org&#x2F;" rel="nofollow">http:&#x2F;&#x2F;scikit-learn.org&#x2F;</a>). 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
devxpy将近 7 年前
Any discussion on documentation is incomplete without mentioning Django<p><a href="https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;2.0&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;2.0&#x2F;</a>
评论 #17406411 未加载
mabynogy将近 7 年前
MDN because it&#x27;s exhaustive <a href="https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;" rel="nofollow">https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;</a><p>Jekyll because it&#x27;s beautiful and the user can read all the pages at once with the previous&#x2F;next buttons (at the bottom) <a href="https:&#x2F;&#x2F;jekyllrb.com&#x2F;docs&#x2F;home&#x2F;" rel="nofollow">https:&#x2F;&#x2F;jekyllrb.com&#x2F;docs&#x2F;home&#x2F;</a><p>Node.js because they propose a single page version and it makes search easier <a href="https:&#x2F;&#x2F;nodejs.org&#x2F;dist&#x2F;latest-v10.x&#x2F;docs&#x2F;api&#x2F;all.html" rel="nofollow">https:&#x2F;&#x2F;nodejs.org&#x2F;dist&#x2F;latest-v10.x&#x2F;docs&#x2F;api&#x2F;all.html</a>
评论 #17406865 未加载
altschuler将近 7 年前
I learned a lot from the SQLite documentation. It&#x27;s not only very thorough, but it&#x27;s full of insightful bits of information that is not strictly necessary but which gives a deeper understanding of the engine.<p>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 <a href="https:&#x2F;&#x2F;sqlite.org&#x2F;lang_createtable.html" rel="nofollow">https:&#x2F;&#x2F;sqlite.org&#x2F;lang_createtable.html</a>.<p><a href="https:&#x2F;&#x2F;sqlite.org&#x2F;docs.html" rel="nofollow">https:&#x2F;&#x2F;sqlite.org&#x2F;docs.html</a>
croo将近 7 年前
ZeroMQ stands out for me. <a href="http:&#x2F;&#x2F;zguide.zeromq.org&#x2F;page:all" rel="nofollow">http:&#x2F;&#x2F;zguide.zeromq.org&#x2F;page:all</a>
评论 #17406261 未加载
throwmeaway1532将近 7 年前
The best docs on the planet are now held by Mozilla on Javascript.
评论 #17406394 未加载
评论 #17406176 未加载
deadcoder0904将近 7 年前
Vue JS docs are the best. I don&#x27;t think anything beats it :)
评论 #17406515 未加载
评论 #17406332 未加载
评论 #17406872 未加载
cellover将近 7 年前
PostgreSQL&#x27;s documentation to me is a reference.<p>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.
评论 #17413440 未加载
federicodalmaso将近 7 年前
CockroachDB: <a href="https:&#x2F;&#x2F;www.cockroachlabs.com&#x2F;docs&#x2F;stable&#x2F;architecture&#x2F;overview.html" rel="nofollow">https:&#x2F;&#x2F;www.cockroachlabs.com&#x2F;docs&#x2F;stable&#x2F;architecture&#x2F;overv...</a>
minikomi将近 7 年前
Re-frame for clojurescript. Worth reading even if you&#x27;re not using cljs but are involved in front-end development.<p><a href="https:&#x2F;&#x2F;github.com&#x2F;Day8&#x2F;re-frame&#x2F;blob&#x2F;master&#x2F;docs&#x2F;README.md" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;Day8&#x2F;re-frame&#x2F;blob&#x2F;master&#x2F;docs&#x2F;README.md</a>
评论 #17406479 未加载
mjw1007将近 7 年前
The TeXbook, and the Exim spec.<p>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.<p>So each option is normally described twice: once in an alphabetical list, and once where the operation it affects is described.
评论 #17412765 未加载
jolmg将近 7 年前
vim, emacs, postgres, zsh, bash, urxvt, systemd, pacman<p>EDIT: It all depends on how you set the bar, though. There are plenty of projects whose entire documentation is a README with a few examples.<p>Also, what&#x27;s &quot;best&quot;, documentation that greatly explains a horrible, unintuitive interface of a program or one that hardly needs to exist because the use of the program is so intuitive, you don&#x27;t need documentation? Greater effort was spent in the former, but you understand the program better in the latter.
snicky将近 7 年前
I love <a href="https:&#x2F;&#x2F;redis.io&#x2F;documentation" rel="nofollow">https:&#x2F;&#x2F;redis.io&#x2F;documentation</a>. It has a great UI too.
评论 #17406519 未加载
incadenza将近 7 年前
Redux is good given how small the library is. Rust stands out as well
评论 #17406113 未加载
评论 #17406259 未加载
stevesimmons将近 7 年前
Django, the Python-based web framework, has fantastic docs too: <a href="https:&#x2F;&#x2F;docs.djangoproject.com" rel="nofollow">https:&#x2F;&#x2F;docs.djangoproject.com</a>
评论 #17406481 未加载
rmrfrmrf将近 7 年前
<i>The C Programming Language</i>
programmarchy将近 7 年前
The node-postgres docs are very nice. <a href="https:&#x2F;&#x2F;node-postgres.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;node-postgres.com&#x2F;</a><p>Gives you examples right off the bat to get started, is organized well so it&#x27;s easy to dive deeper, and the author includes some conventions for incorporating the module into your app.
leni536将近 7 年前
I think cppreference.com is very well made. It has both the C++ and C standards in a very accessible form.
HappyFapMachine将近 7 年前
QT wasn&#x27;t so bad as far as I remember.<p>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...
评论 #17406487 未加载
wizawu将近 7 年前
Erlang - <a href="https:&#x2F;&#x2F;www.erlang.org&#x2F;docs" rel="nofollow">https:&#x2F;&#x2F;www.erlang.org&#x2F;docs</a><p>The best three entries are * Learn - <a href="http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;reference_manual&#x2F;users_guide.html" rel="nofollow">http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;reference_manual&#x2F;users_guide.html</a> * Use - <a href="http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;search&#x2F;" rel="nofollow">http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;search&#x2F;</a> * Go deep - <a href="http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;efficiency_guide&#x2F;users_guide.html" rel="nofollow">http:&#x2F;&#x2F;erlang.org&#x2F;doc&#x2F;efficiency_guide&#x2F;users_guide.html</a>
neddeadstark将近 7 年前
I would go with python-requests <a href="http:&#x2F;&#x2F;docs.python-requests.org&#x2F;en&#x2F;master&#x2F;" rel="nofollow">http:&#x2F;&#x2F;docs.python-requests.org&#x2F;en&#x2F;master&#x2F;</a>
actionowl将近 7 年前
<a href="https:&#x2F;&#x2F;docs.saltstack.com&#x2F;en&#x2F;latest&#x2F;topics&#x2F;development&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;docs.saltstack.com&#x2F;en&#x2F;latest&#x2F;topics&#x2F;development&#x2F;inde...</a><p>I found some bugs and I wanted to fix them. I&#x27;ve done a little python in the past but I&#x27;m not entirely up to speed on the whole python ecosystem. This documentation was exceptional and allowed me to get my bugs fixed, some unit tests written and PR&#x27;s merged.
sbergjohansen将近 7 年前
I&#x27;ve always admired Agilent&#x27;s Programmer&#x27;s Reference for the ESA series electronic spectrum analyzers <a href="http:&#x2F;&#x2F;literature.cdn.keysight.com&#x2F;litweb&#x2F;pdf&#x2F;E4401-90507.pdf" rel="nofollow">http:&#x2F;&#x2F;literature.cdn.keysight.com&#x2F;litweb&#x2F;pdf&#x2F;E4401-90507.pd...</a>
haolez将近 7 年前
Racket<p><a href="https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;</a>
评论 #17412721 未加载
amarant将近 7 年前
I really like the elasticsearch docs. They seem to cover everything, it&#x27;s easy to find what you&#x27;re looking for, and they contain a lot of detail! the feature where you can switch ES version without leaving the page you&#x27;re on is a nice touch too :)
beizhia将近 7 年前
It&#x27;s gotta be emacs for me. C-h o, and helm-apropos make it super easy to investigate anything in the system. And the help pages link back to the source code (though this isn&#x27;t unique to emacs) The online docs aren&#x27;t bad either.
yantrams将近 7 年前
MDN, Scikit-learn, Requests, RethinkDB, Django are a few that come to my mind.
random42_将近 7 年前
Probably the Gentoo Linux documentation. Not sure how it looks like today, but back in 2005 when I started using Gentoo it helped me a lot because not only was comprehensive but also deep enough albeit clear.
saluki将近 7 年前
Best docs:<p>Stripe.com<p>Laravel.com
评论 #17410089 未加载
tephra将近 7 年前
I really like the Org mode manual (<a href="https:&#x2F;&#x2F;orgmode.org&#x2F;manual&#x2F;" rel="nofollow">https:&#x2F;&#x2F;orgmode.org&#x2F;manual&#x2F;</a>)
rkachowski将近 7 年前
nobody know shoes by _why<p>I would say it&#x27;s pretty terrible at providing a reference for a new GUI system in ruby, but it&#x27;s also the most fun I&#x27;ve had reading docs
klausjensen将近 7 年前
Stripe has the best API documentation, I have seen.
评论 #17406463 未加载
kaycebasques将近 7 年前
Tech writer here. I&#x27;d be hugely thankful if you included <i>why</i> a given set is the best in your experience!
评论 #17413278 未加载
nortiero将近 7 年前
The Commodore 64 User Manual. No contest.
jackgolding将近 7 年前
I like plot.ly&#x27;s documentation - has a good mix of top level examples and specific, deep documentation.
tcpekin将近 7 年前
I use Matlab over Python for scientific computing mainly because the documentation makes everything easier.
billconan将近 7 年前
Qt&#x27;s <a href="http:&#x2F;&#x2F;doc.qt.io&#x2F;" rel="nofollow">http:&#x2F;&#x2F;doc.qt.io&#x2F;</a>
rajangdavis将近 7 年前
IMHO Twilio&#x27;s documentation is pretty nice
bobosha将近 7 年前
stripe - hast the best api docs imho
akskos将近 7 年前
Go
评论 #17406420 未加载
Walkman将近 7 年前
PostgreSQL&#x27;s is very concise, clear, to the point, but still very detailed. Has examples! <a href="https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;10&#x2F;static&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;10&#x2F;static&#x2F;index.html</a>
Theodores将近 7 年前
Stack Overflow.