1 1第七章第七章 软件维护与软件软件维护与软件文档编制文档编制 1 12 2 软件投入运行后，软件的开发工作已经结束，进入软件的维护阶段软件维护所需的工作量相当大，许多国外的软件开发组织估计，软件维护所占的比例占有软件整个生命周期的60%以上的工作量，随着软件规模和数量的增大，软件维护工作将会束缚开发组织的手脚，使他们没有余力开发新的软件人们对软件维护工作的认识加深后，软件技术服务已经可以独立承包给独立的技术厂商，由专门的技术服务公司进行软件维护，软件开发公司得以继续开发新的软件产品2 23 37.1 7.1 软件维护的内容软件维护的内容 软件维护就是在软件已经交付使用以后，为了改正错误或满足新的需要而修改软件的过程一般来说，要求进行维护的原因大致有以下几种：（1）改正程序中的错误和缺陷2）改进设计以适应新的软、硬件环境3）增加新的应用范围3 34 47.1 7.1 软件维护的内容软件维护的内容 综综合合以以上上几几种种要要求求进进行行维维护护的的原原因因，我我们们可可以以把把软件维护有四种基本形式：软件维护有四种基本形式：（1 1）改改正正性性维维护护：软软件件测测试试不不可可能能找找出出一一个个大大型型软软件件系系统统中中的的所所有有潜潜在在的的软软件件错错误误，所所以以在在软软件件使使用用期期间间仍仍有有可可能能发发现现错错误误，诊诊断断和和改改正正这这类类错错误的过程称为改正性维护；误的过程称为改正性维护；（2 2）适适应应性性维维护护：由由于于计计算算机机技技术术发发展展迅迅速速，计计算算机机硬硬件件设设备备的的不不断断更更新新，计计算算机机操操作作系系统统的的新新版版本本也也会会不不断断出出现现，计计算算机机外外部部设设备备也也要要经经常常改改进进，而而软软件件的的使使用用寿寿命命往往往往超超出出当当时时开开发发该该软软件件系系统统时时设设备备环环境境的的寿寿命命，为为适适应应新新的的变变化化而而要要对对软软件件进进行行的修改，称为适应性维护；的修改，称为适应性维护；4 45 57.1 7.1 软件维护的内容软件维护的内容 （3）完善性维护：软件投入使用后，用户会提出增加新功能，修改已有的功能以及提出一般的改进要求和建议，为了满足和部分满足这类要求，就要进行完善性维护，这类工作较多，占了维护工作的大部分；（4）预防性维护：为了进一步改进软件的维护性和可靠性，或者为进一步改进提供更好的基础而对软件进行的修改，称之为预防性维护；这类工作相对较少。
5 56 67.2 7.2 影响软件维护工作的主要因素影响软件维护工作的主要因素 软软件件维维护护与与进进行行新新软软件件产产品品的的开开发发是是一一对对矛矛盾盾，导导致致软软件件维维护护困困难难的的根根根根源源源源大大多多来来自自软软件件计计划划和和开开发发工作的缺点：工作的缺点：如如果果软软软软件件件件的的的的文文文文档档档档配配配配置置置置不不不不全全全全，会会使使得得维维护护工工作作付付出出很大的代价，因而浪费了精力，挫伤了人的积极性很大的代价，因而浪费了精力，挫伤了人的积极性如如果果使使用用软软软软件件件件工工工工程程程程的的的的方方方方法法法法，软软件件有有一一个个完完整整配配置置，维维护护任任务务就就从从评评价价设设计计文文档档开开始始，确确定定这这个个软软件件的的重重要要结结构构特特性性，性性能能特特性性、接接口口特特性性确确定定软软件件修修改改带带来来的的影影响响，并并找找出出一一些些处处理理方方法法，先先修修改改设设计计，进进行行设设计计复复审审，再再修修改改源源程程序序代代码码，并并利利用用以以前前的的测测试试用用例例进进行行回回归归测测试试，最最后后将将修修改改过过的的软软件件交交付付使用。
使用6 67 77.2 7.2 影响软件维护工作的影响软件维护工作的主要因素主要因素 这种维护方式使维护工作量大大减少，易于维护，而且可以提高软件维护的质量可维护性是指进行软件修改、变更时的难易程度决定可维护性的主要软件质量因素有三方面：可理解性、可测试性、可修改性这些又与可扩充性、一致性、简洁性、清晰性、结构性等因素相关7 78 87.2 7.2 影响软件维护工作的主要因素影响软件维护工作的主要因素 影响软件维护工作的影响软件维护工作的主要因素主要因素主要因素主要因素有：有：n n（1 1）软软件件开开发发的的方方法法：软软件件开开发发方方法法直直接接影影响响软软件件的的易易维维护护性性；模模块块化化结结构构、详详细细设设计计等等文文档档、软软件件维维护护记记录录报报告告等等将将有有助助于于理理解解软软件件的的结结构构、界界面面的的功功能能和和内内部部的的数数据据与与控控制制逻逻辑辑流流程程、理理解解当当前前软软件件的版本状态；的版本状态；n n（2 2）软软件件开开发发的的条条件件：软软件件开开发发过过程程所所涉涉及及到到的的软软硬硬件件资资源源特特性性也也对对软软件件的的维维护护产产生生影影响响，如如程程序序设设计计语语言言的的特特性性、软软件件开开发发工工具具等等对对于于理理解解软软件件有有着着明显的影响；明显的影响；8 89 97.2 7.2 影响软件维护工作的主要因素影响软件维护工作的主要因素 n n（3 3）软软件件规规模模的的大大小小：软软件件规规模模越越大大，系系统统越越复复杂，维护所需的工作量也越大；杂，维护所需的工作量也越大；n n（4 4）软软件件投投入入运运行行后后的的时时间间：老老系系统统比比新新系系统统需需要要更更多多的的维维护护工工作作量量，在在长长期期的的维维护护过过程程中中，也也许许软软件件的的文文档档与与实实际际的的程程序序实实现现已已变变得得不不一一致致，维护工作会遇到更多的困难；维护工作会遇到更多的困难；n n（5 5）其其它它设设计计因因素素、人人员员交交替替与与外外部部环环境境因因素素：开开发发时时，原原来来软软件件的的设设计计对对软软件件维维护护工工作作的的考考虑虑，软软件件外外部部环环境境的的变变化化，人人员员的的交交替替和和管管理理工工作作，都会对软件的维护工作产生影响；都会对软件的维护工作产生影响；9 910107.3 7.3 软件维护的特点软件维护的特点7.3.1 7.3.1 软件工程与软件维护的关系软件工程与软件维护的关系软件工程与软件维护的关系软件工程与软件维护的关系7.3.2 7.3.2 维护成本维护成本维护成本维护成本退出退出退出退出7.3.3 7.3.3 维护的问题维护的问题维护的问题维护的问题101011117.3.1 7.3.1 软件工程与软件维护的关软件工程与软件维护的关系系配置评价设计计划途径修改设计重新编码评价代码？复查重新编码复查维护要求交付使用软件代码11111212无形的维护成本：（1）一些看起来是合理的改错或修改的要求不能及时满足，使得用户不满意；（2）维护时产生的改动，可能会带来新的潜伏的故障，从而降低了软件的整体质量；（3）当必须把软件开发人员抽调去进行维护工作时，将在开发过程中造成混乱。
7.3.2 7.3.2 维护成维护成本本12121313用于软件维护的工作量可以分为两部分：一部分用于生产性活动，另一部分用于非生产性活动下面的表达式是由Belady和Lehman提出的维护工作量的计算模型：MpKe(c d)M：维护中消耗的总工作量；p：生产性工作量；K：经验常数；c：复杂程度；d：维护人员对软件的熟悉程度通过这个模型可以看出，如果使用了不好的软件开发方法，参加维护的人员都不是原来开发的人员，那么维护工作量（及成本）将按指数级增加13131414（1）理解他人编写的程序一般都有一定的困难性2）软件配置的文档严重不足甚至没有，或者没有合格的文档3）当需要对软件进行维护时，由于软件人员经常流动，维护阶段持续的时间又很长，所以一般不能指望由原来的开发人员来完成或提供软件的解释4）绝大多数软件在设计时没有考虑到将来的修改问题5）软件维护可以说是一项毫无吸引力的工作之所以形成这样一种观念，一方面是因为软件维护工作量大，看不到什么“成果”，更主要的原因是因为维护工作难度大，又经常遭受挫折7.3.3 7.3.3 维护的问题维护的问题141415157.4 7.4 软件维护过程软件维护过程7.4.1 7.4.1 7.4.1 7.4.1 维护机构维护机构维护机构维护机构7.4.2 7.4.2 7.4.2 7.4.2 维护申请报告维护申请报告维护申请报告维护申请报告退出退出退出退出7.4.3 7.4.3 7.4.3 7.4.3 维护的工作流程维护的工作流程维护的工作流程维护的工作流程7.4.4 7.4.4 7.4.4 7.4.4 维护记录维护记录维护记录维护记录 7.4.5 7.4.5 7.4.5 7.4.5 维护评价维护评价维护评价维护评价 151516167.4.1 7.4.1 维护机构维护机构系统管理员维护要求维护管理员修改负责人软件系统维护管理员负责接受维护申请，然后把维护申请交给某个系统管理员去评价。
系统管理员是一名技术人员，他必须熟悉软件产品的某一部分系统管理员对维护申请做出评价，然后交与修改负责人确定如何进行修改161617177.4.2 7.4.2 维护申请报告维护申请报告 维维护护申申请请报报告告是是由由软软件件组组织织外外部部提提交交的的文文档档，它它是是计计划划维维护护活活动动的的基基础础软软件件组组织织内内部部应应依依此此制制定相应的软件修改报告，这个报告包括以下内容：定相应的软件修改报告，这个报告包括以下内容：（1 1）为满足某个维护申请要求所需的工作量；）为满足某个维护申请要求所需的工作量；（2 2）所需修改变动的性质；）所需修改变动的性质；（3 3）申请修改的优先级；）申请修改的优先级；（4 4）与修改有关的事后数据与修改有关的事后数据软软件件修修改改报报告告应应提提交交修修改改负负责责人人进进行行审审核核批批准准，以便进行下一步工作以便进行下一步工作171718187.4.3 7.4.3 维护的工作流程维护的工作流程评价错误严重程度改正性确定类型维护要求评价优先次序完善性或适应性开始问题分析严重不严重安排改正性维护错误改正目录开始分析维护任务复审开发目录低高人员安排修改后的软件通过后交付使用的软件人员安排18181919无论是哪一种类型的维护，都要进行以下工作：无论是哪一种类型的维护，都要进行以下工作：（1 1）修改软件设计；）修改软件设计；（2 2）设计复审；）设计复审；（3 3）对源代码的必要修改；）对源代码的必要修改；（4 4）单元测试；）单元测试；（5 5）集成测试，包括回归测试；）集成测试，包括回归测试；（6 6）验收测试；）验收测试；（7 7）软件配置复审。
软件配置复审在每次软件维护任务完成后，需要进行必要的情况评审在每次软件维护任务完成后，需要进行必要的情况评审这种评审是对以下问题的一个小结：这种评审是对以下问题的一个小结：（1 1）在当前情况下，设计、编码、测试中的哪些方面）在当前情况下，设计、编码、测试中的哪些方面能够改进？能够改进？（2 2）哪些维护资源是应该有而实际上却没有的？）哪些维护资源是应该有而实际上却没有的？（3 3）工作中的主要和次要的障碍是什么？）工作中的主要和次要的障碍是什么？（4 4）要求的维护类型中有预防性维护吗？）要求的维护类型中有预防性维护吗？191920207.4.4 7.4.4 维护记录维护记录 对对于于维维护护记记录录中中的的内内容容，SwansonSwanson给给出出了了下下述述的的项目表：项目表：（1 1）程序名称；）程序名称；（2 2）源程序语句条数；）源程序语句条数；（3 3）机器代码指令条数；）机器代码指令条数；（4 4）使用的程序设计语言；）使用的程序设计语言；（5 5）程序的安装日期；）程序的安装日期；（6 6）程序安装后的运行次数；）程序安装后的运行次数；（7 7）与与程程序序安安装装后后运运行行次次数数有有关关的的处处理理故故障障的的次数；次数；20202121（8 8）程序修改的层次和名称；）程序修改的层次和名称；（9 9）由于程序修改而增加的源程序语句条数；）由于程序修改而增加的源程序语句条数；（1010）由于程序修改而删除的源程序语句条数；）由于程序修改而删除的源程序语句条数；（1111）每项修改所付出的）每项修改所付出的“人时人时”数；数；（1212）程序修改的日期；）程序修改的日期；（1313）软件维护人员的姓名；）软件维护人员的姓名；（1414）维护申请报告的名称；）维护申请报告的名称；（1515）维护类型；）维护类型；（1616）维护开始时间和维护结束时间；）维护开始时间和维护结束时间；（1717）用于维护的累计）用于维护的累计“人时人时”数；数；（1818）维护工作的净收益。
维护工作的净收益212122227.4.5 7.4.5 维护评维护评价价 一一般般来来说说，可可以以从从以以下下七七个个方方面面来来评评价价维维护护工工作：作：（1 1）每次程序运行时的平均出错次数；）每次程序运行时的平均出错次数；（2 2）用于每一类维护活动的总）用于每一类维护活动的总“人时人时”数；数；（3 3）每每个个程程序序、每每种种语语言言、每每种种维维护护类类型型所所做做的平均修改数；的平均修改数；（4 4）维维护护过过程程中中，增增加加或或删删除除每每条条源源程程序序语语句句花费的平均花费的平均“人时人时”数；数；（5 5）用于每种语言的平均）用于每种语言的平均“人时人时”数；数；（6 6）一张维护申请报告的平均处理时间；）一张维护申请报告的平均处理时间；（7 7）各类维护类型所占的百分比各类维护类型所占的百分比222223237.5 7.5 软件可维护性软件可维护性7.5.1 7.5.1 7.5.1 7.5.1 软件可维护性的度量软件可维护性的度量软件可维护性的度量软件可维护性的度量7.5.2 7.5.2 7.5.2 7.5.2 提高软件可维护性的方法提高软件可维护性的方法提高软件可维护性的方法提高软件可维护性的方法退退退退 出出出出23232424可以从以下四个方面来度是软件的可维护性：1可理解性 2可测试性 3可修改性 4可移植性7.5.1 7.5.1 软件可维护性的度量软件可维护性的度量242425257.5.2 7.5.2 提高软件可维护性的方法提高软件可维护性的方法 1建立明确的软件质量标准2利用先进的软件技术和工具3建立明确的质量保证制度4选择可维护的程序设计语言5改进软件的文档252526267.6 7.6 软件维护的副作用软件维护的副作用（1 1）对子程序的删除或修改；）对子程序的删除或修改；（2 2）对语句标号的删除或修改；）对语句标号的删除或修改；（3 3）对标识符的删除或修改；）对标识符的删除或修改；（4 4）为改进程序执行性能所做的修改：）为改进程序执行性能所做的修改：（5 5）改变文件的打开或关闭；）改变文件的打开或关闭；（6 6）对逻辑运算符的修改；）对逻辑运算符的修改；（7 7）把设计的修改翻译成程序代码的修改；）把设计的修改翻译成程序代码的修改；（8 8）对判定的边界条件所做的修改。
对判定的边界条件所做的修改为为确确保保编编码码修修改改没没有有引引入入新新的的错错误误，应应进进行行严严格格的的回回归归测测试试一一般般情情况况下下，通通过过回回归归测测试试，可可以以发发现现并并纠纠正正修修改编码所带来的副作用改编码所带来的副作用1 1、修改编码的副作用、修改编码的副作用26262727（1 1）重新定义局部常量或全程常量；）重新定义局部常量或全程常量；（2 2）重新定义记录格式或文件格式；）重新定义记录格式或文件格式；（3 3）改变一个数组或高阶数据结构的大小；）改变一个数组或高阶数据结构的大小；（4 4）修改全程变量；）修改全程变量；（5 5）重新初始化控制标记或指针；）重新初始化控制标记或指针；（6 6）重新排列输入输出或子程序的自变量重新排列输入输出或子程序的自变量修修改改数数据据的的副副作作用用可可以以通通过过完完善善的的设设计计文文档档来来加加以以限限制制这这种种文文档档描描述述了了数数据据结结构构，并并且且提提供供了了一一种种把把数数据据元元素素、记记录录、文文件件及及其其它它结结构构与与软件模块联系起来的交叉对照功能软件模块联系起来的交叉对照功能2 2、修改数据的副作用、修改数据的副作用27272828维维护护应应该该着着眼眼于于整整个个软软件件配配置置，而而不不只只是是源源程程序序代代码码的的修修改改。
如如果果源源代代码码的的修修改改没没有有反反映映在在设设计计文文档档或用户文档中时，就会发生文档的副作用或用户文档中时，就会发生文档的副作用每每当当对对数数据据流流图图、软软件件结结构构、模模块块算算法法过过程程和和其其它它有有关关的的特特征征进进行行修修改改时时，必必须须同同时时对对相相应应的的文文档档资资料进行更新料进行更新在在软软件件再再次次交交付付使使用用之之前前，对对整整个个软软件件配配置置进进行行评评审审将将大大大大减减少少文文档档的的副副作作用用实实际际上上，某某些些维维护护申申请请的的提提出出只只是是由由于于用用户户文文档档不不够够清清楚楚这这时时，只只需需对对文档进行维护即可，并不要求修改软件设计或源程序文档进行维护即可，并不要求修改软件设计或源程序3 3、修改文档的副作用、修改文档的副作用282829297.7 7.7 软件版本控制软件版本控制 利利用用维维护护工工具具进进行行软软件件维维护护，可可以以降降低低维维护护费费用用，提提高高维维护护效效率率比比较较典典型型的的是是版版本本控控制制系系统统，用于协调软件各种版本和配置的生成用于协调软件各种版本和配置的生成版版本本控控制制的的主主要要功功能能有有：存存贮贮、更更新新、检检索索模模块块的的各各个个版版本本；控控制制修修改改权权限限，对对模模块块采采取取保保护护措措施施，仅仅允允许许程程序序员员对对指指定定的的模模块块进进行行修修改改；利利用用版版本本号号、日日期期和和时时间间等等信信息息，系系统统自自动动识识别别装装入入的的模模块块，确确定定正正确确的的代代码码模模块块版版本本；自自动动记记录录对对每每个个模模块块进进行行修修改改的的程程序序员员的的名名字字，记记录录修修改改的的内内容容、时时间和原因等。
可以实现版本的跟踪、恢复和升级间和原因等可以实现版本的跟踪、恢复和升级292930307.8 7.8 软件工程标准中软件工程标准中的文档标准的文档标准 7.8.1 7.8.1 7.8.1 7.8.1 标准化机构与组织标准化机构与组织标准化机构与组织标准化机构与组织 7.8.2 7.8.2 7.8.2 7.8.2 文档的作用文档的作用文档的作用文档的作用 退退退退 出出出出7.8.3 7.8.3 7.8.3 7.8.3 文档的分类和标准文档的分类和标准文档的分类和标准文档的分类和标准 303031317.8.1 7.8.1 标准化机构与组织标准化机构与组织 随随着着软软件件工工程程学学的的发发展展，人人们们对对计计算算机机软软件件的的认认识识逐逐步步深深入入软软件件工工作作的的范范围围从从单单纯纯的的使使用用程程序序设设计计语语言言编编制制程程序序，扩扩展展到到整整个个软软件件生生存存期期在在软软件件产产品品的的开开发发过过程程中中，同同时时产产生生了了许许多多技技术术管管理理工工作作和和确确认认验验证证工工作作，这这些些工工作作常常常常是是跨跨越越软软件件生生存存期期各各个个阶阶段段的的专专门门工工作作，需需要要软软件件行行业业的的标标准准或或规范加以约束。
规范加以约束软软件件工工程程标标准准的的类类型型是是多多方方面面的的，包包括括过过程程标标准准（如如方方法法、技技术术、度度量量等等）、产产品品标标准准（如如需需求求、设设计计、部部件件、描描述述、计计划划、报报告告等等）、专专业业标标准（如术语、表示法、语言等）准（如术语、表示法、语言等）313132327.8.1 7.8.1 标准化机构与组织标准化机构与组织 国国际际标标准准由由国国际际联联合合机机构构制制定定和和公公布布，供供 各各 国国 参参 考考 的的 标标 准准如如 ISOISO（International International Standards Standards OrganizationOrganization）,下下设设许许多多技技术术委委员员会会，其其中中之之一一是是计计算算机机与与信信息息处处理理技技术术委委员员会会，简简称称ISO/TC97,ISO/TC97,负负责责与与计计算算机机有有关关的的标标准准化化工工作作发发布布的的 标标 准准 通通 常常 冠冠 有有 ISOISO字字 样样如如：ISO ISO 8631-86 8631-86 Information Information Processing Processing Program Program Constructs Constructs and and Conventions Conventions for for RepresentationRepresentation信信息息处处理理程程序序构构造造及及其其表表示示法法的的约约定定，该该标标准准已已收收入入中国国家标准。
中国国家标准323233337.8.1 7.8.1 标准化机构与组织标准化机构与组织 国国家家标标准准由由政政府府或或国国家家级级的的机机构构制制定定或或批批准准，适适用用于于全全国国范范围围的的标标准准如如：中中国国国国家家标标准准GB/T GB/T 15538-1995 15538-1995 软软件件工工程程标标准准分分类类法法给给出出了了软软件件工工程程的的严严格格的的分分类类其其中中，GBGB国国家家标标准准，中中华华人人民民共共和和国国国国家家技技术术监监督督局局是是中中国国的的最最高高标标准准化化机机构构，它它所所公公布布实实施施的的标标准准简简称称为为“国国标标”已已批批准准了了多多个个软软件件工工程程标标准准GJBGJB中中华华人人民民共共和和国国家军用标准国国家军用标准333334347.8.1 7.8.1 标准化机构与组织标准化机构与组织 ANSI(American ANSI(American National National Standards Standards Institute)Institute)美国国家标准协会；美国国家标准协会；BS(British Standard)BS(British Standard)英国国家标准；英国国家标准；DIN(Deutsches DIN(Deutsches Institute Institute for for Normung Normung)德德国国标准协会；标准协会；JIS(Japanese JIS(Japanese Industrial Industrial Standard)Standard)日日本本工业标准；工业标准；343435357.8.1 7.8.1 标准化机构与组织标准化机构与组织 许许多多国国家家和和国国际际化化标标准准组组织织制制定定了了软软件件工工程程标标准准。
在在众众多多的的标标准准中中，其其中中有有一一部部分分是是针针对对软软件件文文档档的的标标准准如如：FIPS135FIPS135是是美美国国国国家家标标准准局局发发布布的的软软件件文文档档管管理理指指南南（National National Bureau Bureau of of Standards,Guideline Standards,Guideline for for Software Software Documentation Documentation Management,FIPS Management,FIPS PUB PUB 135,June 135,June 19841984）;其其中中，FIPS(NBS)(Federal FIPS(NBS)(Federal Information Information Processing Processing Standards(National Standards(National Bureau Bureau of of Standards)Standards)美美国国商商务务部部国国家家标标准准局局联联邦邦信信息息处理标准，它所公布的标准均冠有处理标准，它所公布的标准均冠有FIPSFIPS字样。
字样353536367.8.2 7.8.2 文档的作用文档的作用 软件文档：（也称文件资料），指的是一些记录的数据和数据的媒体，具有固定的格式，可被人与计算机阅读，它和计算机程序一起共同构成了能完成特定功能的计算机软件363637377.8.2 7.8.2 文档的作用文档的作用 软件的开发渗透着软件人员的复杂脑力劳动，文档作为软件产品的主要形式集中体现了软件开发人员的劳动成果，现在，没有文档的执行程序是不完整的软件软件的生产和开发工作，总是伴随着大量的信息要记录和使用，因此文档的编制在软件开发工作中占有相当大的工作量，文档在软件生存期中的地位和作用越来越突出了，主要有以下几方面的作用：373738387.8.2 7.8.2 文档的作用文档的作用 （1 1）提提高高软软件件开开发发过过程程的的能能见见度度：把把开开发发过过程程中中发发生生的的事事件件以以某某种种可可以以阅阅读读的的方方式式记记录录在在文文档档中中，管管理理人人员员可可把把这这些些记记载载下下来来的的材材料料作作为为检检查查软软件件开开发发进进度度和和开开发发质质量量的的依依据据，实实现现对对软软件件开开发发工作的管理，文档是软件开发规范的体现和指南；工作的管理，文档是软件开发规范的体现和指南；（2 2）提提高高开开发发效效率率：软软件件文文档档的的编编制制，使使得得开开发发人人员员对对各各个个阶阶段段的的工工作作都都进进行行周周密密的的思思考考、全全面面衡衡量量，从从而而减减少少返返工工。
并并可可在在开开发发的的早早期期发发现现错错误和不一致性，便于及时加以纠正；误和不一致性，便于及时加以纠正；383839397.8.2 7.8.2 文档的作用文档的作用 （3 3）作作为为开开发发人人员员在在一一定定阶阶段段的的工工作作成成果果和和结结束标志；束标志；（4 4）记记录录开开发发过过程程中中的的有有关关信信息息，便便于于协协调以后的软件开发、使用和维护；调以后的软件开发、使用和维护；（5 5）提提供供对对软软件件的的运运行行、维维护护和和培培训训的的有有关关信信息息，便便于于管管理理人人员员、开开发发人人员员、操操作作人人员员、用用户户之之间间的的协协作作、交交流流和和了了解解，使使软软件件开开发发活活动动更更有有效效，起着多种桥梁作用；起着多种桥梁作用；（6 6）便便于于潜潜在在用用户户了了解解软软件件的的功功能能、性性能能等等各各项指标，为他们选购符合自己需要的软件提供依据；项指标，为他们选购符合自己需要的软件提供依据；393940407.8.3 7.8.3 文档的分类和标准文档的分类和标准 按按照照文文档档的的产产生生和和使使用用范范围围，软软件件文文档档大大致致可可分分为三类：为三类：n n开开发发文文档档：作作为为开开发发人人员员前前一一阶阶段段工工作作成成果果的的体体现现和和后后一一阶阶段段工工作作的的依依据据。
包包括括项项目目开开发发计计划划、可可行行性性研研究究报报告告、软软件件需需求求说说明明书书、数数据据要要求求说说明明书书、概概要要设设计计说明书、详细设计说明书、（也可包含源程序文档）；说明书、详细设计说明书、（也可包含源程序文档）；n n管管理理文文档档：由由软软件件开开发发人人员员制制定定的的、需需提提交交管管理理人人员员的的一一些些工工作作计计划划或或工工作作报报告告，使使管管理理人人员员能能够够了了解解软软件件开开发发项项目目安安排排、进进度度、资资源源、使使用用和和成成果果等等包包括括项项目开发计划、测试计划、开发进度月报、项目开发总结；目开发计划、测试计划、开发进度月报、项目开发总结；404041417.8.3 7.8.3 文档的分类和标准文档的分类和标准 n n（3 3）用用户户文文档档：软软件件开开发发人人员员为为用用户户准准备备的的有有关关该该软软件件的的使使用用操操作作和和维维护护的的资资料料，包包括括用用户户手手册册、操操作作手手册、维护修改建议、软件需求说明书等；册、维护修改建议、软件需求说明书等；中中国国已已经经陆陆续续制制定定了了2020余余项项有有关关软软件件工工程程的的国国家家标标准准。
这这些些标标准准可可分分为为四四类类：基基础础标标准准、开开发发标标准准、文文档标准、管理标准档标准、管理标准国家批准的计算机文档标准有：国家批准的计算机文档标准有：GB8567-88 GB8567-88 计算机软件产品开发文件编制指南；计算机软件产品开发文件编制指南；GB9385-88 GB9385-88 计算机需求说明编制指南；计算机需求说明编制指南；GB9386-88 GB9386-88 计算机软件测试编制指南；计算机软件测试编制指南；414142427.9 7.9 软件文档编制的内容软件文档编制的内容 国国家家标标准准局局19881988年年1 1月月发发布布了了计计算算机机软软件件开开发发规规范范和和软软件件产产平平品品开开发发文文件件编编制制指指南南，它它们们基基于于软软件件生生命命期期方方法法，把把软软件件产产品品从从形形成成概概念念开开始始，经经过过开开发发、使使用用、和和不不断断增增补补修修订订，直直到到最最后后被淘汰的整个过程提交的文档归于以下十三种：被淘汰的整个过程提交的文档归于以下十三种：（1 1）可可行行性性研研究究报报告告：说说明明该该软软件件项项目目的的实实现现在在技技术术上上、经经济济上上和和社社会会因因素素上上的的可可行行性性，评评述述如如何何合合理理地地达达到到开开发发目目标标，可可供供选选择择的的各各种种实实现现方方案，说明并论证所选定实施方案的理由；案，说明并论证所选定实施方案的理由；424243437.9 7.9 软件文档编制的内容软件文档编制的内容 （2 2）项项目目开开发发计计划划：为为软软件件项项目目实实施施方方案案制制定定出出具具体体的的计计划划。
应应包包括括各各部部分分工工作作的的负负责责人人员员、开开发发的的进进度度、开开发发的的经经费费概概算算、所所需需的的硬硬件件和和软软件件资资源源等等项项目目开开发发计计划划应应提提供供给给管管理理部部门门，并并作作为为开发阶段评审的基础；开发阶段评审的基础；（3 3）软软件件需需求求说说明明书书：也也称称软软件件规规格格说说明明书书，对对所所开开发发软软件件的的功功能能、性性能能、用用户户界界面面、运运行行环环境境等等作作出出详详细细的的说说明明它它是是用用户户与与开开发发人人员员双双方方对对软软件件需需求求取取得得共共同同理理解解的的基基础础上上达达成成的的协协议议，也也是是实实施开发工作的基础；施开发工作的基础；434344447.9 7.9 软件文档编制的内容软件文档编制的内容 （4 4）数数据据要要求求说说明明书书：该该说说明明书书应应当当给给出出数数据据逻逻辑辑描描述述和和数数据据采采集集的的各各项项要要求求，为为生生成成和和维维护护系统的数据文件作好准备；系统的数据文件作好准备；（5 5）概概要要设设计计说说明明书书：应应当当说说明明系系统统的的功功能能分分配配、模模块块划划分分、系系统统总总体体结结构构、输输入入输输出出及及接接口口设设计计，运运行行设设计计，数数据据结结构构设设计计和和出出错错处处理理设设计计等等，为详细设计奠定基础；为详细设计奠定基础；（6 6）详详细细设设计计说说明明书书：描描述述每每一一个个模模块块是是如如何实现的，包括实现算法和逻辑流程等；何实现的，包括实现算法和逻辑流程等；444445457.9 7.9 软件文档编制的内容软件文档编制的内容 (7)(7)用用户户手手册册：详详细细描描述述软软件件的的功功能能、性性能能和和用户界面，使用户了解该软件和使用该软件；用户界面，使用户了解该软件和使用该软件；(8)(8)操操作作手手册册：为为操操作作人人员员提提供供该该软软件件各各种种运运行情况的细节和有关知识，特别是操作方法的细节；行情况的细节和有关知识，特别是操作方法的细节；(9)(9)测测试试计计划划：针针对对软软件件测测试试（主主要要是是集集成成测测试试和和确确认认测测试试），需需要要制制定定测测试试计计划划，计计划划应应该该包包括括测测试试的的内内容容、进进度度、条条件件、参参加加人人员员、测测试试用用例例的选取原则、测试结果允许的偏差范围等；的选取原则、测试结果允许的偏差范围等；454546467.9 7.9 软件文档编制的内容软件文档编制的内容 (10)(10)测测试试分分析析报报告告：测测试试工工作作完完成成后后，应应当当提提交交测测试试计计划划执执行行情情况况的的说说明明。
对对测测试试结结果果加加以以分分析析，并提出测试的结论性意见；并提出测试的结论性意见；(11)(11)开开发发进进度度月月报报：该该月月报报是是软软件件人人员员按按月月向向管管理理部部门门提提交交的的项项目目进进展展情情况况报报告告应应包包括括进进度度计计划划与与实实际际执执行行情情况况的的比比较较、阶阶段段成成果果、遇遇到到的的问问题题、解决的办法，及下个月的打算等；解决的办法，及下个月的打算等；464647477.9 7.9 软件文档编制的内容软件文档编制的内容 (12)(12)项项目目开开发发总总结结报报告告：软软件件项项目目开开发发完完成成之之后后，应应当当与与项项目目实实施施计计划划对对照照，总总结结实实际际执执行行的的情情况况，如如进进度度、成成果果、资资源源利利用用、成成本本和和投投入入的的人人力力此外，还需对开发工作作出评价，总结经验和教训；此外，还需对开发工作作出评价，总结经验和教训；(13)(13)维维护护修修改改建建议议：软软件件产产品品投投入入运运行行后后，可可能能又又有有修修正正、更更改改等等问问题题，应应当当对对存存在在的的问问题题、修修改改的的考考虑虑，及及修修改改的的影影响响估估计计等等做做详详细细描描述述，写写成成维护修改建议，提交审批。
维护修改建议，提交审批47474848 以上这些文档，在项目开发的各个阶段的工作开展以上这些文档，在项目开发的各个阶段的工作开展时，随之编制，有的在一个阶段进行，有的则需跨越时，随之编制，有的在一个阶段进行，有的则需跨越多个阶段，如图多个阶段，如图7-17-1所示阶段 可行性研 需求 软件 编码与 集成 运行 文档 究与计划 分析 设计 单元测试 测试 维护可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书用户手册操作手册测试计划测试分析报告：开发进度月报项目开发总结报告维护修改建议484849497.10 7.10 文档编制的质量要文档编制的质量要求求 高高质质量量的的文文档档有有助助于于程程序序员员编编制制程程序序、有有助助于于管管理理人人员员监监督督和和管管理理软软件件的的开开发发过过程程、有有助助于于用用户户了了解解软软件件的的工工作作和和运运行行时时正正确确的的操操作作、有有助助于于维维护护人人员员进进行行有有效效的的修修改改和和扩扩充充质质量量差差的的文文档档起起着着相相反反的的作作用用，难难于于理理解解软软件件的的特特性性，给给用用户户造造成成不不便便，而而且且会会削削弱弱对对软软件件的的管管理理，难难于于确确认认和和评评价价开开发发工工作作的的进进展展，如如果果引引起起误误操操作作，甚甚至至造造成成有有害害的的后果。
后果494950507.10 7.10 文档编制的质量要文档编制的质量要求求 造造成成软软件件文文档档编编写写质质量量不不高高的的原原因因有有：缺缺乏乏实实践践经经验验，缺缺乏乏评评价价文文档档质质量量的的标标准准，不不重重视视文文档档的的编编写写工工作作，未未能能合合理理安安排排和和按按时时完完成成文文档档的的编编制制，在在开开发发工工作作接接近近完完成成时时匆匆忙忙赶赶制制文文档档，应应付付了了事事，没有给文档的编写工作以应有的重视没有给文档的编写工作以应有的重视高高质质量量的的文文档档，在在编编写写初初稿稿后后，常常认认真真听听取取意意见见，经经多多次次修修改改，反反复复推推敲敲而而成成，文文档档的的质质量量应应当体现在以下一些方面：当体现在以下一些方面：505051517.10 7.10 文档编制的质量要文档编制的质量要求求 n n（1 1）针针对对性性：文文档档编编制制前前，应应分分清清读读者者对对象象，按按不不同同类类型型、不不同同层层次次的的读读者者分分别别对对待待，以以适适应应他他们们的的需要；面向用户的文档，不应加有过多的专业术语；需要；面向用户的文档，不应加有过多的专业术语；n n（2 2）精精确确性性：文文档档的的行行文文应应当当十十分分准准确确，不不能能出出现现多多义义性性的的描描述述；同同一一项项目目若若干干文文档档的的内内容容应应该该协协调调一致，没有矛盾；一致，没有矛盾；n n（3 3）清清晰晰性性：文文档档编编写写力力求求简简明明。
如如有有可可能能，配配以适当图表，增强清晰性；以适当图表，增强清晰性；n n（4 4）完完整整性性：任任何何一一个个文文档档都都应应是是独独立立完完整整的的，自自成成体体系系的的，允允许许必必要要的的部部分分重重复复，避避免免出出现现转转引引其其它文档内容的情况；它文档内容的情况；515152527.10 7.10 文档编制的质量要文档编制的质量要求求 n n（5 5）灵灵活活性性：各各个个不不同同的的软软件件项项目目，其其规规模模和和复复杂杂程程度度有有许许多多实实际际差差别别，不不能能千千篇篇一一律律看看待待对对于于较较小小的的比比较较简简单单的的项项目目，可可做做适适当当调调整整或或合合并并例例如如：将将用用户户手手册册与与操操作作手手册册合合并并成成用用户户操操作作手手册册，软软件件需需求求说说明明可可包包含含对对数数据据的的要要求求，从从而而去去掉掉数数据据要要求求说说明明书书，将将概概要要设设计计说说明明书书与与详详细细设设计计说说明明书书合并成软件设计说明书等；合并成软件设计说明书等；n n（6 6）可可追追朔朔性性：各各开开发发阶阶段段编编制制的的文文档档与与各各阶阶段段完完成成的的工工作作密密切切相相关关，前前后后两两个个阶阶段段的的文文档档，具具有有一一定定的的继继承承关关系系。
同同一一项项目目各各开开发发阶阶段段之之间间提提供供的文档必定存在着可追朔的关系，需要时能够追踪的文档必定存在着可追朔的关系，需要时能够追踪525253537.11 7.11 文档的管理和维护文档的管理和维护 在在整整个个软软件件开开发发过过程程，软软件件生生命命期期内内，各各种种文文档档作作为为半半成成品品或或最最后后的的成成品品，会会不不断断的的生生成成、修修改改或或补补充充为为了了最最终终得得到到高高质质量量的的产产品品，必必须须加加强强对文档的管理注意以下方面：对文档的管理注意以下方面：（1 1）软软件件开开发发小小组组应应设设有有一一位位文文档档保保管管人人员员，负负责责集集中中保保管管本本项项目目已已有有的的两两套套文文档档的的两两套套主主文文本本，内容一致，其中一套可按一定的手续借阅；内容一致，其中一套可按一定的手续借阅；（2 2）软软件件开开发发小小组组可可根根据据需需要要自自己己保保存存一一些些文文档档，是是主主文文本本的的复复制制品品，并并注注意意和和主主文文本本保保持持一一致，做必要修改时，应先修改主文本；致，做必要修改时，应先修改主文本；535354547.11 7.11 文档的管理和维护文档的管理和维护 （3 3）开开发发人人员员个个人人只只保保存存与与他他工工作作有有关关的的部部分文档；分文档；（4 4）当当新新文文档档取取代代旧旧文文档档时时，管管理理人人员员应应及及时注销旧文档。
及时反映更新的内容时注销旧文档及时反映更新的内容5 5）项项目目开开发发结结束束时时，文文档档管管理理人人员员应应收收回回开开发发人人员员的的个个人人文文档档当当发发现现个个人人文文档档与与主主文文档档有有差别时，应立即解决差别时，应立即解决6 6）开开发发软软件件时时，可可能能有有时时需需要要修修改改已已完完成成的的文文档档对对于于较较大大规规模模的的项项目目，修修改改必必须须特特别别谨谨慎慎，充充分分估估计计可可能能带带来来的的影影响响，并并应应按按照照提提议议、评评议议、审核、批准及实施等步骤进行，加以严格控制审核、批准及实施等步骤进行，加以严格控制545455557.11 7.11 文档的管理和维护文档的管理和维护 在在软软件件开开发发的的不不同同阶阶段段可可以以使使用用不不同同的的工工具具，如如：计计划划工工具具（可可用用一一般般的的文文本本编编辑辑工工具具完完成成），系系统统需需求求分分析析工工具具（SADT,SREM,PSL/PSA SADT,SREM,PSL/PSA 等等），总总体体设设计计工工具具（SADTSADT）编编码码工工具具(各各种种集集成成开开发发环环境境)，测测试试工工具具（PETPET），维维护护工工具具(SPD),(SPD),文文档档跟跟踪踪工工具具(青青鸟鸟环环境境的的DAT/T)DAT/T)等等，也也可可建建立立数数据据库库，维维护护系统开发过程的大量信息。
系统开发过程的大量信息55555656习题七 1软件维护有哪几种基本形式？2影响软件维护工作的主要因素有哪些？3 软件文档的形式有哪几类？具体的各个软件文档与开发各阶段关系如何？56565757习题七 1软件维护有哪几种基本形式？2影响软件维护工作的主要因素有哪些？3 软件文档的形式有哪几类？具体的各个软件文档与开发各阶段关系如何？57575858习题七 1软件维护有哪几种基本形式？2影响软件维护工作的主要因素有哪些？3 软件文档的形式有哪几类？具体的各个软件文档与开发各阶段关系如何？58585959习题七 1软件维护有哪几种基本形式？2影响软件维护工作的主要因素有哪些？3 软件文档的形式有哪几类？具体的各个软件文档与开发各阶段关系如何？5959。