写文档和写代码一样,是一个程序员必备的技能之一。
大部分的项目都是需要团队进行配合的,而团队配合之间,很多是无法使用源代码进行工作的记录和流转的,所以就需要使用文档了。
不过,如果写文档的时间比写代码的时间还多的话,这就有问题了。
对于一个程序员来说,写代码速度和质量,肯定是直接生产效率的体现,如果将自己的大部分时间都花在文档上面,那就说明了程序员的生产效率存在问题。
可能我们就需要分析,是不是自己出了什么问题了?
对写文档很反感?
很多人在开始的时候,都会有这个阶段,就是对写文档十分的反感。我曾经也有过这样的一段时间,觉得我写代码很开心,写文档很苦恼。
所以,写代码的时候,我进度很快源码,但是写文档的时候,就半年写不出一个屁出来。以至于我花在文档上的时间比在代码上多了。
这个时候,我们还是需要现正视写文档这件事情。其实这件事比写代码要简单源码,而且在写代码前后撰写文档的过程中,也等于对自己的代码进行预演和复查了。
很多时候,我们在自己写文档的时候,还能发现一些自己业务逻辑中不正确的部分然后提前就进行修改了。
所以,不要觉得文档是无意义的,真的有一天,你成为了架构师的时候,你写文档的日子就真的比写代码多了。
时间安排上的不合理?
我们在写文档的时候,一般都在思虑成熟以后再下笔。如果我们是边想边写,可能就会写着写着,发现自己跑偏了,然后思路需要重新整理,文档也就需要重写了。
重新整理思路是一个很快的过程,但是如果需要重写文档,就是比较麻烦的过程,这样就浪费了自己大把的时间,最终的结果就可能是,自己花在文档上的时间过多,但是用在代码上的时间不够,导致最后代码的质量不高。
所以,现在纸上随便的写写画画,将自己的思路整理好了,再来整理文档。
当然,我曾经的做法是,在我将代码都写好以后,然后检查代码时,再来补功能分析文档,虽然和规定的顺序有所不一样,但是我至少完成了文档和代码,并且效率也高。
我们都知道,很多的程序员在年龄到了一定的时候就会转方向,有的喜欢研究技术,所以往架构方向发展,有的习惯协作管理,所以往项目经理方向发展,还有的觉得产品设计是自己的爱好,所以转了产品。
不管你未来的目标是什么,唯一能够肯定的就是,写文档会成为你日常工作中最多的事情。
对于架构来说,架构的说明文档,PPT等等会占据大量的时间,而且还有很多的时间会用来进行演讲和沟通,写代码的时间可能有30%左右。
对于项目经理来说,那代码就和你没缘了,每天就是各种各样的文档和报表,如果公司给你的权利够多,可能还需要做成本分析控制和预算,那些文档就更细了。
对于产品来说,那也不需要写代码了,和运营、市场的往来会更加的频繁,其他的就是各种原型图,PRD等等。
所以,同学们,从现在开始就习惯文档吧,免得未来要上一个台阶的时候,你觉得有压力。