[置顶] 软工文档总结

什么是文档：

（1）文档是指某种数据媒体和其中所记录的数据；

（2）它具有永久性，并可以由人或机器阅读，通常仅用于描述人工可读的东西；

（3）在软件工程中，文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。

软件文档的作用：

（1）提高软件开发过程中的能见度；

（2）管理人员可把记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理；

（3）提高开发效率；

（4）作为开发人员在一定阶段的工作成果和结束标志；

（5）记录开发过程中的相关信息，便于协调以后的软件开发、使用和维护；

（6）提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使得软件开发活动更科学、更有成效；

（7）便于潜在用户了解软件的功能、性能等 各项指标，为他们选择符合自己需要的软件提供依据；

（8）文档是软件开发规范的体现和指南。

按照文档产生和使用范围，进行如下分类：

　　软工文档基于软件生存期方法，把软件产品从形成概念开始，经过开发、使用和不断增补修订，直到最后被淘汰的整个过程进行分割，整合为以下13种：

分别介绍：

（1）可行性研究报告

a）说明该软件项目的实现在技术上、经济上和社会因素上的可行性；

b）评述为合理地达到开发目标可供选择的各种可能实施的方案；

c）说明并论证所选定实施方案的理由。

（2）项目开发计划

a）为软件项目实施方案制定出具体计划；

b）包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等；

c）项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

（3）软件需求说明书（也称软件规格说明书）

a）对目标软件的功能、性能、用户界面及运行环境等作出详细的说明；

b）它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

（4）数据要求说明书

给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

（5）数据库设计说明书

是对于设计中的数据库的所有标识，逻辑结构和物理结构做出具体的设计规定。

（6）概要设计说明书

a）该说明书是概要设计阶段的工作成果；

b）说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

（7）详细设计说明书

着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

（8）用户手册

详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

（9）操作手册

为操作人员提供软件各种运行情况的有关知识，特别是操作方法的具体细节。

（10）测试计划

针对集成测试和确认测试，需要为组织测试制定计划，包括测试的内容、进度安排、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

（11）测试分析报告

测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。

（12）开发进度月报

a）该月报是软件人员按月向管理部门提交的项目进展情况报告；

b）报告包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法、下个月的打算等。

（13）项目开发总结报告

a）软件项目开发完成以后，应当与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。

b）还需对开发工作作出评价，总结出经验和教训。

文档要求：

针对性、精确性、清晰性、完整性、灵活性。

文档的对号入座：

　　软件文档是在软件生存期中，随着各个阶段工作的展开适时编制的，其中，有的仅仅反映某一个阶段的工作，有的则需要跨越多个阶段。

　　例如项目开发计划、测试计划、用户手册和操作手册就是跨阶段且不断完善的，如上图所示。

各文档读者：

　　综上所述，文档驱动项目，文档让管理制度化、规范化。