【软件工程】-文档总结

总结

   最近着手写软工的文档，一共12个文档，真是编到山穷水尽，之后通过站在巨人的肩膀上，写起来也轻松了不少。每个文档都有不同的作用，适合不同的读者，使用在不同的阶段。文档是不同的人群不断的交流所写出来的，文档可以帮助理清思路，在整个软件的设计过程中发挥着不可磨灭的作用。

分类

文档的读者

- 可行性研究报告：系统管理员、开发人员和维护人员
- 项目开发计划：系统分析员和开发人员
- 软件需求说明书：开发人员和用户代表
- 概要开发设计说明书：开发人员
- 详细设计说明书：开发人员、测试人员
- 数据库设计说明书：程序员、数据库管理员
- 测试计划：开发人员、测试人员
- 测试分析报告：开发人员
- 项目开发总结报告：开发人员
- 操作手册：用户
- 用户手册：用户
- 开发进度月报：项目开发人员、用户代表

意义和目的

- 可行性研究报告
   概括性的说明系统的开发是否可行，对项目的可行性进行分析
- 项目开发计划
   对整个项目各个阶段的规划说明
- 软件需求说明书
   阐述用户对项目的一些需求，进一步确定软甲的功能和性能
- 概要开发设计说明书
   在需求说明书的基础上，把用户的需求分成几个模块，让模块与模块之间建立联系
- 详细设计说明书
   确定了一些细节上的问题。如具体的算法、数据库的结构设计等
- 数据库设计说明书
   提供了数据库的设计的理论支持，对数据库中使用的所有标识、逻辑结构和物理结构做出具体的设计规定。
- 测试计划
   描述将要进行测试活动的范围，方法，资源和时间进度的文档。目的就是尽可能多的找到系统中的漏洞，并且设计出测试用例，对系统测试。
- 测试分析报告
   测试分析报告是在测试的基础上，对测试的结果以及测试的数据等加以记录和分析总结。
- 项目开发总结报告
   对整个项目进行总结报告，总结开发经验，对系统进行评价
- 操作手册
   为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，解决过程中遇到的问题。
- 用户手册
   为了给使用者提供一个使用指南，以便为首次使用该系统的用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决问题的方法。
- 开发进度月报
   汇报项目的进展情况，处理发现过程中出现的问题

总结

   在写文档的过程中我们扮演者不同的角色，从不同的角度考虑问题。刚写完这12个文档之后，感觉很懵。并不知道为什么要写这么多报告。现在把文档都总结了一遍，瞬间思路就清晰了。
  如有疏漏的地方，还请大家斧正。