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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: What is example of good documentation in your opinion?

41 点作者 fm200超过 2 年前
I know its kinda generic question, but what technical documentation you would point to as well written, concise, with good examples etc.. Something that really stands out.

51 条评论

adrian_b超过 2 年前
The more you go into the past, the better technical documentation you will find.<p>The documentation from the nineties of the 20th century was much better than the later documentation, and that from the seventies and the eighties was probably the peak, e.g. the various manuals of the Hewlett-Packard instruments, and also various manuals from DEC, IBM, Tektronix, National Semiconductor, Motorola, Intel, AMD, Texas Instruments, Fairchild and many others. Also many European companies had excellent technical documentation, e.g. Philips, Thomson, Siemens, SGS-ATES and many others. Many ancient manuals have been preserved at bitsavers.org and at a few other similar sites.<p>I believe that the FreeBSD manual from 1995 was better than any later operating system manual from the point of view of the completeness of its coverage of the existing features. The Gentoo manual before 2005 was also excellent. Both FreeBSD and Gentoo have good documentation even today, but nevertheless their manuals have not been kept completely up-to-date, so now they contain various holes about features that are not covered, unlike in the original complete manuals.<p>Before the Internet, for those who were not living in USA it could be very difficult to obtain many of the manuals and datasheets published by US companies, except perhaps at their booths at some international trade fairs.<p>After the Internet appeared, I was very happy that suddenly it became trivial to obtain any technical documentation, even if in the beginning that was done by FTP on dial-up modems at speeds as low as 2400 b&#x2F;s.<p>Unfortunately, the time when it became easy to obtain technical documentation has coincided perfectly with the time when there was a tremendous decline in the quality of the technical documentation. Now it is easy to obtain technical documentation, but its content is much less valuable.<p>In many cases, e.g. for embedded processors and various complex interface integrated circuits, until you perform some tests on development boards you cannot be completely sure about how certain things work, instead of being able to predict any behavior based on the documentation. Moreover, if a company provides some example programs, they frequently contain valuable information that is missing from the manuals or datasheets.
评论 #33685440 未加载
leetrout超过 2 年前
Django is one of the gold standards for me.<p>Great examples. Clearly noting what versions things changed. Ability to switch versions at the click of a button.<p><a href="https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;4.1&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;4.1&#x2F;</a>
评论 #33688382 未加载
评论 #33684595 未加载
datadata超过 2 年前
The ArchWiki for Arch Linux: <a href="https:&#x2F;&#x2F;wiki.archlinux.org&#x2F;" rel="nofollow">https:&#x2F;&#x2F;wiki.archlinux.org&#x2F;</a>
评论 #33683198 未加载
zach_garwood超过 2 年前
While Python is &quot;the second best language for any task&quot;, I think the Python standard library documentation is second-to-none: <a href="https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;library&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;library&#x2F;index.html</a>
评论 #33683322 未加载
评论 #33682857 未加载
评论 #33683180 未加载
durandal1超过 2 年前
Postgres docs have always been top notch <a href="https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;current&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;www.postgresql.org&#x2F;docs&#x2F;current&#x2F;index.html</a>
评论 #33683242 未加载
svnpenn超过 2 年前
PHP:<p><a href="https:&#x2F;&#x2F;php.net&#x2F;manual&#x2F;function.str-contains" rel="nofollow">https:&#x2F;&#x2F;php.net&#x2F;manual&#x2F;function.str-contains</a>
评论 #33683006 未加载
评论 #33682952 未加载
alkonaut超过 2 年前
Microsofts referencesource. Meaning published source for closed source libraries. No amount of documentation beats being able to see for yourself not just what the software will do not only the documented&#x2F;supported scenarios but also in undocumented ones.
评论 #33683369 未加载
the_arun超过 2 年前
I find Mozilla documentation is very good - eg: <a href="https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;docs&#x2F;Web&#x2F;HTTP" rel="nofollow">https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;docs&#x2F;Web&#x2F;HTTP</a>
2OEH8eoCRo0超过 2 年前
Perl man pages. Was working with Perl on a job and had no internet or outside connection. The man pages are outstanding.<p><a href="https:&#x2F;&#x2F;perldoc.perl.org&#x2F;perlintro" rel="nofollow">https:&#x2F;&#x2F;perldoc.perl.org&#x2F;perlintro</a>
nablags超过 2 年前
IMO the numpy docs are great: <a href="https:&#x2F;&#x2F;numpy.org&#x2F;doc&#x2F;stable" rel="nofollow">https:&#x2F;&#x2F;numpy.org&#x2F;doc&#x2F;stable</a><p>There’s always good explanation and examples within their docs
drpossum超过 2 年前
Rust was already mentioned, but I want to call out the compiler error messages specifically. That&#x27;s putting documentation where you need it exactly when you need it most and it&#x27;s a triumph.
marcolussetti超过 2 年前
I love the documentation for Ansible. You have a good amount of well thought out examples, very well written explanations for things, and links to other related functions.<p><a href="https:&#x2F;&#x2F;docs.ansible.com&#x2F;ansible&#x2F;latest&#x2F;collections&#x2F;ansible&#x2F;builtin&#x2F;user_module.html" rel="nofollow">https:&#x2F;&#x2F;docs.ansible.com&#x2F;ansible&#x2F;latest&#x2F;collections&#x2F;ansible&#x2F;...</a>
pamoroso超过 2 年前
Not concise, but the manual of the COHERENT Unix clone, developed by Mark Williams Company between the 1980s and the early 1990s, is what made me grok Unix: <a href="http:&#x2F;&#x2F;www.nesssoftware.com&#x2F;home&#x2F;mwc&#x2F;manual.php" rel="nofollow">http:&#x2F;&#x2F;www.nesssoftware.com&#x2F;home&#x2F;mwc&#x2F;manual.php</a>
constantcrying超过 2 年前
The manual for my dishwasher. What I learned from it was that technical writing is a <i>skill</i> and that it does not come from technical knowledge alone.<p>The best documentation knows its audience and what they want to know. I quite like cppreference and usually ISA documentation is quite good. But this is because I am part of their target audience.<p>The worst documentation is the one which has entirely lost sight of its audience. Particularly offenses are it being a mix of tutorial and reference, which is filled with explanatory prosa potentially even serving as a first introduction to the given topic.<p>Cppreference is about the worst way to learn C or C++ and if it weren&#x27;t it would be far less useful to me. Documentation writers have to know their audience first and foremost. There is a place for walkthroughs and tutorials, but they can not replace an actual language reference.
评论 #33684102 未加载
srvmshr超过 2 年前
FreeBSD &amp; OpenBSD documentation are pretty good in the OS space.<p>[1] <a href="https:&#x2F;&#x2F;docs.freebsd.org&#x2F;en&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.freebsd.org&#x2F;en&#x2F;</a><p>[2] <a href="https:&#x2F;&#x2F;www.openbsdhandbook.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;www.openbsdhandbook.com&#x2F;</a>
milianw超过 2 年前
The Qt framework has excellent documentation which made it very easy for me to learn it back then!
btschaegg超过 2 年前
Two long-form examples for programs I don&#x27;t see here yet. Note that they won&#x27;t necessarily be great for other projects (e.g. for a library, where you as the user will probably need&#x2F;expect &quot;on-point documentation&quot; for specific details while working with the product in question), but as a wholistic introduction to a specific tool, I&#x27;ve yet to see much better examples.<p>- <a href="https:&#x2F;&#x2F;dtrace.org&#x2F;guide&#x2F;preface.html" rel="nofollow">https:&#x2F;&#x2F;dtrace.org&#x2F;guide&#x2F;preface.html</a><p>- <a href="https:&#x2F;&#x2F;archive.org&#x2F;details&#x2F;pdfy-MgN0H1joIoDVoIC7" rel="nofollow">https:&#x2F;&#x2F;archive.org&#x2F;details&#x2F;pdfy-MgN0H1joIoDVoIC7</a>
httgp超过 2 年前
Anything from Stripe is brilliant.
gusrondina超过 2 年前
Spack&#x27;s official documentation is fantastic:<p><a href="https:&#x2F;&#x2F;spack.readthedocs.io&#x2F;en&#x2F;latest&#x2F;" rel="nofollow">https:&#x2F;&#x2F;spack.readthedocs.io&#x2F;en&#x2F;latest&#x2F;</a>
XCSme超过 2 年前
The Stripe docs [0] are usually mentioned.<p>I would say that mine[1] created via GitBook is not terrible either, I usually tend to provide more generic instructions and multiple ways of doing one thing, so that it doesn&#x27;t get out of date too quick.<p>[0]: <a href="https:&#x2F;&#x2F;stripe.com&#x2F;docs" rel="nofollow">https:&#x2F;&#x2F;stripe.com&#x2F;docs</a> [1]: <a href="https:&#x2F;&#x2F;docs.uxwizz.com&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.uxwizz.com&#x2F;</a>
mmusc超过 2 年前
Vuejs documentation. They have an API reference and a guide. Can go to 0 to using the framework in no time, and contains all you could possibly need once you dive deeper.
yamrzou超过 2 年前
Tailscale&#x27;s documentation: <a href="https:&#x2F;&#x2F;tailscale.com&#x2F;kb&#x2F;" rel="nofollow">https:&#x2F;&#x2F;tailscale.com&#x2F;kb&#x2F;</a>
monkpit超过 2 年前
A counter example: any official Java docs are pretty sparse and unhelpful. Jenkins docs too.<p>The other commenter mentions docs from the past being better, but I have always found Java’s docs to be particularly atrocious.<p>No examples, and barely any information beyond a type signature.<p>When I open up a project’s docs and they have that same Java html formatting, I get that faraway stare…
danoise19超过 2 年前
I always liked Cisco documentation, besides the documentation for each product in great detail, as it was in the 80&#x27;s, everything in PDF, you also have links to manuals of a bunch of technology that the product support, just not the product. Well structure and organized. I miss that in many products and software nowadays.
Glench超过 2 年前
In my humble opinion, this library I made has great documentation: <a href="http:&#x2F;&#x2F;glench.github.io&#x2F;fuzzyset.js&#x2F;ui&#x2F;" rel="nofollow">http:&#x2F;&#x2F;glench.github.io&#x2F;fuzzyset.js&#x2F;ui&#x2F;</a><p>Most importantly it has interactive examples that let you understand through doing and playing, rather than just reading.
Crono超过 2 年前
I absolutely love the documentation for Kirby CMS:<p><a href="https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;guide" rel="nofollow">https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;guide</a><p><a href="https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;reference" rel="nofollow">https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;reference</a>
fedeb95超过 2 年前
Strange that no one mentioned man pages. I think they&#x27;re a great doc and almost always contain what I need
snicky超过 2 年前
<a href="https:&#x2F;&#x2F;redis.io&#x2F;docs" rel="nofollow">https:&#x2F;&#x2F;redis.io&#x2F;docs</a>
amboo7超过 2 年前
Common Lisp HyperSpec: <a href="http:&#x2F;&#x2F;www.lispworks.com&#x2F;documentation&#x2F;HyperSpec&#x2F;Front&#x2F;index.htm" rel="nofollow">http:&#x2F;&#x2F;www.lispworks.com&#x2F;documentation&#x2F;HyperSpec&#x2F;Front&#x2F;index...</a>
Am4TIfIsER0ppos超过 2 年前
Lua&#x27;s manual. One flat page with everything. Language, standard library, C API, and even the complete syntax. The only thing it needs is the table of contents prepended. Possibly lacking examples which is something you asked for.
dtjohnnymonkey超过 2 年前
I like the Divio framework for thinking about how to structure docs <a href="https:&#x2F;&#x2F;documentation.divio.com&#x2F;introduction&#x2F;" rel="nofollow">https:&#x2F;&#x2F;documentation.divio.com&#x2F;introduction&#x2F;</a>
privong超过 2 年前
The documentation for Racket[0] is great. Detailed, comprehensive, readable, and a local copy comes with the installation.<p>[0] <a href="https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.racket-lang.org&#x2F;</a>
4ft4超过 2 年前
FastAPI: <a href="https:&#x2F;&#x2F;fastapi.tiangolo.com" rel="nofollow">https:&#x2F;&#x2F;fastapi.tiangolo.com</a><p>Clear and easy to follow language with awesome examples. I really like that additional concepts are explained as well.
jfornear超过 2 年前
I started <a href="https:&#x2F;&#x2F;learndjangoreact.com&#x2F;tutorial" rel="nofollow">https:&#x2F;&#x2F;learndjangoreact.com&#x2F;tutorial</a> to be concise and easy to navigate with good examples.
Scoundreller超过 2 年前
Definitely not the vendor we use at work. If I click the &quot;Help&quot; button, it&#x27;s basically a line like this for every field:<p>&quot;Choose the $Ambiguous policy from the $Ambiguous policy dropdown&quot;.<p>Geez, thanks.
timbit42超过 2 年前
The best I&#x27;ve seen were the Tandem manuals. This was 30 years ago.
karp773超过 2 年前
I like this guide <a href="https:&#x2F;&#x2F;developers.google.com&#x2F;style" rel="nofollow">https:&#x2F;&#x2F;developers.google.com&#x2F;style</a>
orsenthil超过 2 年前
Many open source project documentations are good. Kubernetes, Python are two I constantly refer to. I haven&#x27;t been terribly disappointed.
tebeka超过 2 年前
Pandas - <a href="https:&#x2F;&#x2F;pandas.pydata.org&#x2F;docs&#x2F;" rel="nofollow">https:&#x2F;&#x2F;pandas.pydata.org&#x2F;docs&#x2F;</a>
thfuran超过 2 年前
Matlab and Mathematica both have great documentation from what I recall, though I haven&#x27;t used either in several years.
mharig超过 2 年前
sqlite3 has rather good articles on many topics on its homesite.<p>And to manage&#x2F;search documentation I like docsets and Zeal a lot.
insane_dreamer超过 2 年前
Mentioned by others but the Stripe docs are not only quite good but also very nicely designed esp their API pages
DoingIsLearning超过 2 年前
OpenCV.<p>The tutorials get you off the ground and the Docs are detailed enough to take you safely over the long grass.
revskill超过 2 年前
1. Good code examples.<p>2. Tutorials for beginners<p>3. Advanced guides.
moltar超过 2 年前
Stripe for UX<p>AWS for breadth and organization
farski超过 2 年前
I find the Slack API and app platforms docs to very pleasant to use.
insane_dreamer超过 2 年前
Numpy, scipy are quite good and complete
oxff超过 2 年前
AWS, Rust std.
rustybolt超过 2 年前
The built-in documentation of QBASIC.
Ninjinka超过 2 年前
BabylonJS. Also very active forums.
ketanmaheshwari超过 2 年前
since no one has mentioned it yet I would say that Vim documentation is top notch.