展示 HN：Docucod – 任何代码库的自动文档生成工具
嗨，HN，我是来自Clidey的Hemang，我们正在开发Docucod。Docucod是一个能够自动生成和维护任何代码库文档的工具。
* 问题是什么？ *
我和我的联合创始人都曾在像摩根大通、摩根士丹利这样的跨国公司以及像Palantir这样的小公司工作，持续看到未维护文档带来的问题。
大多数代码库的文档不足，注释稀疏，类型并不总是明显，随着时间的推移，很多知识往往被遗忘。
深入了解后，理解事物的运作变得越来越困难。这会减慢新员工的入职速度，浪费调试时的时间，并增加出错的可能性。
直到今天，我们一直在与中小型公司和初创企业进行试点，调整产品并获得大量反馈。
今天，我们希望向公众开放，发布生成服务！
* 试试看！ *
请访问 <a href="https://docucod.com/oss" rel="nofollow">https://docucod.com/oss</a>，并在此处输入您的代码库URL。生成后，链接将可见。
您还可以在代码库URL前加上前缀URL：<a href="https://docucod.com/docs/<repo-url>" rel="nofollow">https://docucod.com/docs/<repo-url></a>（例如：<a href="https://docucod.com/docs/https://github.com/clidey/whodb" rel="nofollow">https://docucod.com/docs/https://github.com/clidey/whodb</a>）
请注意，这仅适用于大小不超过100MB的公共代码库。
<i>工作原理：</i>
Docucod分析代码库，解析文件、注释、类型、示例和自述文件，然后构建一个您可以立即浏览的静态文档网站——无需配置，无需设置。
它会自动提取有用的上下文，这样您就不必逐行阅读代码来弄清楚发生了什么。
它支持使用Mermaid生成图表，我们还在努力生成图像，未来还会支持视频！
发布是通过我们自己的静态网站生成器<i>Dory</i>完成的（[<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>](<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>)）。
它处理解析、结构提取和HTML生成。Dory的构建考虑了处理AI生成的MDX，这是一个有趣的挑战。
我们仍在完善它，因此欢迎提出PR和反馈。
<i>接下来是什么：</i>
目前我们支持公共GitHub代码库（私有支持即将推出）。我们还在开发一些功能，比如在文档中进行代码搜索、根据用户查询定制响应、更好的导航、主题定制以及与CI管道的集成。
如果您试用一下，我非常希望能得到您的反馈——无论是好的还是坏的。它是否解决了您的实际问题？有什么让您困惑的地方、缺失的内容，或者根本没有帮助的地方？
谢谢！
查看原文
Hi HN, I'm Hemang from Clidey, and we are working on Docucod. Docucod is a tool that automatically generates and maintains documentation from any repository.<p>* What is the problem? *
My co-founder and I have both worked in large corporates like J.P. Morgan, Morgan Stanley, smaller companies like Palantir, and continuously see the issues that stem from unmaintained documentation.<p>Most codebases are under-documented, comments are sparsed, types aren't always obvious, and there's often a lot of knowledge that is forgotten as time goes on.<p>The deeper you go, the harder it gets to understand how things work. This slows down onboarding, wastes time during debugging, and increases the chance of things breaking.<p>Until today, we have been running pilots with small to medium sized companies and startups tweaking the product and gaining lots of feedback.<p>Today we want to open it up to the public with a release of the generation service!<p>* Try it out! *
Go to <a href="https://docucod.com/oss" rel="nofollow">https://docucod.com/oss</a> and put your repository URL there. Once generated, the link will be visible.<p>You can also put the prefix url in front of the repo url: <a href="https://docucod.com/docs/<repo-url>" rel="nofollow">https://docucod.com/docs/<repo-url></a> (example: <a href="https://docucod.com/docs/https://github.com/clidey/whodb" rel="nofollow">https://docucod.com/docs/https://github.com/clidey/whodb</a>)<p>Please note this will work only for public repos up to 100MB.<p><i>How it works:</i>
Docucod analyzes the codebase, parses files, comments, types, examples, and the readme, then builds a static documentation site you can browse immediately — no config, no setup.<p>It tries to surface useful context automatically so you don’t have to read the code line by line to figure out what’s going on.<p>There is diagram generation with Mermaid, and we are working on generating images and later videos!<p>The publishing is done with our own static site builder called <i>Dory</i> ([<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>](<a href="https://github.com/clidey/dory">https://github.com/clidey/dory</a>)).<p>It handles parsing, structure extraction, and HTML generation. Dory has been built with handling AI-generated MDX in mind, which is an interesting hurdle to overcome.<p>We're still fleshing it out, so PRs and feedback are very welcome.<p><i>What’s next:</i>
Right now we support public GitHub repos (private support coming). We’re also working on features like code search across the docs, customized responses based on the user's query, better navigation, theme customization, and integration with CI pipelines.<p>If you check it out, I’d really appreciate your feedback — both the good and the bad. Does it solve a real problem for you? What’s confusing, missing, or just not helpful?<p>Thanks!