软件文档概述.pptVIP

郑州大学信息工程学院 徐婷 软件文档 1-* 软 件 文 档 徐婷 ietxu@zzu.edu.cn Tel:第1章 软件文档概述 1.1 软件文档的定义 1.2 软件文档的地位和作用 1.3 软件文档的分类 1.4 软件文档的使用 1.5 软件文档编制与软件生命周期 1.1 软件文档的定义 什么是文档？ 文档是指某种数据媒体和其中所记录的数据。它具有永久性并可由人或者机器阅读，通常仅用于描述人工可读的东西。 软件工程中，文档常常用来表示活动、需求、过程或结果进行描述、定义、规定、报告或认证的任何书面或图示的信息。 文档是软件产品的一部分。 软件文档是一种重要的软件工程技术资料。 1.1 软件文档的定义 软件 = 程序 + 数据 + 文档 随着计算机科学技术的迅速发展和计算机应用领域的不断扩大，如何高效率开发计算机软件产品越来越受到人们的重视，同时由于软件复杂程度的不断增加，人们对软件产品开发过程的系统化、规范化和标准化的要求也越来越严格。因此软件工程的标准化以及软件文档的规范化已成为影响软件行业发展的重要因素，受到了软件企业的高度重视。 1.2 软件文档的地位和作用 一项软件开发是一个系统工程。从问题的提出到软件开发成功，要经历几个开发阶段，每个开发阶段都要形成阶段性文件。各个阶段的文件都要对下一阶段工作进行宏观控制或对系统软件的开发和使用进行具体指导。 因此，编制软件文档的过程，实际上就是采用软件工程方法，有组织、有计划的科学管理过程和研究开发过程。 一个软件的完成，有赖于许许多多设计思想和巧妙的衔接技术。在一个多人组成的开发小组内，这些“不可见的”设计思想和设计技巧，必须形成“可见的”文档，才有可能成为编写程序的依据。 因此，软件离不开文档。 1.2 软件文档的地位和作用 从软件的定义也可以看出，软件绝不仅仅是单指程序，而是还包括关于程序要达到的系统目标、设计思想、实现方法以及使用维护等内容的一整套详细书面描述和说明，即软件文档。 从某种意义上讲，软件文档甚至比可执行程序代码还重要。缺少必要的软件文档或软件文档不合格，急忙动手编写程序就带有很大的盲目性，将会给软件开发和使用维护带来许多困难，甚至可能导致开发工作的失败。 1.2 软件文档的地位和作用 比如，开发过程缺乏必要的文档进行控制和管理，必将导致修改或增添功能困难，程序错误机会增多，程序结构混乱，程序维护难度大、成本费用高等等。在软件开发后，如果未能满足用户要求，由于没有可行性研究报告和需求分析说明书作依据，还会造成互相扯皮。 所以这里特别强调，文档是软件不可缺少的重要组成部分。 1.2 软件文档的地位和作用 软件文档作为计算机软件的重要组成部分，在软件开发人员、软件管理人员、软件维护人员、用户以及计算机之间起着重要的桥梁作用。 * 维护人员 管理人员 计算机软件 用 户 桥梁作用 开发人员 1.2 软件文档的地位和作用 1. 项目管理的依据 文档将通常“不可见的”软件开发进程转换成“可见的”文字资料，有利于项目的管理。 2. 技术交流的语言 项目小组内部、项目平行开发的各小组之间进行的交流和联系，通常都是通过文档来实现的。 专业技术领域方面的专家负责建立项目；分析员负责阐述系统需求；设计员负责为程序员制定总体设计；程序员负责编制详细的程序代码；质量保证专家和审查员负责评价整个系统性能和功能的完整性：负责维护的程序员负责改进各种操作或增强某些功能。 1.2 软件文档的地位和作用 3. 项目质量保证 文档是进行项目质量审查和评价的重要依据，也是保证软件项目质量的重要技术文档。有效文档的提供，可以满足项目质量保证人员和审查人员的工作需要。 那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰说明。必须制定测试计划和测试规程，并报告测试结果；他们还必须说明和评估、控制、计算、检验例行程序及其他控制技术。 1.2 软件文档的地位和作用 4. 支持培训与维护 合格的软件文档通常都提供有关软件运行、维