呜啦啦的碎碎念

眼中有世界,心中有天地

心有猛虎,细嗅蔷薇


欢迎来到我的个人站~

为什么程序员不爱写文档

部门周会、例会时也总是有人反馈文档不全,不知道在哪里找,尤其是新人。深有同感,当我们入职一个新公司,接手一个老系统时,总是希望有健全的文档来支持快速学习,然而不爱写文档基本是程序员的通病,甚至是技术公司的通病,很多大公司的文档质量和完整性都参差不齐。诚如这些抱怨文档不全的同学,虽然抱怨,但是当自己写文档的时候,又不(愿意)好好写,真是本是同根生相煎何太急啊。

为什么不写文档

为什么不能好好写文档,给后来者一条活路,终止这个恶性循环呢?我想可能有以下原因:

1.没时间写

需求总是变更,上线时间紧,任务又是一个接一个不停,那就没时间写了。

2.文档对能力的提升有限

因为不爱写文档,大部分时间写文档也只是套套模板,草草了事,即不能形成知识沉淀,也不能深入分析,文档的效果当然大打折扣。

程序没有好的设计,无法写出清晰的说明设计思想的文档;缺少问题分析的能力,也写不出深入的问题分析文档。

3.工作技术含量低

工作技术含量低,多以实现功能为主,缺乏抽象能力,多为重复堆叠代码。认为代码胜过文档,代码代表一切。

4.对文档不够重视,没有明确的文档沉淀流程

从领导到员工,有的觉得文档可有可无,做好功能上线了事;有的文档写的随意,不成体系,靠个人主动性沉淀,没有专人持续性的整体规划推进和优化。

为什么要写文档

华为有一句话“华为公司最大的浪费就是经验的浪费”。要想不浪费经验,最直接的方式就是文档沉淀,形成高效的知识管理。缺少完善和健全的文档,缺乏良好的文档沉淀能力,于团队、于个人都是重大损失。

1.经验无法继承

于个人,无法将过往的经历沉淀成经验,大量的精力用在重复造轮子,没有总结就没有成长。

于团队,没有完善文档,有经验的人员流失容易造成团队整体在低水平循环,不利于团队的长远发展,也无法形成有效的人才梯队。

2.信息孤岛,故步自封

没有沉淀,过往经验只存在每个人自己脑子里,没有分享,也不能适时更新,有时系统已经更新了,还在固守着老经验。

不能交叉验证,不能深入分析,无法升华,很多问题都停留在似是而非,导致知识和经验无法熟练的指导工作。

3.经验无法复制,创新成本高

每次员工流动都要从头再来,没有完善的文档,无法快速学习融入,有时甚至导致人员流失。

系统升级改造也无法有效利用过往经验,往往踩过的坑总要继续踩,造过的轮子也要重新造,造成创新成本高,实际执行可能喊的响,做的难,最终仍然走老路。

最后引用华为任正非的话结尾,“现在是信息社会,知识很重要,更主要还是视野。所以要把经验写出来,年轻人看了案例,上战场再对比一次,就升华了。……现在你们要善于把经验写成案例,否则做完了沾沾自喜,经验还只留在你一个脑子里,没有传承”