最近接手了几个项目,发现一个普遍现象:代码写得挺好,但文档基本为零。问前任开发为什么不写文档,得到的回答基本是"代码即文档"、"没时间"、"写了也没人看"。
但实际接手的时候真的很痛苦,业务逻辑全靠猜,配置项靠试,部署流程要自己摸索。花在理解项目上的时间比实际开发还多
1
cutchop 4 小时 53 分钟前
Claude Sonnet 4.5 喜欢写文档,你去找它吧😄
|
2
facebook47 4 小时 41 分钟前 via Android
还是分公司和领导,我之前公司写,现在也不写,入乡随俗了😁😁😁
|
3
fandun 4 小时 41 分钟前
并不是我想喷您,但是后续如果是常态就要学会利用 ai ,毕竟如果不会用则可能淘汰,工作中的不顺往往是不会利用工具造成的,如果是内网那如上内容我扯犊子
|
4
realpg PRO 你给我足够的时间 我愿意写啊
实际上 还不是时间不足 都像老外那个工作强度 那文档能写出花来 |
5
s2555 4 小时 32 分钟前 我都是刚开始的时候写,后面就不写了,进度赶,需求又经常变。
|
7
llxvs 4 小时 28 分钟前 via iPhone
因为写文档属于领导看不到成果的幕后工作
|
8
bbbblue 4 小时 27 分钟前 说起这个想起之前上班的时候负责一个服务,写了详细的接入文档。
有人过来找我我先让他看文档。 结果有个老哥就是不看,就是要过来找我,让我手把手给他弄,后面看到他因为这个举动被评上了积极推动项目之类的奖项。 我都快成反面教材了,傻眼了。😂 |
9
chenxytw 4 小时 19 分钟前
If the code is really good enough, document is not necessary.And actually, you just need feature story, that's not programmer's business, you'd better ask
|
10
DefoliationM 4 小时 17 分钟前 via Android
没时间写,写了也没人看,干脆不写了。
|
12
OneLiteCore 4 小时 9 分钟前
写文档无法当成 KPI 写到工作总结里,和钱无关自然就没人重视了,老板会因为你负责的业务模块赚钱给你发多点年终奖,但不会因为你写的代码可读性良好文档齐全而奖励你。
没有文档无非就是新入职的程序员掉点头发而已,老板不在乎的。 赚钱的是业务而从来都不是代码,想明白了这些就不会有疑惑了。 |
13
LeslieLeung 4 小时 3 分钟前 via iPhone
前面有人说到时间、业绩、维护麻烦、没人看等等理由,我问个扎心的,真要写的时候有没有能力真的写好。
写文档也是需要表达能力的,怎么用简洁通顺完整的话把东西交代清楚,而不是崩一大堆零碎的词就是文档了。 |
14
nuonuojump 4 小时 1 分钟前
得加钱!(开玩笑) 我之前就是负责调研产出文档,经常要的很急,然后周末加班写文档,辛辛苦苦写完了,领导 嗯一下,也没人看。遇见了还是来找你,后来我就开始水文档,反正没人看。有那时间还不如写点技术博客方便装逼。
|
15
Ketteiron 3 小时 53 分钟前
代码即文档没什么毛病
文档这玩意不就是 xxx 模块有什么 xxx 功能,需要实现 xxx 接口等等,让 AI 扫一遍就行了 现在这年头确实没必要写那堆冗余的文档了,有什么注意的请直接写到代码注释里,真有人写也是 AI 生成的大概率没精修过的废话文档 |
16
kristofer 3 小时 46 分钟前
我爱写。我写文档其实也不是为了给别人看的,而是对自己所做的事情的一次梳理吧,不过如果功能迭代,我不会改原始文档,只会追加一份新的。
写文档其实挺难的,先写什么,后写什么,怎么能逻辑通顺,都是学问。写文档其实是一种能力,有的人不写不仅是没时间写,更是没能力写。 |
17
woniuppp 3 小时 21 分钟前
因为没加钱
|
18
starlion 2 分钟前
公司项目时间紧,还有公司的工程文化,反正多方面的。
不过现在有 AI ,可以帮你理解,减少一点理解的痛苦 |