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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: How to write good developer documentation

1 点作者 mr_o47超过 2 年前
Hello, I’m trying to improve the documentation of our current product and we are moving away from confluence to git and markdown solution for our developers.<p>What tools should i use and initially i was planning to use MDbook

3 条评论

zenosmosis超过 2 年前
I find that Docusaurus docs usually are the easiest to follow when consuming them but I have no experience with creating them: <a href="https:&#x2F;&#x2F;docusaurus.io&#x2F;" rel="nofollow">https:&#x2F;&#x2F;docusaurus.io&#x2F;</a>
__warlord__超过 2 年前
When I need inspiration I always look at Kagi&#x27;s documentation... <a href="https:&#x2F;&#x2F;help.kagi.com&#x2F;kagi&#x2F;welcome.html" rel="nofollow">https:&#x2F;&#x2F;help.kagi.com&#x2F;kagi&#x2F;welcome.html</a>
suprjami超过 2 年前
I love Markdown but it&#x27;s probably not enough for this.<p>It&#x27;s hard to give specifics without more info, but you want every API reference to link back to its definition.<p>Say a function is called like `function(arg1, arg2)` then I should be able to click on the arguments to go to their definitions.<p>You probably want to use Sphinx or Doxygen or something else which can programmatically produce doc from the source code.