软件文档概述ppt课件

1、软 件 文 档徐婷: 38597011郑州大学信息工程学院 徐婷软件文档1-2第第1章章 软件文档概述软件文档概述1.1 1.1 软件文档的定义软件文档的定义1.2 1.2 软件文档的位置和作用软件文档的位置和作用1.3 1.3 软件文档的分类软件文档的分类1.4 1.4 软件文档的运用软件文档的运用1.5 1.5 软件文档编制与软件生命周期软件文档编制与软件生命周期郑州大学信息工程学院 徐婷软件文档1-31.1 1.1 软件文档的定义软件文档的定义 什么是文档？什么是文档？ 文档是指某种数据媒体和其中所记文档是指某种数据媒体和其中所记录的数据。它具有永久性并可由人或者

2、机录的数据。它具有永久性并可由人或者机器阅读，通常仅用于描画人工可读的东西。器阅读，通常仅用于描画人工可读的东西。 软件工程中，文档经常用来表示活软件工程中，文档经常用来表示活动、需求、过程或结果进展描画、定义、动、需求、过程或结果进展描画、定义、规定、报告或认证的任何书面或图示的信规定、报告或认证的任何书面或图示的信息。息。 文档是软件产品的一部分。文档是软件产品的一部分。 软件文档是一种重要的软件工程软件文档是一种重要的软件工程技术资料。技术资料。郑州大学信息工程学院 徐婷软件文档1-41.1 1.1 软件文档的定义软件文档的定义 软件软件 = = 程序程序 + + 数据数据 + + 文档

3、文档 随着计算机科学技术的迅速随着计算机科学技术的迅速开展和计算机运用领域的不断扩展，如何开展和计算机运用领域的不断扩展，如何高效率开发计算机软件产品越来越遭到人高效率开发计算机软件产品越来越遭到人们的注重，同时由于软件复杂程度的不断们的注重，同时由于软件复杂程度的不断添加，人们对软件产品开发过程的系统化、添加，人们对软件产品开发过程的系统化、规范化和规范化的要求也越来越严厉。因规范化和规范化的要求也越来越严厉。因此软件工程的规范化以及软件文档的规范此软件工程的规范化以及软件文档的规范化已成为影响软件行业开展的重要要素，化已成为影响软件行业开展的重要要素，遭到了软件企业的高度注重。遭到了软件企

4、业的高度注重。郑州大学信息工程学院 徐婷软件文档1-51.2 1.2 软件文档的位置和作用软件文档的位置和作用 一项软件开发是一个系统工程。从问题的提一项软件开发是一个系统工程。从问题的提出到软件开发胜利，要阅历几个开发阶段，每个出到软件开发胜利，要阅历几个开发阶段，每个开发阶段都要构成阶段性文件。各个阶段的文件开发阶段都要构成阶段性文件。各个阶段的文件都要对下一阶段任务进展宏观控制或对系统软件都要对下一阶段任务进展宏观控制或对系统软件的开发和运用进展详细指点。的开发和运用进展详细指点。 因此，编制软件文档的过程，实践上就是采因此，编制软件文档的过程，实践上就是采用软件工程方法，有组织、有方案

5、的科学管理过用软件工程方法，有组织、有方案的科学管理过程和研讨开发过程。程和研讨开发过程。郑州大学信息工程学院 徐婷软件文档1-6 一个软件的完成，有赖于许许一个软件的完成，有赖于许许多多设计思想和巧妙的衔接技术。在一个多多设计思想和巧妙的衔接技术。在一个多人组成的开发小组内，这些多人组成的开发小组内，这些“不可见的不可见的设计思想和设计技巧，必需构成设计思想和设计技巧，必需构成“可见可见的文档，才有能够成为编写程序的根据。的文档，才有能够成为编写程序的根据。 因此，软件离不开文档。因此，软件离不开文档。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档

