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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: Can you recommend a tool for writing public API documentation?

1 点作者 pedrodelfino超过 1 年前

2 条评论

syndicatedjelly超过 1 年前
Here are some assorted considerations, in no particular order.<p>- Understand the use case. Who&#x27;s the audience? What kinds of developers are those - do they like dense documentation, or just want a bunch of code examples so they can move on to more interesting problems that use the API?<p>- Look for something that can interface with code comments, such as Doxygen for C++. That will encourage engineers to keep documentation up-to-date in line with their existing work.<p>- Use non-proprietary formats where possible. Markdown + pandoc can be a nice option. Notion looks pretty upfront, but it get&#x27;s frustrating when the keybindings are slightly non-intuitive and doesn&#x27;t support how devs want to work. But this kind of depends on how involved the tooling for the existing documentation is. Maybe other stuff is already in one tool, so it makes sense to re-use the existing tool so clients don&#x27;t have to navigate between tools
emedchill超过 1 年前
I&#x27;ve used Swagger before.