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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: What Makes API Documentation Great?

3 点作者 brandonlipman超过 9 年前
What specifically makes documentation great? Example: something about the design, format, where it's located, structure, video tutorials/no tutorials. Examples would be really helpful. Also, if you are a developer, do you tend to spend time reading documention before going forth and testing it out or not? Thanks!

2 条评论

mtmail超过 9 年前
This list contains lots of good examples <a href="https:&#x2F;&#x2F;github.com&#x2F;PharkMillups&#x2F;beautiful-docs" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;PharkMillups&#x2F;beautiful-docs</a><p>For our service (<a href="http:&#x2F;&#x2F;geocoder.opencagedata.com&#x2F;" rel="nofollow">http:&#x2F;&#x2F;geocoder.opencagedata.com&#x2F;</a>) we can&#x27;t use many API-docs-autogeneration tools because their typical usecase is dozens to 100s of methods (think: Stripe). We only have one endpoint and a couple of aliases.
评论 #11134358 未加载
strongai超过 9 年前
Like you said, examples would be [are] really useful!