6、1-7 从软件的定义也可以看出，软件绝不仅仅是从软件的定义也可以看出，软件绝不仅仅是单指程序，而是还包括关于程序要到达的系统目单指程序，而是还包括关于程序要到达的系统目的、设计思想、实现方法以及运用维护等内容的的、设计思想、实现方法以及运用维护等内容的一整套详细书面描画和阐明，即软件文档。一整套详细书面描画和阐明，即软件文档。 从某种意义上讲，软件文档甚至比可执行程从某种意义上讲，软件文档甚至比可执行程序代码还重要。短少必要的软件文档或软件文档序代码还重要。短少必要的软件文档或软件文档不合格，急忙动手编写程序就带有很大的盲目性，不合格，急忙动手编写程序就带有很大的盲目性，将会给软件开发和运用维

7、护带来许多困难，甚至将会给软件开发和运用维护带来许多困难，甚至能够导致开发任务的失败。能够导致开发任务的失败。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-8 比如，开发过程缺乏必要的文档进展控制和比如，开发过程缺乏必要的文档进展控制和管理，必将导致修正或增添功能困难，程序错误管理，必将导致修正或增添功能困难，程序错误时机增多，程序构造混乱，程序维护难度大、本时机增多，程序构造混乱，程序维护难度大、本钱费用高等等。在软件开发后，假设未能满足用钱费用高等等。在软件开发后，假设未能满足用户要求，由于没有可行性研讨报告和需求分析阐户要求，由于没有可行性

8、研讨报告和需求分析阐明书作根据，还会呵斥相互扯皮。明书作根据，还会呵斥相互扯皮。 所以这里特别强调，文档是软件不可短少的所以这里特别强调，文档是软件不可短少的重要组成部分。重要组成部分。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-9软件文档作为计算机软件的重要组成部分，在软件文档作为计算机软件的重要组成部分，在软件开发人员、软件管理人员、软件维护人员、软件开发人员、软件管理人员、软件维护人员、用户以及计算机之间起着重要的桥梁作用。用户以及计算机之间起着重要的桥梁作用。9维护人员管理人员计算机软件用 户桥梁作用开发人员1.2 1.2 软件文档的位

9、置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-101. 工程管理的根据工程管理的根据 文档将通常文档将通常“不可见的软件开发进程转换不可见的软件开发进程转换成成“可见的文字资料，有利于工程的管理。可见的文字资料，有利于工程的管理。2. 技术交流的言语技术交流的言语 工程小组内部、工程平行开发的各小组工程小组内部、工程平行开发的各小组之间进展的交流和联络，通常都是经过文档来之间进展的交流和联络，通常都是经过文档来实现的。实现的。 专业技术领域方面的专家担任建立工程；专业技术领域方面的专家担任建立工程；分析员担任论述系统需求；设计员担任为程序分析员担任论述系统需求；设计员担任为

10、程序员制定总体设计；程序员担任编制详细的程序员制定总体设计；程序员担任编制详细的程序代码；质量保证专家和审查员担任评价整个系代码；质量保证专家和审查员担任评价整个系统性能和功能的完好性：担任维护的程序员担统性能和功能的完好性：担任维护的程序员担任改良各种操作或加强某些功能。任改良各种操作或加强某些功能。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-113. 工程质量保证工程质量保证 文档是进展工程质量审查和评价的重要根文档是进展工程质量审查和评价的重要根据，也是保证软件工程质量的重要技术文档。据，也是保证软件工程质量的重要技术文档。有效文档的提供

11、，可以满足工程质量保证人员有效文档的提供，可以满足工程质量保证人员和审查人员的任务需求。和审查人员的任务需求。 那些担任软件质量保证和评价系统性能的那些担任软件质量保证和评价系统性能的人员需求程序规格阐明、测试和评价方案、测人员需求程序规格阐明、测试和评价方案、测试该系统用的各种质量规范以及关于期望系统试该系统用的各种质量规范以及关于期望系统完成什么功能和系统怎样实现这些功能的明晰完成什么功能和系统怎样实现这些功能的明晰阐明。必需制定测试方案和测试规程，并报告阐明。必需制定测试方案和测试规程，并报告测试结果；他们还必需阐明和评价、控制、计测试结果；他们还必需阐明和评价、控制、计算、检验例行程序

