软工文档

      一张图胜过多个导图，清晰的介绍了在软件生存周期产生的各个文档。               

                                             

可行性研究报告

目的   说明软件开发项目的实现在技术上、经济上和社会条件上的可行性;论述为达到开发目的而可能选择的各种方案;说明并论证所选定的方案。

内容   引言(编写目的、背景、定义、参考资料等)，可行性研究的前提(要求、目标、条件、假定、限制、进行可行性研究的方法、评价尺度)，对现有系统的分析(数据流程和处理流程、工作负荷、费用开支、人员、设备、局限性)，所建议的系统(对该系统的说明、数据流程和处理流程、改进之处、影响、局限性、技术条件方面的可行性)，可选择的其它系统方案，投资以及收益分析(支出、收益、收益/投资比、投资回收周期、敏感性分析)、社会条件方面的可行性(法律方面的可行性，使用方面的可行性)以及结论。

预期读者  系统管理人员、开发人员和维护人员。

项目开发计划

目的  将开发过程中有关各项工作的负责人员、开发进度、经费预算、软硬件等问题做出的安排记载下来，以便根据本计划开展和检查本项目的开发工作。

内容  引言(编写目的、背景、定义、参考资料等)，项目概述(工作内容、主要参加人员、产品成果、验收标准、完成项目的最迟期限、本计划的审查者与批准者)、实施总计划(工作任务的分解、接口、人员、进度、预算、关键问题)、支持条件(计算机系统的支持、用户承担的工作、外单位提供的条件)和专题计划要点。

预期读者  系统分析员和开发人员

软件需求说明书

目的  使用户和软件开发者双方对软件的初始规定有-一个共同的理解，使之成为整个开发工作的基础。

内容  引言(编写目的、背景、定义、参考资料等)，任务概述(目标、用户的特点、假定与约束)，需求规定(对功能的规定、对性能的规定、输入输出要求、数据管理能力要求、故障处理要求、其他专门要求)和运行环境规定(设备、支撑软件、接口、控制)。

预期读者  用户、项目管理人员、文档编写人员、需求分析人员

概要设计说明书

目的 说明对程序系统的设计考虑，为程序的详细设计提供基础。

内容  引言(编写目的、背景、定义、参考资料等)，总体设计(需求规定、运行环境、基本设计概念和处理流程、结构、功能需求和程序的关系、人工处理过程、尚未解决的问题)，接口设计(用户接口、外部接口、内部接口)、运行设计(运行模块组合、运行控制、运行时间)、系统数据结构设计(逻辑、物理、数据结构设计要电)和系统出错处理设计(出错信息、补救措施、系统维护设计)。

预期读者  项目设计、项目编码人员

详细设计说明书

目的  说明一个软件系统各个层次的每-一个程序(每个模块或者子程序)的设计考虑。

内容  引言(编写目的、背景、定义、参考资料等)，程序系统的组织结构、各程序(标识符)设计说明。

注意  如果软件系统比较简单、层次很少，也可不必单独编写“详细设计说明书”，有关内容可以并入总体设计说明书。

预期读者  程序开发人员和程序测试人员

数据库设计说明书

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

内容  引言(编写目的、背景、定义、参考资料等)，外部设计(标识符和状态、使用它的程序、约定、专门指导、支撑软件)、结构设计(概念、逻辑和物理结构设计)和运用设计(数据字典设计、安全保密设计)。

预期读者  数据库设计师、数据库管理员。

数据要求说明书

目的 向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息。

内容 引言(编写目的、背景、定义、参考资料等)，数据的逻辑描述(静态数据、动态输入数据、动态输出数据、内部生成数据、数据约定)和数据的采集(要求和范围、输入的承担者、处理、影响)。

预期读者 数据库设计人员、系统测试人员

测试计划

目的 提供对该软件的测试计划

内容 引言(编写目的、背景、定义、参考资料等)，计划(软件说明、测试内容、各项测试)、测试设计说明书和评价准则(范围、数据整理、尺度) 

预期读者 系统编程人员和系统测试人员。

测试分析报告

目的 把集成测试和确认测试的结果、发现以及分析写成文件家以记载。

内容 引言、测试概要、测试结果以及发现、对软件功能的分析、分析摘要和测试资源消耗。

预期读者 软件开发人员

用户手册

目的 使用非专门术语，充分描述该软件系统所具有的功能以及基本的使用方法，使用户了解该软件的用途，正确使用它。

内容 引言(编写目的、背景、定义、参考资料等)，用途(功能、性能、安全保密)、运行环境(硬件环境、支撑软件、数据结构)和使用过程(安装与初始化、输入、输出、文卷查询、出错处理与恢复、终端操作)。

预期读者 用户

操作手册

目的 向操作人员提供该软件每-一个运行的具体过程的有关知识，包括操作方法的细节。

内容 引言(编写目的、背景、定义、参考资料等)、软件概述(软件的结构、程序彪、文卷表)、安装与初始化、运行说明(运行彪、运行步骤、说明)、非常规过程和远程操作。

预期读者 用户

开发进度月报

目的  及时向有关管理部门汇报项目开发的进度和情况，以便及时发现和处理开发过程中出现的问题。

内容  标题、工程进度与状况、资源耗用与状态、经费支出与状态、下个月的工作计划以及建议等。

预期读者 软件的开发人员

项目开发总结报告

目的 总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。

内容 引言(编写目的、背景、定义、参考资料等)，实际开发结果(产品、主要功能和性能、基本流程、进度、费用)，开发工作评价(对生产效率、产品质量和技术方法的评价，对出错原因的分析)，经验和教训。

预期读者 软件的开发人员