[软件工程]文档 总结

    软工文档写完了之后对一些文档有了更深的认识，通过写文档也认识到了文档的重要性。我认为要明白每个文档的编写目的是什么，要给谁看，它的核心内容是什么。下面说一下对每一个文档的认识。

   （1）可行性研究报告

    它是在开发的开始时期编写的，属于定义阶段。

    目的：说明系统项目的实现在技术、经济和法律方面的可行性，评述为了合理的达到开发目标而可能选择的各种方案，说明并论证选择的方案，以供后期开发进行参考，为以后的为以后的整个开发过程做一个铺垫，项目经理或组长可以依此为参考进行决策。     

    读者：系统的管理人员，开发人员，项目负责人

    核心内容：可行性分析方面的内容

   （2）项目开发计划

    目的：为了给开发系统做主要的规划和整合，对系统的费用、时间、进度、组织、硬件设备的配置、开发环境的配置进行说明，为开发的下一步做准备。

读者：系统分析员、开发人员、项目组长

核心内容：期限和实施计划方面的内容。

（3）软件需求说明书

目的：方便用户进行查看自己的最初愿望有没有确定，是软件设计人员进行软件开发的出发点，系统维护人员发现和添加新功能的依据。

读者：用户、分析人员、软件设计人员，维护工作人员

核心内容：需求规定的内容

（4）概要设计说明书

整体说明软件的实现思路，指出关键技术难点。是开发阶段的文档

目的：在用户需求分析的阶段的基础上，对系统做概要设计，确定一个软件系统的体系结构。为软件系统提供所用的数据结构或者数据库结构，同时为下一阶段的详细设计做参考。

读者：项目设计和项目编码人员

核心内容：接口设计、处理流程、数据结构设计

（5）详细设计说明书

对概要设计的进一步细化，一般由各部分担当人员一句概要设计分别完成，最后再集成，是具体的实现细节，理论上可以照此编码。

目的：在概要设计的基础上进一步明确系统结构，为下一步系统的实现和测试做准备。

读者：程序开发人员和程序测试人员‘

核心内容：算法设计、数据结构设计、物理设计

  （6）数据库设计说明书

目的：说明项目的数据库设计、结构情况，用于开发人员进行项目设计，同时为后来的数据库维护工作提供使用说明，可以作为未来版本升级的重要资料

读者：开发人员、变成人员、维护人员

核心内容：结构设计

  （7）数据要求说明书

目的：为系统的实现提供所需要的数据，根据这些数据设计数据库。

读者：项目开发人员、变成人员、维护人员、数据库操作人员

核心内容：一些数据描述

  （8）测试计划

目的：机房收费系统已经基本完成，为了更好的完善项目，还需要对项目进行测试，发现程序中的错误或者没有遇到过的错误。

读者：维护人员

    核心内容：测试内容

  （9）测试分析报告

目的：对测试进行分析，明确系统出现的问题，以求寻找适当的解决办法，使系统更加完善

阅读人员：开发人员、编程人员、维护人员

核心内容：缺陷和建议

  （10）项目开发总结报告

目的：为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价，说明本项目的工作流程，工程开发中状况，最终结果，经验教训等。也可以作为维护项目的参考资料。

预期读者：开发人员、编程人员、维护人员

  （11）操作手册和用户手册

目的：让没有使用过的系统用户看到这个文档后可以懂得操作方面的基本知识，通过阅读此文档，用户可以掌握系统的使用方法和操作步骤

预期读者：维护人员、用户

核心内容：输入输出相关内容

  （12）开发进度月报

目的：为项目组长掌握开发进度提供最可靠的依据，高效的完成软件的开发，为项目的开发总结报告提供依据。

预期读者：项目组长，项目开发人员

核心内容：进度与计划

总结：

开始的时候忍不住看师辈们的博客，看他们是怎么写的，看几篇后发现他们的还是有很多不同的，每个人有每个人的理解，才知道要有自己思想才可以，不管他们的哪个是对的。前两个文档借鉴了一下大家的，可能有大部分是别人的想法。后面的自己写，实在不会的再上网查一下。文档编写的时候有的地方是可以借鉴别人的，但是只是作为参考，还是要自己独立完成。对于像数据流图、甘特图、编写目的等一定要掌握。