你们是怎么将文档和代码对齐的？

bwnjnOEI 2026-08-01 00:45 1

以及修改代码后如何保证文档不被改烂，还有就现在 agent 的输出都能读下去吗？如何应对高信息密度的输出和那些令人抓狂的内容。

最新回复 (13)

gausszhou 08-01 03:08

1楼

只看结论
Anarchy 08-01 05:28

2楼

Agent 最后会有一个结论报告，看那个就可以。文档和代码做好分层，思想和 skill 的概念是差不多的，另外文档属于 AI 写的 AI 看，你不用太介意文档本身质量，只关心 AI 工作的结果就可以了。
avenger 08-01 06:59

3楼

好的代码
就是最好的文档
Godblessu 08-01 07:31

4楼

@avenger 好的文档亦是最好的代码，有好的文档可以写无数种可能
ericguo 08-01 08:21

5楼

文档少写就对齐了，文档是宪法，代码是条例
redbule 08-01 09:16

6楼

有 ai 了，不需要文档。代码在不断变化，需要的时候就靠 ai 输出一次文档，每次都要最新的输出
wetalk 08-01 09:17

7楼

@Godblessu #4 好文档你也不可能逐字逐句看，信息过载时代，文档最大的价值就是对 ai 有用
crocoBaby 08-01 09:18

8楼

创建一个 md,设置 agent 每次修改完成之后都同步更新 md
Godblessu 08-01 10:23

9楼

@wetalk 日企都是面向文档开发
SenseHu 08-01 16:27

10楼

每次改完代码让他自己更新文档咯, 推荐个框架 trellis, 好用的很
THESDZ 08-01 16:32

11楼

看你是文档导向还是代码导向，有完整的开发流程，就文档先行，然后测试用例+自动化测试+变更日志兜底，不关心代码本身。
假如你的文档也就那样，那就代码即文档，用规范的设计（如接口代替细节，规范命名等），让代码自解释（即：开发人员或者 AI 不需要关注实现细节，只关注接口命名等），当然还是要配合测试用例和自动化测试兜底。
xuanbg 08-01 22:27

12楼

不写文档
liuxue 08-02 14:00

13楼

对不齐，我这甚至功能和需求文档都对不齐，三手项目，现在反馈的需求和 bug 是用聊天工具给我的