今天在《架构师之路》公众号上看到关于写文档的事情，有几个网友留言也是刷新了我的认知。
原来，不写文档还可以提高自己的核心竞争力，让老板不敢随便炒掉你的。这样的观点真是想像不到啊，员工与雇主之间还需要靠玩这样的小心机才能在职场上混下去，职场不容易啊。
别人都不写，就我写，那不是很吃亏？抱有这样想法的人，还是没有认识到写文档对于个人能力提升的好处。
那么，写文档有哪些好处呢？我来说说我的看法。
一、写文档是梳理思路过程。无论是编码前写文档，还是编码后写文档，如果能用自然语言把需求逻辑都表达清楚，那说明自己是真的理解清楚要做什么了。这样，把需求与代码一对照，就能清楚自己写的代码是不是符合预期的了。
二、写文档可以提高表达能力。技术人一般都比较内向，与人沟通交流时有时会词不达意，无法清楚表达自己的意思。而写文档，能让自己的思路得到整理，逻辑条理性得到加强。如果文档写多了，就会形成良好的表达思维能力，也会促进口头表达能力的提升。
三、写文档是经验总结及项目参考资料。我们在项目中使用过的技术方案，如果不加以总结，形成文档，很可能就忘了是怎么实现的了。一般，我们都需要维护自己做过的项目，但是功能多了后，并不是每一个功能逻辑都记得清楚。如果当时写了文档，回头看一下便能理解技术要点了，而不需要每次都查看代码，在多个代码细节里跳来跳去。
四、文档是项目交接的好帮手。除了离职交接外，我们如果是调换项目组，又或者是带新人上手项目，有文档的帮助会大大减少我们交接的时间。设身处地想一下，当我们自己接手一个新项目时，如果有较多的文档可以查看，是不是就不会那么慌了呢？相反，如果项目一点文档都没有，单靠前任的紧急口头相授，你又能接收多少信息呢？
每个人都能从写文档的过程中获得提高，当然，写文档不是件容易的事。就跟锻炼身体可以保障健康一样，虽然好，但需要打破舒适区，付出努力才能有收获。
网友评论