软件工程文档介绍大集

一、总介绍

软件工程文档是贯穿整个软件工程生命周期的相关记录，用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。

软件工程文档记录开发过程中的有关信息，提高了开发过程的能见度、开发效率，是开发人员在一定阶段的工作成果和结束的标志，对于管理人员来说，可以把这些记载下来的材料作为检查软件开发进度和开发质量的依据。总之，文档对于软件的开发、运行和维护过程中起着非常重要的作用。

二、分类

1、横向分类

2、纵向分类

三、分类简介

可行性研究报告

1、是什么

可行性研究报告是在开始一项项目之前的必需工作，主要从自然、社会、经济、技术等方面进行调研，综合论证项目建设的必要性，如财务的盈利性、经济上的合理性、技术上的可行性，从而为项目建设提供科学依据的一项综合性的分析方法。

2、主要内容

 

3、预期的读者有项目经理、开发人员、维护人员

 

项目开发计划

1、  是什么

项目开发计划是指在开始新的项目之前所做的相关计划，该计划十分重要，其内容主要是对项目的费用、时间、禁毒人员组织、硬件设备的配置、开发环境和运行环境的配置进行说明。

2、  主要内容

3、  项目开发计划预期的读者是项目经理、开发人员、用户

 

软件需求说明书

1、  是什么

该说明书主要了解用户对软件的需求，对相关项目作出分析，不断与用户进行交流，为开发出用户满意系统做准备。

2、  主要内容

3、  预期读者为开发和维护人员、用户

 

概要设计说明书

1、  是什么

概要设计是从总体上把握系统设计框架，包括模块划分、处理流程和接口设计，概要设计说明书则是对上述内容作总体描述。

2、  主要内容

3、  预期读者为开发人员、维护人员

 

详细设计说明书

1、  是什么

详细设计说明书是在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。

2、  主要内容

3、  预期读者为开发人员、测试人员、维护人员

 

 

数据库设计说明书

1、  是什么

数据库设计说明书是为了让参与本项目的项目主管、业务分析师、项目开发人员、数据库管理人员以及以后的系统维护人员了解本系统的数据设计思路、数据库整体架构及各种详细信息，也为了以后的各个项目可以参与借鉴该项目的经验。

2、  主要内容

3、  预期读者

项目主管、业务分析人员、开发、数据库管理人员、系统维护人员

 

数据要求说明书

1、  是什么

数据要求说明书是对系统中各项功能和非功能性需求实现时所需要的数据并可以此数据为根据设计数据库，同时为概要设计和星系设计人员提供设计依据，其他本项目的开发人员也可参阅。

2、  主要内容

3、  预期读者

项目相关技术和总体方案的管理人员、数据库设计人员及测试人员、项目组

 

测试计划

1、  是什么

测试计划主要是说明各种测试阶段任务、人员分配和时间安排、工作规范。测试计划在策略和方法的高度上说明如何计划、组织和管理测试项目。

2、  主要内容

3、  预期读者为相关测试人员

 

测试分析报告

1、  是什么

测试分析报告是在测试分析的基础上，对测试的结果及测试的数据等加以记录和分析总结。

2、  主要内容

3、  预期读者为项目的开发人员

 

项目开发总结报告

1、  是什么

项目开发总结报告是为了总结报告在工作过程中产生的问题以及总结出的相关经验。

2、  主要内容

3、  预期读者：项目经理、项目开发人员

 

操作手册

1、  是什么

操作手册使相关系统的使用者了解本系统提供的功能，以及如何正确地、有效地来使用这些功能。

2、  主要内容

3、  预期读者：用户、测试人员、培训人员

 

用户手册

1、  是什么

是为了帮助用户更好地了解和使用该软件，用户手册中会讲述怎样安装、配置和使用该软件，以及该软件使用过程中应注意的一些问题。

2、  主要内容

3、  预期读者：用户

 

开发进度月报

1、  是什么

开发进度月报是按照月周期对工程的进度和状态、经费支出与状态、及下个月的工作计划和相关建议进行记录和汇报。

2、  主要内容

3、  预期读者为项目经理、开发人员