12、及其他控制技术。算、检验例行程序及其他控制技术。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-124. 支持培训与维护支持培训与维护 合格的软件文档通常都提供有关软件运转、合格的软件文档通常都提供有关软件运转、维护和培训的必要信息，支持软件产品的运用维护和培训的必要信息，支持软件产品的运用和维护。和维护。5. 支持软件维护支持软件维护 软件文档提供系统开发的全部必要技术资软件文档提供系统开发的全部必要技术资料，有利于维护人员熟习系统，开展维护任务；料，有利于维护人员熟习系统，开展维护任务；软件维护文档记载了软件维护过程中软件及其软件维护文档记载了

13、软件维护过程中软件及其环境变化的全部信息。环境变化的全部信息。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-136. 记载软件历史记载软件历史 软件文档作为软件文档作为“记载软件历史的言语，可记载软件历史的言语，可用作未来工程的一种资源，向潜在用户报道软用作未来工程的一种资源，向潜在用户报道软件的各种有利信息，便于他们判别本人能否需件的各种有利信息，便于他们判别本人能否需求该软件提供的效力。求该软件提供的效力。 良好的系统文档，显然有助于完成软件的良好的系统文档，显然有助于完成软件的移植，或将软件转移到各种新的系统环境中去。移植，或将软件转移到各

14、种新的系统环境中去。1.2 1.2 软件文档的位置和作用软件文档的位置和作用郑州大学信息工程学院 徐婷软件文档1-14 软件文档可以用自然言语、特别设计的方软件文档可以用自然言语、特别设计的方式言语、介于两者之间的半方式言语式言语、介于两者之间的半方式言语(构造化言构造化言语语)、各类图形或表格等方法进展编制。、各类图形或表格等方法进展编制。 文档可以书写编制，也可以利用计算机支文档可以书写编制，也可以利用计算机支持系统辅助编制，但必需方便阅读。持系统辅助编制，但必需方便阅读。 国家规范局在国家规范局在1988年年1月公布了月公布了和和，作为软件开发和文档编制任务的准那么和，作为软件开发和文档

15、编制任务的准那么和规程。规程。 1.3 1.3 软件文档的分类软件文档的分类郑州大学信息工程学院 徐婷软件文档1-15l软件文档从方式上来看，大致可分为两类：软件文档从方式上来看，大致可分为两类：l一类是开发过程中填写的各种图表，称之为任一类是开发过程中填写的各种图表，称之为任务表格；务表格；l一类是应编制的技术资料或技术管理资料，称一类是应编制的技术资料或技术管理资料，称之为文档或文件。之为文档或文件。l按照文档产生和运用的范围，软件文档可分为：按照文档产生和运用的范围，软件文档可分为：l开发文档开发文档l用户文档用户文档l管理文档管理文档1.3 1.3 软件文档的分类软件文档的分类郑州大学

16、信息工程学院 徐婷软件文档1-161.3 1.3 软件文档的分类软件文档的分类16软件文档开发文档用户文档管理文档郑州大学信息工程学院 徐婷软件文档1-17l开发文档开发文档l开发文档主要担任对软件开发过程本身进展描开发文档主要担任对软件开发过程本身进展描画和规范。画和规范。l包括可行性研讨报告、工程开发方案、软件需包括可行性研讨报告、工程开发方案、软件需求阐明书、数据库设计阐明书、概要设计阐明求阐明书、数据库设计阐明书、概要设计阐明书、详细设计阐明书等文档，也包括软件的详书、详细设计阐明书等文档，也包括软件的详细技术描画细技术描画(程序逻辑、程序间相互关系、数程序逻辑、程序间相互关系、数据格

17、式和存储等据格式和存储等)。1.3 1.3 软件文档的分类软件文档的分类郑州大学信息工程学院 徐婷软件文档1-18l开发文档开发文档l开发文档主要有以下开发文档主要有以下5方面的作用：方面的作用：l 它们是软件开发过程中各个阶段之间的通它们是软件开发过程中各个阶段之间的通讯工具，它们记录生成软件需求、设计、编码讯工具，它们记录生成软件需求、设计、编码和测试的详细规定和阐明。和测试的详细规定和阐明。l 它们描画开发小组的职责。经过规定软件、它们描画开发小组的职责。经过规定软件、主题事项、文档编制、质量保证人员，以及包主题事项、文档编制、质量保证人员，以及包含在开发过程中任何其他事项的角色来定义含

