2. Linux.do
  3. AI下怎么写好项目文档md的介绍

AI下怎么写好项目文档md的介绍

chenjoe 2026-08-24 17:42 1

因为现在我们项目的代码比较庞大，可能需要一些md文档来告诉llm这个项目的具体情况，但是又要注意文档的腐化情况，而且有个趋势就是，几个月前还需要详细文档来让llm更好理解，现在已经完全不需要了，所以想请教佬们佬们平时在项目怎么维护这些文档的，或者怎么让llm懂你的项目的？

最新回复 (9)
  • 洛卡卡了 08-24 17:46
    1楼

    目前我和我的团队是用 trellis 的 然后定期比如版更的时候去整理 spec 确保精简的同时 去掉过时的规则规范 保持最新的规则。采用 ai 加人工双层审核测评的模式。

  • chenjoe 楼主 08-24 17:51
    2楼

    谢谢佬，我尝试看看，因为之前看到说trellis有时候觉得太重了，对5.6 sol来说，所以还没去看，因为觉得可能后续模型不太需要这些太重的框架

  • 洛卡卡了 08-24 17:53
    3楼

    明白的，不过重的话需要明白重在哪里 在裸agent工具中引入任何辅助 ai 开发的都是成本，但是如果最终效果是大于成本代价的话 就是值得的。

  • Humpy 08-24 17:55
    4楼

    分两类，给人看和给ai看，前者人工review，起到快速浏览项目概要和重点的作用。后者人工几乎不看内容，允许一定程度膨胀，用来兜底，防止重要信息遗漏。

  • chenjoe 楼主 08-24 18:01
    5楼

    那想问下佬，这两类怎么区分好，比如哪些是ai看的，哪些是人看的？ 这个边界感觉有点难琢磨，且维护成本是不是就是两套了

  • Humpy 08-24 18:04
    6楼

    很好区分啊，人只能看细节少，知识密度高，概括性的内容，细节就放在ai文档里，

  • 比一个peace 08-24 19:32
    7楼

    话说，一般多大的项目（大概多少行）算大的，才要写md

  • czm 08-24 22:17
    8楼

    本帖使用社区开源推广，符合推广要求。我申明并遵循社区要求的以下内容：

    我的帖子已经打上 开源推广 标签： 是
    我的开源项目完整开源，无未开源部分： 是
    我的开源项目已链接认可 LINUX DO 社区： 是
    我帖子内的项目介绍，AI生成、润色内容部分已截图发出： 是
    以上选择我承诺是永久有效的，接受社区和佬友监督： 是

    以下为项目介绍正文内容，AI生成、润色内容已使用截图方式发出

    不知道佬友…


    佬也可以参考参考这个项目的方式来维护

  • 天怒 08-24 22:19
    9楼

    agent+技术选择文档踩过什么坑+当前技术选择具体在哪看

* 帖子来源Linux.do
附近帖子
返回
飞读
随机推荐