FAQ-为啥许多软件开发团队与个人都不(爱)写开发文档( 二 )




git+ markdown+ atom/vscode + markdown preview enhance 真心是个好东西, 基本能满足绝大多数文档和笔记的书写.

我这两年算是写各种文档上瘾了...

■网友
并不是不爱写文档,只是写的不是那么认真而已。
说实话,在我所认识的软件工程中提到的所谓的“文档”其实指的是“在开发过程中产生的非代码类的文字记述”都算是文档,也就是说计算机无法识别的部分,但属于这个项目中的记载性文本都应该算文档,只不过做开发的人不会专门去整理这类文字记载,写的很随意而已只要能辅助开发者的开发记忆就行。

■网友
哪次都是写完项目补交文档,谁乐意。
人员配备不齐,实际项目你开发,需求、设计、文档让你补这都没什么可说的。连测试计划、说明、用例、执行、回归、报告文档让你补,配置文档还让你补,都补吐了,怎么可能爱。

■网友
如果按写文档算钱的话,不按功能和代码行,我觉得大家会喜欢上写文档的,奸笑...
■网友
磨刀不误砍柴工,道理大家都知道。但是从短期来看,砍柴是KPI,磨刀不是KPI,反而会降砍柴的KPI,这种事情傻子才会做;从长期来看,文档往往是给别人用的,我的文档写的好,提高的是整个团队的工作效率,又与我何干?KPI是一个相对概念,大家砍柴都快了,只会让老板以为是柴好砍了。
诸如文档之类的事情,只能作为制度来推行。推行的过程中,你会感到开发人员那种天然的抵触情绪--“活不是你干,就会给我们找麻烦。”。换位思考,也很容易理解。
历史上一些好的制度得以推行,总会先有一个大的灾难。


推荐阅读