软工总结——写文档真的重要吗？

       今天晚上师傅给我验收软工文档，提到软工文档很重要，确实自己写的也不怎么样，毕竟第一次写都是照着模板和别人思维成品，一点一点磨出来的。有时候不会写了甚至从别人的博客上复制下来一段，写文档这个过程真的很难受，可能是理科生的原因，看见文档就犯怵。不知道大家有没有同感，宁可再看一遍视频也不想去写文档。当然了，有的人可能觉得文档有什么好写的，瞎写写得了。所以这个阶段过的很快，快点的两三天，慢一点的大概也就一个星期左右吧。虽然第一遍不要求写的多么好，但至少态度一定要端正，认真的去对待。因为写文档真的很重要！

                            

       像咱们这种将来要从事IT行业的人，学习编写代码很重要，因为要想当程序员，学会写代码是最基础的。那为什么还要写文档呢？因为软件除了代码和数据之外还包括文档，我们要把自己做的东西展示出来，展示给同行看，展示给其他岗位上的工作人员看，展示给用户看。如果我们只是会写程序，不会在文档中恰当且优雅地描述自己的想法，那么就真正的成为“码农”了。所以有人说：如果你想当一辈子码农，那就干脆别写文档。如果真是这样的话，那就和米老师的思想相背而行了。我们将来都是IT的精英，怎么会甘心做一辈子码农呢！

       下面是我在网上浏览时看到的，感受很深：

       不管从哪个发展方向上说，培养自己的写文档能力是那么的重要。 如果你将来的发展方向是实施、项目管理，那么在项目过程中，不管在哪一家公司里，势必有大量的文档要写：总结、汇报、需求报告…，一个优秀的项目人员必须具备十分优秀的笔头功夫。特别是项目经理，这是基本功。 如果你将来的发展方向是开发、设计、系统分析师、架构师，那么，系统分析、设计报告也是必不可少的。一个优秀的、高级的设计、分析人员其文笔也是很漂亮的。 如果你将来向管理岗位发展，更不用说了，各类的规划、总结、述职报告等，也是需要很过硬的文字功底。 

       我们可能都是从理科出身的，好像对写东西有一种“抵触”或者“畏惧”的心理： 

       1. 不愿意写：写文档是在搞形式、做了实实在在的事情，比写和汇报更重要…。这种想法窃以为是不正确的。用合适的方式表现出你的业绩是现在社会生存的必备条件，这个世界不再欣赏试图等待别人去挖掘你深层次价值的人。人越来越聪明，社会越来越成熟，节奏越来越快，等不了你的慢慢表现了。当然，在这里也不是提倡只会写不会做的风气，其中分寸自己去把握了。

       2.不知道怎么写：我们可能都在等待着模板。“Xx报告该怎么去写，给一个模板就好了”。但实际上，我们现在不是也经常出现给了模板之后，照样的，写出来的东西也是质量不高的情况？所以，模板不是你不会写的关键。模板是重要的，更关键是用心。如果有心去写，参照模板、范例、请教别人，某一类的文档，只要写过2遍，就绝对会写了。关键还在于对文档的认识，对提交出符合质量要求的报告是你的一个重要的工作职责的认识

       我感觉写文档最主要的就是要用心，写文档多数情况下是不愿意写，不知道怎么写，这就符合很多人在写文档时的心理。可这是必经阶段，需要用心、细心、耐心的去写，只有过了那个坎儿，才能拨开云雾见青天，柳暗花明又一村。

       这让我想起了自己写文档时的心态。自己写文档时很是纠结，经常写着写着就开始抵触，尤其是去构建表，画流程图、E-R图等，感觉实在是浪费时间。还有就是在写的过程中，没有很好的理解它的内容，就这少一点，那少一点，偷工减料了很多，只挑了重要的写了。最后还是师傅说都要写完，我才坚持都写了一遍。

       下面是我在CSDN上看到的，写的确实不错，阐明了写文档的重要性，推荐给大家：

       题目：程序员即要写好代码，又要写好文档

       地址：http://www.csdn.net/article/2014-08-12/2821148