18、在开发过程中任何其他事项的角色来定义“如如何做和何做和“何时做。何时做。l 它们用作检验点而允许管理者评定开发进它们用作检验点而允许管理者评定开发进度。假设开发文档丧失、不完好或过时，管理度。假设开发文档丧失、不完好或过时，管理者将失去跟踪和控制软件工程的一个重要工具。者将失去跟踪和控制软件工程的一个重要工具。l 它们构成了维护人员所要求的根本的软件它们构成了维护人员所要求的根本的软件支持文档。而这些支持文档可作为产品文档的支持文档。而这些支持文档可作为产品文档的一部分。一部分。l 它们记录软件开发的历史。它们记录软件开发的历史。1.3 1.3 软件文档的分类软件文档的分类郑州大学信息工程学院

19、 徐婷软件文档1-19l用户文档用户文档l用户文档主要担任对软件产品的运用、维护等用户文档主要担任对软件产品的运用、维护等信息进展描画，包括用户手册、操作手册、软信息进展描画，包括用户手册、操作手册、软件需求阐明书、数据要求阐明书等文档。件需求阐明书、数据要求阐明书等文档。l用户文档主要有以下作用：用户文档主要有以下作用：l 为运用和运转软件产品的客户提供培训为运用和运转软件产品的客户提供培训和参考信息；和参考信息；l 为那些未参与开发本软件的程序员维护为那些未参与开发本软件的程序员维护它提供信息；它提供信息；l 促进软件产品的市场流通或提高可接受促进软件产品的市场流通或提高可接受性。性。1.

20、3 1.3 软件文档的分类软件文档的分类郑州大学信息工程学院 徐婷软件文档1-201.3 1.3 软件文档的分类软件文档的分类l用户文档用户文档l 用户文档适用于以下类型的读者：用户文档适用于以下类型的读者：l用户：他们利用软件输入数据、检索信息和处用户：他们利用软件输入数据、检索信息和处理问题。理问题。l运转者：他们在计算机系统上运转软件。运转者：他们在计算机系统上运转软件。l维护人员：他们维护、加强或变卦软件。维护人员：他们维护、加强或变卦软件。l 用户文档包括如下内容：用户文档包括如下内容：l用于管理者的指南和资料。用于管理者的指南和资料。l宣传资料：通告软件产品的可用性并详细阐明宣传资

21、料：通告软件产品的可用性并详细阐明它的功能、运转环境等。它的功能、运转环境等。l普通讯息：对任何有兴趣的人描画软件产品。普通讯息：对任何有兴趣的人描画软件产品。郑州大学信息工程学院 徐婷软件文档1-21l管理文档管理文档l管理文档主要担任对软件工程开发过程的管理管理文档主要担任对软件工程开发过程的管理以及信息的描画，包括工程开发方案、模块开以及信息的描画，包括工程开发方案、模块开发卷宗、开发进度月报、测试方案、测试分析发卷宗、开发进度月报、测试方案、测试分析报告、工程开发总结报告等文档。报告、工程开发总结报告等文档。l管理文档主要有以下作用：管理文档主要有以下作用：l 开发过程的每个阶段的进度

22、和进度变卦的开发过程的每个阶段的进度和进度变卦的记录；记录；l 软件变卦情况的记录：软件变卦情况的记录：l 相对于开发的断定记录；相对于开发的断定记录；l 职责定义。职责定义。1.3 1.3 软件文档的分类软件文档的分类郑州大学信息工程学院 徐婷软件文档1-221.4 1.4 软件文档的运用软件文档的运用22软件文档的运用对象开发人员维护人员管理人员用 户 软件开发中产生的各类文软件开发中产生的各类文档面向不同的运用对象，同时，档面向不同的运用对象，同时，软件用户应该得到的文档种类软件用户应该得到的文档种类也应在供应者与用户之间签署也应在供应者与用户之间签署的合同中明确规定。的合同中明确规定。

