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

[charoneo]

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

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

[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 都不写的