返回首页
最新
为什么太阳会发热？什么是引力？什么是黑洞？为什么常青树始终保持绿色？你所有的好奇问题，尽管问我。
嗨，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管道的集成。
如果您试用一下，我非常希望能得到您的反馈——无论是好的还是坏的。它是否解决了您的实际问题？有什么让您困惑的地方、缺失的内容，或者根本没有帮助的地方？
谢谢！
我：我不喜欢与大型语言模型（LLMs）进行基于事实的对话（例如，我的猫可以吃带骨的熟鸡肉吗？）。我更喜欢与大型语言模型进行开放式的对话，在这种情况下，模糊地朝着正确方向发展会很有帮助（例如，使用ChatGPT的语音模式练习中文）。<p>我使用Claude代码，觉得它在某些方面很有用（因为我对特定功能的记忆一般），但当我不得不花很多时间来清理应用中的糟糕逻辑或流程时，又感到有些沮丧。<p>我也很好奇你与大型语言模型互动的细节。
Copilot糟糕透顶。<p>开发者们有像Cursor和Windsurf这样的工具，可以将AI无缝集成到他们的工作流程中。但对于其他专业人士——整天写文档和邮件的人来说，体验充其量也只是勉强可用。<p>Word的Copilot感觉像是一个演示版。Outlook的功能几乎无法使用。因此，大多数专业人士只是将内容复制粘贴到ChatGPT中，然后再粘贴回来，以便得到一些精炼的结果。<p>所以我创建了Scrutiny。这正是Copilot应该具备的功能。<p>我最初是为自己开发的，但现在我们在几家大型咨询公司和独立专业人士中看到了显著的采用率。<p>在这里免费试用：www.usescrutiny.com<p>非常希望得到反馈，尤其是那些尝试过Copilot并感到失望的人。