为什么现在的开发者都不愿意写文档了?是真的没时间还是懒?

1 天前
 charoneo

最近接手了几个项目,发现一个普遍现象:代码写得挺好,但文档基本为零。问前任开发为什么不写文档,得到的回答基本是"代码即文档"、"没时间"、"写了也没人看"。

但实际接手的时候真的很痛苦,业务逻辑全靠猜,配置项靠试,部署流程要自己摸索。花在理解项目上的时间比实际开发还多

4402 次点击
所在节点    程序员
64 条回复
iorilu
20 小时 11 分钟前
咋不写文档

现在 ai 开发都是先写文档的
lizy0329
20 小时 10 分钟前
不!要!写!文!档!只做简单的流程记录,或者代码注释
Cheons
20 小时 7 分钟前
文档是甩锅用的,不是对接用的🥲

很少有人看文档。。。
rb6221
20 小时 6 分钟前
如果你说的是技术文档,那很多人所说的代码即文档是一个不错的理由
如果你说的是产品或者其他领域的文档,那不是程序员的职责。
bitmin
20 小时 6 分钟前
我用 agent 生成文档自己校对,git 有新提交就让 agent 根据提交记录修改对应文档

让 agent 生成一次文档也能看模型对项目的理解程度,容易误解的地方就补充代码和注释
Cheons
20 小时 6 分钟前
@Cheons
这里仅仅指工作方面。

公共文件、个人开源肯定是要写和看的。
layxy
20 小时 4 分钟前
写文档又没有 kpi,整天忙的活都干不完,哪有时间整理文档,而且你这碰到代码写的不错的,要是碰到一个屎坑还没文档,你猜都不好猜
insert000
19 小时 58 分钟前
除了前后端对接写点接口文档,其他文档写了也没人看,只要你还在公司,问你总比看文档快。你不在公司了,那文档其实也没人关心,大概率就是这快业务不迭代不维护或者新开发了
wulinn
19 小时 48 分钟前
以前的开发者真的都在写文档吗?好奇。
ZDaYu
19 小时 46 分钟前
@cutchop 真的是 我快受不了了 完成一个功能之后能写三四个文档,说明文档,工作完成文档,测试文档。,。,,

另外回复下题主,可能在近一两年你写得代码注释已经没有用了,ai 可能比文档更懂代码,要写清楚的可能就是业务了
CyouYamato
19 小时 39 分钟前
得看领导喜不喜欢看, 喜欢看天天写.
lscho
19 小时 15 分钟前
说实话,写文档不如写好代码注释
shunia
19 小时 14 分钟前
没写过需要被人 review 的文档的人,不知道写文档有多难。

如果你代码写得好,自然是希望做事精益求精,那么写文档你可能也会尝试去尽量写的好,甚至某些情况需要反复迭代。

客观现实是:
1. 你有那个写文档的能力吗?文字能力需要经年累月的训练,和写代码一样。如果你没有坚持写文字,那么这是一件非常难做好的事情。写的不清不楚的文档,使用者看完还要反复来查代码,甚至找文档编撰者进行核对。
2. 你有那个写文档的时间吗?文字工作对文字工作者来说都是非常耗时间的,更何况是一个程序员?
3. 你写了文档,有人愿意读,有人愿意用,有人给你反馈吗?有的人可能文档是有 review 流程的,好歹会被人吊一遍。普通人在绝大部分公司里写的文档但凡有一个人能用到都得傻眼。
4. 有一个非常实际的问题,项目需求总是变化,要能及时追踪变更并同步去更新文档,这比从头开始写文档要更难。
hackroad
19 小时 3 分钟前
防御性编程
bowencool
15 小时 25 分钟前
坚持写注释,到时候喷同事代码的时候多一个理由,有底气一点
littleG
15 小时 13 分钟前
我是不写文档,但是我项目工程目录、命名、代码结构,尽量做到有条理,也坚持写注释。不写文档第一主要是没人看,第二是因为项目需求变更和进度赶。
vipfts
14 小时 53 分钟前
@kristofer 把你 Leader 电话给我, 我举报你工作不饱和
xinzhanghello
14 小时 33 分钟前
因为傻逼太多,你写了文档,他看都不看就来问你。
Daybyedream
14 小时 27 分钟前
加钱啊 各种问题 不如不写
opengg
14 小时 23 分钟前
AI 适合这个工作

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1169550

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX