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

[charoneo]

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

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

[cutchop]

Claude Sonnet 4.5 喜欢写文档，你去找它吧😄

[facebook47]

还是分公司和领导，我之前公司写，现在也不写，入乡随俗了😁😁😁

[fandun]

并不是我想喷您，但是后续如果是常态就要学会利用 ai ，毕竟如果不会用则可能淘汰，工作中的不顺往往是不会利用工具造成的，如果是内网那如上内容我扯犊子

[realpg]

你给我足够的时间 我愿意写啊

实际上 还不是时间不足

都像老外那个工作强度 那文档能写出花来

[s2555]

我都是刚开始的时候写，后面就不写了，进度赶，需求又经常变。

[badreamm]

@cutchop 改个功能要写 3 个文档，我真的服了

[llxvs]

因为写文档属于领导看不到成果的幕后工作

[bbbblue]

说起这个想起之前上班的时候负责一个服务，写了详细的接入文档。
有人过来找我我先让他看文档。

结果有个老哥就是不看，就是要过来找我，让我手把手给他弄，后面看到他因为这个举动被评上了积极推动项目之类的奖项。

我都快成反面教材了，傻眼了。😂

[chenxytw]

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

[DefoliationM]

没时间写，写了也没人看，干脆不写了。

[xljya]

@cutchop 哈哈 这是真的，代码都没改好，就出来一堆文档

[OneLiteCore]

写文档无法当成 KPI 写到工作总结里，和钱无关自然就没人重视了，老板会因为你负责的业务模块赚钱给你发多点年终奖，但不会因为你写的代码可读性良好文档齐全而奖励你。

没有文档无非就是新入职的程序员掉点头发而已，老板不在乎的。

赚钱的是业务而从来都不是代码，想明白了这些就不会有疑惑了。

[LeslieLeung]

前面有人说到时间、业绩、维护麻烦、没人看等等理由，我问个扎心的，真要写的时候有没有能力真的写好。

写文档也是需要表达能力的，怎么用简洁通顺完整的话把东西交代清楚，而不是崩一大堆零碎的词就是文档了。

[nuonuojump]

得加钱！（开玩笑） 我之前就是负责调研产出文档，经常要的很急，然后周末加班写文档，辛辛苦苦写完了，领导 嗯一下，也没人看。遇见了还是来找你，后来我就开始水文档，反正没人看。有那时间还不如写点技术博客方便装逼。

[Ketteiron]

代码即文档没什么毛病
文档这玩意不就是 xxx 模块有什么 xxx 功能，需要实现 xxx 接口等等，让 AI 扫一遍就行了
现在这年头确实没必要写那堆冗余的文档了，有什么注意的请直接写到代码注释里，真有人写也是 AI 生成的大概率没精修过的废话文档

[kristofer]

我爱写。我写文档其实也不是为了给别人看的，而是对自己所做的事情的一次梳理吧，不过如果功能迭代，我不会改原始文档，只会追加一份新的。

写文档其实挺难的，先写什么，后写什么，怎么能逻辑通顺，都是学问。写文档其实是一种能力，有的人不写不仅是没时间写，更是没能力写。

[woniuppp]

因为没加钱

[starlion]

公司项目时间紧，还有公司的工程文化，反正多方面的。
不过现在有 AI ，可以帮你理解，减少一点理解的痛苦

[maolon]

现在（或者以后）不搞文档是真的会有问题，都是规范驱动开发（ Spec Driven Development ）的时代了,文档即代码, 反而你说代码注释必要不，我觉得没那么必要了

[akagishigeru]

说的没错 写了也没人看的 新来的基本不会去看

[zy5a59]

写文档最大的问题，其实是你还要维护，代码更新了文档就得更新，要不然别人看了反而会疑惑，但是又不能保证所有人改了代码都主动去更新文档

[Donahue]

钱没到位

[x86]

写好了没人看维护累😭
写差了被人挂贼生气🐶

[imnpc]

不清楚别的语言怎么用的
我是写 PHP 的
目前用的 Laravel
API 文档接口用的组件包 scramble 来生成文档
写每个功能都在代码里面写好注释 接口返回 模型资源都写好注释就可以了
然后完美符合 代码既文档
不用费劲去 Apifox 录入每一个接口和返回值了，改动以后都是立即生效的，能直观的看到每个接口的中文注释 返回字段说明

[onionKnight888]

因为工时精确到 0.5 小时，没建工时那就不写

[chendy]

作为写过好几吨注释和交接文档的老倒霉蛋，我的经验是：
要么懒着文档直接问你咋回事，要么懒着看文档直接开干。所以项目整体写个大概介绍，一些特殊业务逻辑，神秘优化技巧啥的特殊写点注释，够了，不要浪费时间

哦对现在有 AI 了，更不用写了，跟你的 AI 去说吧

[SoviaPhilo]

写文档也得分为什么写。把写文档列进绩效你就不吱声了。

[daybreakfangyang]

写好注释就完事了呗

[niboy]

现在让 AI 写代码，同时也写文档，我自己懒得写

[SmartTom]

文档写得好能加钱？换位思考一下你又愿意写吗？

[kneo]

你写吗？

[mingtdlb]

我司也不写，刚入职 不懂业务逻辑，要自己去看源码

[cshwen]

说到底就是收益，你的收益来源于老板的赏赐，老板觉得你做这件事对他来说没经济效益，自然不会为你的成果买单，顶多口头表扬一下，私下没准觉得你不务正业

[kzfile]

如果项目明确文档不够不给钱，就写了

[hoolindao]

分情况吧，当一个项目，技术栈是常见的，业务逻辑是直白的，写文档不就是把代码再描述一遍？

[94]

因为是管理上面的问题。


大部分业务变更太随意，没有变更流程。文档没更新和写的代码完全是两回事。就没写是没差别的，不如直接看代码。还减少了大量被误导然后一边看代码一边🐎🐂🐏的时刻。

更何况有很多项目组的项目经理会说现在人手不够，先开发，后面有时间再补需求文档。或者直接就说没有需求文档、开发文档，开发的时候有需求上面的问题直接找 XXX 去问。
业务方也很少会通过项目经理来提需求，基本上也是直接和开发沟通。文档滞后是常态。也就代表了开发也没有精力和欲望去写文档。

----
做交接的时候，有交接文档能指引你把项目跑起来就不错了，很多都是只是代码仓库地址，服务器信息然后就没了，怎么启项目，需要启几个服务大概率是没有的。
特殊逻辑只能指望有对应的注释可以看。有些时候你想知道当时别人为啥那么该，一看 Commit Message 全是 1 😆

[muzei233]

不算绩效

[salmon5]

这不是很正常吗？你是刚毕业、毕业不久的新人吧

[salmon5]

问这问题往往就有点“严于律人，宽以待己”了

[guanzhangzhang]

别说文档了，我上班以来看到很多 Makefile 和简单的 readme 都不写的

[iorilu]

咋不写文档

现在 ai 开发都是先写文档的

[lizy0329]

不！要！写！文！档！只做简单的流程记录，或者代码注释

[Cheons]

文档是甩锅用的，不是对接用的🥲

很少有人看文档。。。

[rb6221]

如果你说的是技术文档，那很多人所说的代码即文档是一个不错的理由
如果你说的是产品或者其他领域的文档，那不是程序员的职责。

[bitmin]

我用 agent 生成文档自己校对，git 有新提交就让 agent 根据提交记录修改对应文档

让 agent 生成一次文档也能看模型对项目的理解程度，容易误解的地方就补充代码和注释

[Cheons]

@Cheons
这里仅仅指工作方面。

公共文件、个人开源肯定是要写和看的。

[layxy]

写文档又没有 kpi,整天忙的活都干不完,哪有时间整理文档,而且你这碰到代码写的不错的,要是碰到一个屎坑还没文档,你猜都不好猜

[insert000]

除了前后端对接写点接口文档，其他文档写了也没人看，只要你还在公司，问你总比看文档快。你不在公司了，那文档其实也没人关心，大概率就是这快业务不迭代不维护或者新开发了

[wulinn]

以前的开发者真的都在写文档吗？好奇。

[ZDaYu]

@cutchop 真的是 我快受不了了 完成一个功能之后能写三四个文档，说明文档，工作完成文档，测试文档。，。，，

另外回复下题主，可能在近一两年你写得代码注释已经没有用了，ai 可能比文档更懂代码，要写清楚的可能就是业务了

[CyouYamato]

得看领导喜不喜欢看, 喜欢看天天写.

[lscho]

说实话，写文档不如写好代码注释

[shunia]

没写过需要被人 review 的文档的人，不知道写文档有多难。

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

客观现实是：
1. 你有那个写文档的能力吗？文字能力需要经年累月的训练，和写代码一样。如果你没有坚持写文字，那么这是一件非常难做好的事情。写的不清不楚的文档，使用者看完还要反复来查代码，甚至找文档编撰者进行核对。
2. 你有那个写文档的时间吗？文字工作对文字工作者来说都是非常耗时间的，更何况是一个程序员？
3. 你写了文档，有人愿意读，有人愿意用，有人给你反馈吗？有的人可能文档是有 review 流程的，好歹会被人吊一遍。普通人在绝大部分公司里写的文档但凡有一个人能用到都得傻眼。
4. 有一个非常实际的问题，项目需求总是变化，要能及时追踪变更并同步去更新文档，这比从头开始写文档要更难。

[hackroad]

防御性编程

[bowencool]

坚持写注释，到时候喷同事代码的时候多一个理由，有底气一点

[littleG]

我是不写文档，但是我项目工程目录、命名、代码结构，尽量做到有条理，也坚持写注释。不写文档第一主要是没人看，第二是因为项目需求变更和进度赶。

[vipfts]

@kristofer 把你 Leader 电话给我, 我举报你工作不饱和

[xinzhanghello]

因为傻逼太多，你写了文档，他看都不看就来问你。

[Daybyedream]

加钱啊 各种问题 不如不写

[opengg]

AI 适合这个工作

[shellic]

没时间

[crocoBaby]

你可以让 ai 给你把当前文件注释逻辑

[xz410236056]

几年前我可能还同意你的看法，现在都 AI 时代了你又那功夫看文档不如让 AI 扫一遍逻辑，又快又准。我还顺便摸鱼

[levelworm]

公司没给时间或者自己懒，基本上就这俩。