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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: What's the best documentation site you've come across?

31 点作者 sawirricardo8 个月前
I think back then devs seems to praise Stripe's docs site. Is it still relevant right now?

24 条评论

alok-g8 个月前
Documentation for Wolfram Language:<p><a href="https:&#x2F;&#x2F;reference.wolfram.com&#x2F;language&#x2F;" rel="nofollow">https:&#x2F;&#x2F;reference.wolfram.com&#x2F;language&#x2F;</a><p>It&#x27;s detailed, complete, shows many examples for commom use cases, &#x27;neat&#x27; examples showing what&#x27;s possible, and lists down possible issues. I do see certain documentation quality issues sometimes.<p>The documentation itself is done using the features of Wolfram Language, so the examples can be run inline (depending on the platform).
DavidPiper8 个月前
I haven&#x27;t done serious frontend web dev for a while, but MDN was consistently excellent a few years back.<p><a href="https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;docs&#x2F;Web&#x2F;JavaScript" rel="nofollow">https:&#x2F;&#x2F;developer.mozilla.org&#x2F;en-US&#x2F;docs&#x2F;Web&#x2F;JavaScript</a>
评论 #41541743 未加载
captn3m08 个月前
PHP docs are an underrated gem. They get several things right:<p>1. Individual pages for each function.<p>2. Clear examples for common usecases.<p>3. Explicit documentation for input and return types.<p>4. The quick search is amazing - it prioritizes library reference over other pages.<p>5. Clean and useful references to related methods.<p>The user submitted notes were a big positive a decade ago - they highlighted common gotchas, workarounds, and surprising alternatives, but have gotten dated over time (kinda like SO answers). But the voting mechanism attempts to keep them in check.<p>Compare <a href="https:&#x2F;&#x2F;www.php.net&#x2F;manual&#x2F;en&#x2F;function.str-contains.php" rel="nofollow">https:&#x2F;&#x2F;www.php.net&#x2F;manual&#x2F;en&#x2F;function.str-contains.php</a> to the tiny one paragram you get at <a href="https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;library&#x2F;stdtypes.html#str.find" rel="nofollow">https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;library&#x2F;stdtypes.html#str.find</a> (which then redirects most users to a far more confusing explanation about the in operator <a href="https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;reference&#x2F;expressions.html#membership-test-operations" rel="nofollow">https:&#x2F;&#x2F;docs.python.org&#x2F;3&#x2F;reference&#x2F;expressions.html#members...</a>
评论 #41540645 未加载
评论 #41539744 未加载
BrandoElFollito8 个月前
Arch (a Linux distribution) has excellent documentation that can be reused in other distros. Not the &quot;how to install part&quot; but rather the &quot;how to configure&quot; one.<p>I usually prefer to read their docs rather than the ones in man pages which are &quot;flat&quot; (all the initiation had the same importance)
评论 #41539507 未加载
mcc1ane8 个月前
Postgres’s - <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>
评论 #41539436 未加载
jonathonlacher8 个月前
I appreciate the HAProxy docs. They&#x27;re stored as text files in the main code repository, though there are HTML representations.<p>There are three main files:<p><i>Starter Guide</i>: <a href="https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;intro.html" rel="nofollow">https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;intro.html</a><p><i>Configuration Manual</i>: <a href="https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;configuration.html" rel="nofollow">https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;configuration.html</a><p><i>Management Guide</i>: <a href="https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;management.html" rel="nofollow">https:&#x2F;&#x2F;docs.haproxy.org&#x2F;3.0&#x2F;management.html</a><p>Having all the similar docs together in the same file (all config options, for example) is refreshingly simple.
zvr8 个月前
Every time &quot;documentation&quot; is mentioned, it would help to specify which quadrant this is about: <a href="https:&#x2F;&#x2F;docs.divio.com&#x2F;documentation-system&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.divio.com&#x2F;documentation-system&#x2F;</a><p>I see answers here that are oriented towards completely different parts.
spapas828 个月前
For me it&#x27;s the Django docs.
coreyh144448 个月前
Stripe is still the gold standard for me. But I&#x27;m interested to see what this thread digs up.
评论 #41539524 未加载
selcuka8 个月前
The online documentation for Lotus (later IBM, later HCL) Notes&#x2F;Domino is excellent. It&#x27;s not purely a &quot;site&quot; because the documentation is a Notes database itself, but it is also available on the public Internet [1], so I think it counts.<p>For open source projects, Django [2] is pretty close to the gold standard.<p>[1] <a href="https:&#x2F;&#x2F;help.hcl-software.com&#x2F;dom_designer&#x2F;14.0.0&#x2F;index.html" rel="nofollow">https:&#x2F;&#x2F;help.hcl-software.com&#x2F;dom_designer&#x2F;14.0.0&#x2F;index.html</a><p>[2] <a href="https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;dev&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docs.djangoproject.com&#x2F;en&#x2F;dev&#x2F;</a>
hprotagonist8 个月前
Emacs. Normally i read it locally but the web version is just as comprehensive.
评论 #41541119 未加载
Crono8 个月前
PHP Docs are pretty good as already mentioned.<p>I personally 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><p><a href="https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;cookbook" rel="nofollow">https:&#x2F;&#x2F;getkirby.com&#x2F;docs&#x2F;cookbook</a>
blablabla1238 个月前
For a product: Delphi 2. I don&#x27;t think I ever saw a better offline documentation which is so self-contained<p>For a project: MDN, they refactored the Web&#x27;s JS documentation
brothrock8 个月前
All of raspberry pi’s SDK documentation and data sheets for the pico (rp2040) are amazing. Perfect material to build an embedded engineering course around.
constantinum8 个月前
Vim - <a href="https:&#x2F;&#x2F;vimdoc.sourceforge.net&#x2F;htmldoc&#x2F;usr_toc.html" rel="nofollow">https:&#x2F;&#x2F;vimdoc.sourceforge.net&#x2F;htmldoc&#x2F;usr_toc.html</a><p>Stripe<p>Django<p>Hubspot<p>Mercurial with comments <a href="https:&#x2F;&#x2F;hgbook.red-bean.com&#x2F;read&#x2F;a-tour-of-mercurial-the-basics.html" rel="nofollow">https:&#x2F;&#x2F;hgbook.red-bean.com&#x2F;read&#x2F;a-tour-of-mercurial-the-bas...</a>
kamma44348 个月前
Generally speaking, Elixir. Documentation is written in the language itself, it is easy to create, and is very well written. As the authors themselves are the first users of the documentation facilities, they are very well done and maintained.<p>This in turn means that the structure and style is shared by many libs in the ecosystem, and everything is natively cross-referenced.
评论 #41539190 未加载
joshka8 个月前
As a general rule (for established libraries at least), the docs for rust crates stored on <a href="https:&#x2F;&#x2F;docs.rs" rel="nofollow">https:&#x2F;&#x2F;docs.rs</a> are pretty good. This comes from having docs being built-in to the tooling, so it&#x27;s really easy to deliver docs in a consistent format.
phsource8 个月前
This is a bit of an unusual choice, but I recently was trying to use Webflow, and its videos are both highly informative and funny! Engineers often thumb their noses at videos, but they really show how to do it well:<p><a href="https:&#x2F;&#x2F;university.webflow.com&#x2F;videos" rel="nofollow">https:&#x2F;&#x2F;university.webflow.com&#x2F;videos</a>
davidy1238 个月前
I&#x27;ve seen a few sites train LLMs &#x2F; use RAG on their online docs. When I used it, it was very useful in terms of search and synthesis. imo it&#x27;d be nice if projects release a current model trained on their documentation and code.
rhizome318 个月前
I was quite pleasantly surprised by the quality of AWS docs, especially coming from Azure. A part from that, as mentioned already: Django.
评论 #41540093 未加载
gtirloni8 个月前
Lots of great sites with docs for software. I&#x27;m curious if people have suggestions for infrastructure-related docs as well.
评论 #41541866 未加载
rodrpb8 个月前
I&#x27;d add Terraform documentation to the list
评论 #41540654 未加载
michele_f8 个月前
Spacy documentation webpages are top notch!
marvin-hansen8 个月前
BuildBuddy<p><a href="https:&#x2F;&#x2F;www.buildbuddy.io&#x2F;docs&#x2F;introduction&#x2F;">https:&#x2F;&#x2F;www.buildbuddy.io&#x2F;docs&#x2F;introduction&#x2F;</a><p>I don&#x27;t think I ever had a case that wasn&#x27;t covered in the docs.