【软件工程】为什么要写文档

    当我进行软工文档的时候，找了几位同学问了问文档该怎么写，有的同学是直接上来自己去写，有的是借鉴了别人的文档模板然后自己按照模板去写，这些都没问题，都可以，毕竟这是第一次接触文档。

    刚才与檬檬师傅聊天，说到文档方面，我问她里面的内容是不是完全借鉴模板的答案，她却问我你为什么要写文档，我当时就蒙了，刚想说培养计划里要求的呗，到这一步了呗，但感觉这绝对不是她要的答案。

    她说你首先要弄懂为什么要写模板，模板里有什么，怎么画图。。。

于是我上网查阅了一下：

   

（官方说法）

    开发人员通过文档化的过程查错补遗；

    便于评审，在早期发现技术上的问题；

    后续阶段开发任务可能由他人承担，输出文档便于他们开展工作；

    维护人员开展维护工作需要；

    文档是必要的交付件；

    对于需要的实现方案，通常都是一个负责人在脑袋里想想该怎么实现，然后邮件或电话找几个相关人员讨论一下就算可以了，可能连个会议材料或会议纪要都没有。

    而老外他们认为一个人在脑袋里想的东西是不清晰也不全面的，有时候心里想的认为很正确的方案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能有效的避免这种问题。写文档的过程中，可以更加有效的、更进一步去整理您原来心里的思路，很多问题在您写过文档的过程中您就能发现；另外，文档写作多使用图表，浪费口水的文字尽量少用，和我们一起工作的系统工程师在系统架构分析中就画了五六十张图，就算看不懂他写的英文，从图中我们就能够很清晰的指导整个产品的系统架构。”

（自己相法）

    写文档不单单是给别人写，更是给自己写。写文档过程中相当于更加细致的又整理了一遍思路，思路清晰了，一切都会变得明朗起来，有一种“山穷水复疑无路，柳暗花明又一村”的感觉，并且一下子把大脑中记忆的这些事情全部转移到一个文档上，两个字，舒服~！！！

    还有如果你是一家公司的团队负责人，在带项目的同时形成文档，在遇到问题时方便查阅解决，不至于那么乱；就算该项目日后有他人接手，直接给他看文档就可以了，不用那么大费口舌的给他讲，讲了也有可能记不住，造成不必要的麻烦，提高效率！！！

    最后一点，就算你再熟悉流程步骤，你总有忘记的一天，但是文档可以永久帮你保存下来！！！