TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: What is your favorite documentation website?

10 pointsby davewasmerover 12 years ago
What are some examples of the best documentation you have used, especially on the web? Based on both the content of the documentation, as well as the UI/UX to actually read it.<p>I'm interested to see what other developers think makes for good documentation.

4 comments

okaramianover 12 years ago
I'm not a big fan of having a bunch of handholding examples in a blog or something similar. I remember Spotify's setup being pretty decent as far as application related documentation.<p><a href="https://github.com/spotify/apps-tutorial" rel="nofollow">https://github.com/spotify/apps-tutorial</a><p>If it's something OSS I'm good with a github with the code up, maybe a couple of examples that are well commented and easy to get up and running within the framework, and a reasonable README to guide me through the process.<p>I'm already experienced with writing software, so if I have something to play with and read through in a text editor I can learn what's going on faster than reading about how to set hello world up for a new framework.
评论 #4646740 未加载
davewasmerover 12 years ago
Personally, I find Stripe's documentation to be excellent. It's clear, concise, and a good balance between narrative guides and comprehensive reference material:<p><a href="https://stripe.com/docs" rel="nofollow">https://stripe.com/docs</a>
hayksaakianover 12 years ago
i like rubyonrails.org, a thorough reference of rails basics. I end up using it frequently to correct my syntax for things like rendering partials, etc.
deveshzover 12 years ago
I really like the way Coffeescript is documented. <a href="http://coffeescript.org/" rel="nofollow">http://coffeescript.org/</a>