软件工程实用教程教学课件ppt作者周元哲第12章软件工程文档课件.pptVIP

Tankertanker Design 第12章 软件工程文档 12.1 文档作用 12.2 文档编制原则 12.3 文档分类 文档起着极其重要的作用，具体表现如下所示。 （1） 提高软件开发过程的能见度。通过将软件开发过程中发生的事件以某种可阅读的形式记录在文档中，便于总结。 （2）作为软件开发进度和开发质量的依据。 （3）提高开发效率。文档使得开发人员对各个阶段的工作进行记录，当在发现错误和不一致性，便于及时纠正和维护。 （4）作为软件开发过程中的阶段性工作成果和结束标志。 （5）提供软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作和交流。 文档作用 1 文件的读者 2 重复性 3 精确性、完整性和灵活性 4 可追溯性和必威体育精装版性 文档编制原则 文档大致可分为开发文档、管理文档和用户文档等三类文档。 （1）开发文档是指软件在开发生命周期的不同阶段会产生不同的文档，一般报告可行性研究报告、软件需求说明书、概要设计说明书、详细设计说明书、测试计划、测试分析报告。 （2）管理文档包括项目开发计划、开发进度月报等。 （3）用户文档包括用户手册、操作手册、项目开发总结报告等。 文档分类 可行性研究报告的编写目的是：说明该软件开发项目在技术、经济和社会条件方面的实现可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。 项目开发计划 软件需求说明书，英文是Software Requirements Specification，简称SRS，是分析阶段需要完成的主要文档。 软件需求说明书 概要设计说明书可称作系统设计说明书，对软件系统的设计进行考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为软件的详细设计提供基础 概要设计说明书 在详细设计中，描述实现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系，需要说明软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑，以便进行编码和测试。应当保证软件的需求完全分配给整个软件。详细设计应当足够详细，能够根据详细设计报告进行编码。如果软件产品需要使用到数据库，软件的详细设计应包括对数据库的设计。数据库设计应在软件的需求分析、概要设计完成之后、详细设计的其它工作之前进行。 详细设计说明书 测试计划包括测试的进度安排、测试资料、测试培训，就测试设计说明给出输入、输出、过程信息，测试的评价准则、范围等。 开发者针对单元测试，集成测试，系统测试分别制定《测试计划》。集成测试需要根据需求分析报告和概要设计制作测试用例，并须经过评审。软件测试按照《测试计划》、《需求分析报告》的要求进行，最后形成《软件测试报告》。 测试计划 用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统工程所具有的功能及基本的使用方法，使用户了解该软件的用途。具体的内容包括用途、功能、精度、时间特性、灵活性、安全必威体育官网网址等性能，硬设备、支持软件、数据结构等运行环境；对使用过程从安装与初始化、输入（输入数据的现实背景、输入格式、输入举例）、输出（输出数据的现实背景、输出格式、输出举例）、出错处理与恢复和终端操作等内容。 用户手册 项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。具体内容包括实际开发结果、对生产效率的评价、对产品质量的评价、对技术方法的评价和出错原因的分析等开发工作评价。 项目开发总结报告 Tankertanker Design