由写文档想到的 | Daily 04/30

发表于   |   --

工作时想到一个腹黑的问题。

在接手的很多项目中,很少有文档写的很详细的,貌似大家都不喜欢写文档。

有时别说文档了,代码中能有一些前人的注释也算不错,慢慢发现,项目中能有良好的文档是一种奢求。

当然这跟具体团队也有关系,不过自己经历过的大部分团队,文档意识都不怎么样,可能团队中的部分人有文档意识,但是整体对文档大都不重视。

我个人算是比较喜欢写文档。开发完组件或者一些对外提供的模块后,总会想着去把文档也写完整,文档感觉就像是一个门面。

写文档有很多好处。比如,如果有人要使用自己开发的东西,就可以让他先去看文档,这会降低沟通成本,提高工作效率,也显得自己很专业。

这就是我对文档简单的一些想法,在这之前我从来没觉得有什么不对…

不过最近有了一些新的想法。

当你把文档写的很详细,一方面,如上面所说,可以提升团队效率,但如此同时,以后别人就可以相对轻松的能接手你负责的模块,你在工作中的替代性就大大减弱了。

之前本来需要你口口相传才能解释的业务逻辑,现在,别人看文档直接就明白了,完全可以跳过你,相应的,你的价值可能就会有所降低。

当然写文档终究是一个行业内大家都推崇的好习惯,但是大家为什么不爱写文档,难道只是因为懒惰吗,还是因为有如上所说这种因素呢,不得而知…

不过,如上所述的分析如果要认真来讲,还是可以找到不少的漏洞的,但这里可以引申出另一个问题:效率真的是一枚银弹吗?效率一定越高越好吗?

人类社会总是向更快更高更好的方向发展,如果一个东西可以带来效率的提升,大部分人都趋之若鹜。但事实上,观察这个现实世界后会发现,并不总是所有人都想着去提升效率。

比如国家的公务员机构,机构为人民办事,理应让办事流程变得简单,方便大家办事,但是不少机构非但不优化流程,反而去设置更多的手续,增加办事难度,为什么?屁股决定脑袋,效率会革他们自己的命,他们恨不得流程越长越好,这样他们才有工作可以干,他们才可以在这个岗位上长久的待下去,亦或者还有其他的原因。

类似的例子还有不少,比如送货无人机对快递员,机器手人对仓储分拣工人,前者都带来了效率,但是后者并不愿意去接受他们…

总归,优胜劣汰,但是这个过程却并非一蹴而就…

rss facebook jianshu juejin zhihu weibo twitter github gitlab youtube mail spotify lastfm instagram linkedin google google-plus pinterest medium vimeo stackoverflow reddit quora quora