开源项目有没有必要维护一个技术文档？

Lickkk · 2026-09-13T00:45:00+08:00

rt，一个认真维护的项目有必要在开发完一个功能就沉淀为一个文档吗，但是可能会经常改来改去，自己之前是没有写文档的习惯的，但是听前辈们说，文档似乎是很重要的，想请教一下各位，如果要写文档的话维护在飞书文档还是wiki呢需要全开编辑权限嘛，还是说只给核心人员？ps：大部分代码是ai写的，但是人工会思考一下方案，主要还是想跟ai前辈学习学习，将思路转化为己用

Lickkk2026-09-13
16755
rt，一个认真维护的项目有必要在开发完一个功能就沉淀为一个文档吗，但是可能会经常改来改去，自己之前是没有写文档的习惯的，但是听前辈们说，文档似乎是很重要的，想请教一下各位，如果要写文档的话维护在飞书文档还是wiki呢需要全开编辑权限嘛，还是说只给核心人员？
ps：大部分代码是ai写的，但是人工会思考一下方案，主要还是想跟ai前辈学习学习，将思路转化为己用
主楼
OctoberSama2026-09-13
10523
项目根目录新建个/docs 叫ai写文档就行时不时对齐下只要README和一些基础文档写人话就行技术文档能看懂就得了
#1
Lickkk2026-09-13
16755
根目录新建个/docs
之前有尝试过但是时间长了就堆成山了太多了而且纯ai写人工不干预的话感谢不太便于人阅读诶
#2
OctoberSama2026-09-13
10523
AGENTS.md里写上叫ai有大改动时对齐下文档人工也干预下叫ai维护一个文档清单
方便人阅读就不用太操心了别人大多也直接用ai阅读)
README这种人一定会看的写好点就行
#3
have2026-09-13
15068
个人觉得不管什么样的项目，只要它具有一定的意义，都需要维护一个说明文档
其中的内容可以根据情况来自由决定是否详尽，但必须得有这个说明
不然一个月，半年后，你自己看都是麻烦
#4
Seroton_Karlbaey2026-09-13
6041
我觉得开发完一个功能就写一小段，让 AI 根据 git diff 扩充就好。之后的 refactor 也记得修改就行。
#5
GloryDuck2026-09-13
8299
唯一事实源原则。
最好代码就是事实，开发过程中产生的技术文档，都只是历史快照，很容易过时，维护难。合入主分支的时候都舍弃掉。
#6
blacksein2026-09-13
9329
我感觉技术文档不那么必要因为参与者不一定多
但是使用文档特别重要而且要一直保持最新（不然别人没法用啊…
以及版本updates的变更
#7
yx2026-09-13
6003
还是有必要的，这东西和代码注释一样，不写过一个月可能都看不懂自己代码了
#8

发表回复

登录后回复