23、郑州大学信息工程学院 徐婷软件文档1-23 一个计算机软件，从构思之日起，经过软件开发胜利一个计算机软件，从构思之日起，经过软件开发胜利并投入运用，直到最后决议停顿运用，并被另一个软并投入运用，直到最后决议停顿运用，并被另一个软件替代之时止，被以为是该软件的一个生存周期。件替代之时止，被以为是该软件的一个生存周期。 普通，软件生存周期可以分成以下普通，软件生存周期可以分成以下6个阶段：个阶段： 可行性研讨与方案阶段可行性研讨与方案阶段 需求分析阶段需求分析阶段 设计阶段设计阶段 实现阶段实现阶段 测试阶段测试阶段 运转与维护阶段。运转与维护阶段。 1.5 1.5 软件文档编制与软件生命周期软件

24、文档编制与软件生命周期郑州大学信息工程学院 徐婷软件文档1-24 软件文档的编制是随着软件生存期各个阶段任务软件文档的编制是随着软件生存期各个阶段任务的开展而适时进展的。其中，有的仅反映某一阶段的的开展而适时进展的。其中，有的仅反映某一阶段的任务，有的那么需求跨越多个阶段的任务。任务，有的那么需求跨越多个阶段的任务。 在可行性研讨与方案阶段内，要确定该软件的开发目在可行性研讨与方案阶段内，要确定该软件的开发目的和总的要求，要进展可行性分析、投资的和总的要求，要进展可行性分析、投资收益分析收益分析、制定开发方案，并完成应编制的文档。、制定开发方案，并完成应编制的文档。 在需求分析阶段内，由系统分

25、析人员对被设计的系统在需求分析阶段内，由系统分析人员对被设计的系统进展系统分析，确定对该软件的各项功能、性能需求进展系统分析，确定对该软件的各项功能、性能需求和设计约束，确定对文档编制的要求，作为本阶段任和设计约束，确定对文档编制的要求，作为本阶段任务的结果，普通来说，软件需求阐明书、数据要求阐务的结果，普通来说，软件需求阐明书、数据要求阐明书和初步的用户手册应该编写出来。明书和初步的用户手册应该编写出来。 1.5 1.5 软件文档编制与软件生命周期软件文档编制与软件生命周期郑州大学信息工程学院 徐婷软件文档1-25p 在设计阶段内，系统设计人员和程序设计人员应该在设计阶段内，系统设计人员和程

26、序设计人员应该在反复了解软件需求的根底上，提出多个设计，分析在反复了解软件需求的根底上，提出多个设计，分析每个设计能履行的功能并进展相互比较，最后确定一每个设计能履行的功能并进展相互比较，最后确定一个设计，包括该软件的构造、模块的划分、功能的分个设计，包括该软件的构造、模块的划分、功能的分配以及处置流程。在被设计系统比较复杂的情况下，配以及处置流程。在被设计系统比较复杂的情况下，设计阶段应分解成概要设计阶段和详细设计阶段。在设计阶段应分解成概要设计阶段和详细设计阶段。在普通情况下，应完成的文档包括概要设计阐明书、详普通情况下，应完成的文档包括概要设计阐明书、详细设计阐明书和测试方案初稿。细设计

27、阐明书和测试方案初稿。1.5 1.5 软件文档编制与软件生命周期软件文档编制与软件生命周期郑州大学信息工程学院 徐婷软件文档1-26p 在实现阶段内，要完成源程序的编码、编译在实现阶段内，要完成源程序的编码、编译(或汇编或汇编)和排错调试，得到无语法错误的程序清单，要开场编和排错调试，得到无语法错误的程序清单，要开场编写模块开发卷宗，并且要完成用户手册、操作手册等写模块开发卷宗，并且要完成用户手册、操作手册等面向用户的文档编写任务，还要完成测试方案的编制面向用户的文档编写任务，还要完成测试方案的编制。p 在测试阶段，程序将被全面地测试，已编制的文档在测试阶段，程序将被全面地测试，已编制的文档将被检查审阅。普通要完成模块开发卷宗和测试分析将被检查审阅。普通要完成模块开发卷宗和测试分析报告，作为开发任务的终了，所产生的程序、文档以报告，作为开发任务的终了，所产生的程序、文档以及开发任务本身将逐项被评价，最后写出工程开发总及开发任务本身将逐项被评价，最后写出工程开发总结报告。结报告。1.5 1.5 软件文档编制与软件生命