【软件工程】--文档总结

      最近写文档很是头疼，觉得自己一直都是在编编编，编到真的是词穷了… 后来的后来，我发现原来其实我们可以做的更好。

一、为什么你不喜欢写文档？
   ① 因为自己写的文档不好，连自己都不愿意去看。
    是的，当我们把自己放在一个读者的角度来看自己写的文档的时候，你会发现自己写的很水，因为很多地方自己写的都是没用的话，而不是实实在在需要的东西，不是读者需要的文档当然不是好文档。 所以我们写文档的时候要把自己放在读者的角度，想想读者最想知道的是什么， 然后再去写。 如果我们扮演了这样的角色之后相信自己写的文档一定会不一样的。

  ② 因为没有深刻理解文档的重要性，所以不知道为什么要写文档。

    

   那么问题来了，文档的读者是谁？文档的重要性在哪体现？看看下面我的理解吧……

二、文档的读者是谁？

    自己画的图，如有错误之处，还请读者多多提出，小编感激不尽…

三、为什么一定要写文档？
      理解最多的是写文档在方便自己的同时也方便了他人，文档相当于一个大纲，整个软件的开发过程都是以大纲为主线的。
      ①写文档可以提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。
      ② 软件开发管理人员可以根据文档来对整个软件的开发进行工程管理，来保证质量。
      ③ 写文档让每个阶段的开发人员对本阶段的工作进行周密的思考和权衡，今早发现疏漏和前后不一致不协调的地方，及时纠正，提高效率，同时也方便后期软件的使用和维护。
      ④写文档也是某一阶段工作成果的记录和任务完成的标志。
      ⑤ 交流，交流是软件开发中一个很重要也很难做好的问题，庞大的软件开发动辄需要上千人，每个人想法多少有出入，有了交流才会协调，系统才能完美运行。

四、一句话总结各个文档的目的

1.可行性研究报告-- 从各个方面研究此软件有为什么要开发。
2.项目开发计划-- 整个系统的规划，引导开发过程。
3.软件需求说明书-- 根据市场需求来设计软件，确定设计方向。
4.概要设计说明书--搭建整个软件的设计框架。
5.详细设计说明书--细化开发途径和应用方法，方便开发者最短的时间内完成开发。
6.数据库设计说明书--说明数据库设计、结构情况。
7.测试计划--提供测试方案，测试结果记录。
8.测试分析报告-- 分析测试结果。
9.项目开发总结报告-- 总结本项目开发工作的经验，写评价，流程，结果，经验教训等。
10.开发进度月报--为项目组长掌握开发进度提供最可靠的依据
11.操作手册和用户手册-- 目的是为了给用户提供帮助，让用户通过次文档熟练使用本系统。       


【总结】

   从反思自己为什么不喜欢写文档开始，思考为什么一定要写文档，和写各个文档的目的，这个过程我明白了软件工程是我们学习编程的纲领，文档就是整个纲领的灵魂，让我们开发的过程少走弯路。以后与文档相伴的路还有很长，继续努力~~

   感谢您的阅读……