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: Can you recommend a tool for writing public API documentation?

1 pointsby pedrodelfinoover 1 year ago

2 comments

syndicatedjellyover 1 year ago
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
emedchillover 1 year ago
I&#x27;ve used Swagger before.