《软件用户文档精.ppt》由会员分享，可在线阅读，更多相关《软件用户文档精.ppt（34页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、软件用户文档软件用户文档软件用户文档软件用户文档第1页，本讲稿共34页2023/2/2417.1 7.1 软件用户文档软件用户文档 用用户户文文档档是是软软件件开开发发人人员员为为软软件件用用户户了了解解、使使用用、操操作作和和维维护护等等提提供供的的详详细细资资料料。用户文档包括用户手册、操作手册和维护修改建议等。用户文档包括用户手册、操作手册和维护修改建议等。7.1 7.1 编制用户文档的基本要求编制用户文档的基本要求1.1.描述规范准确描述规范准确 用用户户文文档档的的阅阅读读对对象象通通常常是是非非计计算算机机专专业业的的人人员员，因因此此对对用用户户有有很很强强的的实实用用和和指指导
2、导意意义义。要要求求在在描描述述内内容容、说说明明方方法法、提提出出见见解解时时都都应应准准确确无无误误，恰恰如如其其分分。文文档档需需要要反反映映哪哪些些内内容容、如如何何描描述述、口口气气、分分寸寸等等，都都应应与与编编制制目目的的、使使用用对对象象协协调调一致。用词应标准、统一、规范。一致。用词应标准、统一、规范。2.2.叙述简练生动叙述简练生动 用用户户文文档档应应简简洁洁、精精炼炼，少少用用用用户户难难懂懂的的专专业业术术语语，并并力力求求形形象象生生动动、图图文文并并茂茂，便便于于用用户户学学习习、理理解和掌握软件的使用、操作。解和掌握软件的使用、操作。3.3.语言严密平实语言严密
3、平实 用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。4.4.内容系统完整内容系统完整 用用户户文文档档作作为为软软件件系系统统开开发发者者和和用用户户之之间间的的界界面面，应应能能提提供供给给用用户户关关于于软软件件整整体体结结构构、功功能能、安安装装、运运行行和和操操作作的的有有关关知知识识，并并且且用用户户文文档档的的内内容容组组织织应应该该有有系系统统性性、层层次次性性，使使之之成成为为软软件件使使用用、操作的清晰的操作的清晰的“交通图交通图”。2023/2/242 2第2页，本
4、讲稿共34页7.2 7.2 软件常用表示形式软件常用表示形式 软软件件的的表表示示方方法法为为软软件件系系统统建建立立一一个个基基本本构构架架，对对理理解解软软件件，特特别别是是对对于于软软件件的的维维护护，将是非常重要的。将是非常重要的。1.1.容器模型容器模型 基于一个共享数据库的系统模型一般称为容器模型。基于一个共享数据库的系统模型一般称为容器模型。如如果果系系统统的的工工作作所所使使用用的的数数据据是是围围绕绕共共享享数数据据库库进进行行的的，这这可可以以考考虑虑采采用用容器模型来表达其系统结构。下图是一种集成容器模型来表达其系统结构。下图是一种集成CASECASE工具集的体系结构。工
5、具集的体系结构。设计编辑器设计编辑器代码生成器代码生成器设计分析器设计分析器报告生成器报告生成器程序编辑器程序编辑器设计转换器设计转换器项目存储项目存储 在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。2023/2/243 3第3页，本讲稿共34页2.2.客户机客户机/服务器模型服务器模型 这这个个模模型型用用于于表表示示一一个个分分布布式式系系统统，说说明明数数据据和和加加工工过过程程在在多多个个处处理理器器之之间间的的分分配配。其例子如下图所示。其例子如下图所示。用户用户用户用户用户用户用户接口客户进程用户接口客户
6、进程用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程多媒体数据库服务器及中间件多媒体数据库服务器及中间件图像图像服务器服务器视频视频服务器服务器声音声音服务器服务器文本文本服务器服务器图像图像数据库数据库视频视频数据库数据库声音声音数据库数据库文本文本数据库数据库2023/2/244 4第4页，本讲稿共34页3.3.抽象机模型抽象机模型 抽象机模型，也称分层模型，常用来表示子下图的接口模型。抽象机模型，也称分层模型，常用来表示子下图的接口模型。将将下下图图组组织织成成一一系系列列的的层层次次，每每一一层层次次定定义义一一组组服服务务。一一个个著著名名的的例例子子是是网网络络协协
7、议议OSIOSI参考模型。参考模型。下图是一个版本管理下图的抽象机模型的结构示例。下图是一个版本管理下图的抽象机模型的结构示例。4.4.接口描述接口描述 大大型型系系统统总总是是分分解解成成独独立立开开发发的的一一些些子子系系统统。因因此此，在在软软件件描描述述中中的的一一个个必必要要成成分分就就是定义子系统接口。接口的示意如下图。是定义子系统接口。接口的示意如下图。子系统子系统A子系统子系统B2023/2/245 5第5页，本讲稿共34页 接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员
8、函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。或成员函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。Class1-用于接口数据成员用于接口数据成员-其它数据成员其它数据成员Class2+用于接口的成员函数用于接口的成员函数()()+其它成员函数其它成员函数()()Class3Class4interface接口对象接口对象Class5 接口描述主要包括三方面信息：接口描述主要包括三方面信息：-类型名：即一组对象的名字类型名：即一组对象的名字-接口语法：定义接口操作的名字、参数个数、参数类型及操作结果类型接口语法：定义接口操作的名字、参数个数、参数类型及操作结果类型-
9、接口描述：对接口操作给出无二义的语法和语义解释接口描述：对接口操作给出无二义的语法和语义解释2023/2/246 6第6页，本讲稿共34页5.5.控制模型控制模型 控控制制模模型型在在体体系系结结构构层层次次上上描描述述子子系系统统之之间间的的控控制制流流。有有两两种种表表示示形形式式：集中式控制和事件驱动控制。集中式控制和事件驱动控制。集集中中式式控控制制模模型型中中，由由一一个个称称为为系系统统控控制制器器的的子子系系统统来来负负责责管管理理其其它它子子系系统统的的执执行行，模模型型工工具具子子系系统统是是顺顺序序执执行行还还是是并并发发执执行行，而而分分成成调调用用-返回模型和管理者模型
10、。返回模型和管理者模型。下图是一个调用下图是一个调用-返回式集中控制模型的结构示例：返回式集中控制模型的结构示例：主程序主程序程序程序1程序程序2程序程序3程序程序1.1程序程序1.2程序程序3.1程序程序3.22023/2/247 7第7页，本讲稿共34页 下图是一种实时系统的管理者集中控制模型的结构示例：下图是一种实时系统的管理者集中控制模型的结构示例：故障处理器故障处理器传感器进程传感器进程传动装置进程传动装置进程计算进程计算进程系统控制系统控制用户界面用户界面 在基于事件驱动控制模型中，各个子系统都可以接受来自外在基于事件驱动控制模型中，各个子系统都可以接受来自外部子系统的事件，并对此
11、作出响应。部子系统的事件，并对此作出响应。典型的有典型的有广播型事件驱动控制模型广播型事件驱动控制模型和和中断型控制模型中断型控制模型。2023/2/248 8第8页，本讲稿共34页 广播型事件驱动控制模型的结构示例如图：广播型事件驱动控制模型的结构示例如图：子系统子系统1子系统子系统2子系统子系统3子系统子系统n时间和消息处理器时间和消息处理器 中断驱动型控制模型的结构示例如图：中断驱动型控制模型的结构示例如图：处理器处理器1 1处理器处理器2 2处理器处理器3 3处理器处理器4 4进程进程1 1进程进程2 2进程进程3 3进程进程4 4中断向量中断向量2023/2/249 9第9页，本讲稿
12、共34页6.6.数据流模型数据流模型 数据流模型是描述系统数据处理的一种很直观的方式。下图是一个订单处理的数据流图。数据流模型是描述系统数据处理的一种很直观的方式。下图是一个订单处理的数据流图。完成订完成订单表单表完成订完成订单表单表完成订完成订单表单表验证订单验证订单记录订单记录订单订单明细订单明细+空白订单表空白订单表订单文件订单文件预算文件预算文件 下图是一个下图是一个CASECASE工具集的工具集的数据流图。数据流图。设计设计编辑器编辑器设计交叉设计交叉检查器检查器设计设计分析器分析器报告报告生成器生成器代码框架代码框架生成器生成器设计设计数据库数据库设计设计数据库数据库检查过检查过的
13、设计的设计引用的引用的设计设计输出输出代码代码输入输入设计设计有效有效设计设计设计设计分析分析用户用户报告报告检查过检查过的设计的设计2023/2/241010第10页，本讲稿共34页7.7.状态机模型状态机模型 状状态态机机模模型型是是一一种种描描述述系系统统对对内内或或外外部部事事件件响响应应的的行行为为模模型型，用用来来表表示示系系统统状状态态和和事事件件，以以及及事事件件引引发发系系统统在在状状态态之之间间的的转转换换。下下图图是是一一个个简简单单微微波波炉炉的的状状态态机机模模型型示例。示例。全功率全功率Do:set power=600等待等待Do:displaytime半功率半功率
14、Do:set power=300设置时间设置时间Do:get numberExit:set time屏蔽屏蔽Do:displayWaiting激活激活Do:displayready等待等待Do:displaytime操作操作Do:operateopen全功率全功率半功率半功率全功率全功率半功率半功率计时器计时器计时器计时器门开门开门关门关门关门关开始开始取消取消系统出错系统出错数字数字2023/2/241111第11页，本讲稿共34页8.8.数据模型数据模型 绝绝大大多多数数的的软软件件系系统统都都要要使使用用数数据据库库，因因此此，系系统统建建模模的的一一项项重重要要工工作作就就是是定定义义
15、系系统统处处理理的逻辑结构。数据模型就是要表达这样的一个结构。的逻辑结构。数据模型就是要表达这样的一个结构。数数据据模模型型可可以以表表示示为为一一个个有有向向图图，包包含含一一系系列列不不同同类类型型的的结结点点，结结点点之之间间的的连连线线表表示示结结点点之之间间的的关关系系，每每个个结结点点有有结结点点标标示示和和若若干干属属性性描描述述。下下图图是是一一个个由由一一组组结结点点和和一一组关联构成的组关联构成的ERAERA数据模型，表是对应的数据字典。数据模型，表是对应的数据字典。设计设计NamedescriptionC-dateM-date标签标签Nametexticon链接链接Nam
16、etype链接链接Nametype有结点有结点n1有标签有标签11is an有链接有链接有标签有标签1nn1有链接有链接12链接链接2023/2/241212第12页，本讲稿共34页ERAERA图所对应的数据字典图所对应的数据字典名 字描 述类 型日 期has-labels在结点或关联实体和类型标签实体间的1:n关系关系2005-12-30label存放结点或关联的结构化的或非结构化的信息。标签由一个图标(可能是一个透明方块)和相关的文本表示实体2005-12-30link表示设计实体的结点间的1:1关系，关联具有类型和名字关系2005-12-30name(label)每个标签具有一个说明类型
17、的名字，该名字在设计中的标签类型必须唯一属性2005-12-30name(node)每个结点名字在整个设计中必须唯一，名字可以长达64个字符属性2005-12-309.9.对象模型对象模型 对对象象模模型型是是一一种种映映射射真真实实世世界界中中实实体体及及对对其其操操作作的的自自然然方方法法。对对象象模模型型既既可可以以表表达达系系统统数数据据，又又可可以以表表达达对对数数据据的的处处理理。因因此此，对对象象模模型型可可以以看看作作是是数数据据流流模型和数据模型的结合。模型和数据模型的结合。下下面面的的图图是是用用UMLUML描描述述对对象象类类的的例例子子。图图中中，每每个个矩矩形形表表示
18、示一一个个对对象象类类，其其中中包括对象名字、对象类中的属性、对象类的中操作。向上的空三角箭头表示继承。包括对象名字、对象类中的属性、对象类的中操作。向上的空三角箭头表示继承。2023/2/241313第13页，本讲稿共34页-Catalogue number-Acquisition-Cost-Type-Status-Number of copies+Acquire()+Catalogue()+Dispose()+Issue()+Return()-Author-Edition-Publication date-ISBN-Title-Publisher-Title-Medium-Year-Iss
19、ue-Version-Platform-Director-Date of release-Distributor图书馆系统的部分类层次图书馆系统的部分类层次2023/2/241414第14页，本讲稿共34页 除除了了通通过过继继承承来来组组织织系系统统，对对象象类类还还可可以以由由其其它它的的对对象象组组合合而而成成，称称为为对对象象成成员员。这这种种关关系称为对象的聚合，使用菱形表示聚合关系。如图所示的是课程的聚合对象表示。系称为对象的聚合，使用菱形表示聚合关系。如图所示的是课程的聚合对象表示。课程课程Course titleNumberYearInstructor作业作业Credits幻灯
20、片幻灯片Slides课堂笔记课堂笔记Text录像带录像带Tape ids练习练习ProblemsDescription解答解答TextDiagrams2023/2/241515第15页，本讲稿共34页 对对象象行行为为建建模模用用序序列列图图来来表表示示。如如图图，描描述述一一组组对对象象上上的的一一个个序序列列图图，操操作作由由带带标标签签的箭头指示，操作顺序是自上而下。的箭头指示，操作顺序是自上而下。读者读者目录目录图书馆项目图书馆项目服务器服务器查找查找显示显示发行发行发行许可发行许可接受许可接受许可打包打包交付交付电子科目的发放对象行为建模2023/2/241616第16页，本讲稿共3
21、4页7.3 7.3 用户手册用户手册 软软件件的的质质量量是是由由多多个个方方面面构构成成的的，用用户户手手册册也也是是衡衡量量软软件件质质量量的的一一个个重重要要标标准准。特特别别是是目目前前软软件件需需求求快快速速增增长长，市市场场迅迅速速扩扩张张的的时时期期，不不少少软软件件开开发发者者过过于于注注重重软软件件的的功功能能、性性能能，而而忽忽略略了了软软件件作作为为产产品品的的其其它它方方面面的的质质量量，而而用用户户手手册册的的质质量量问问题题尤尤为为突出。突出。一一个个优优秀秀的的用用户户手手册册可可以以帮帮助助用用户户快快速速入入门门，是是用用户户正正确确、充充分分使使用软件的前提
22、。用软件的前提。对对于于开开发发者者来来说说，质质量量符符合合要要求求的的用用户户手手册册，至至少少可可以以减减少少用户培训和售后服务的投入。用户培训和售后服务的投入。所所以以，对对软软件件开开发发者者来来说说，应应该该充充分分认认识识软软件件产产品品用用户户手手册册的的重重要要性性，提提高高用用户户手手册册的的质质量量，以以促促进进软软件件产产品品质质量量的的整整体体提提高。高。一个质量存在问题的某产品用户手册的例子。一个质量存在问题的某产品用户手册的例子。2023/2/241717第17页，本讲稿共34页1.1.用户手册的完整性用户手册的完整性 在在实实际际使使用用中中经经常常发发现现，很
23、很多多软软件件由由于于开开发发过过于于仓仓促促，在在付付诸诸使使用用时时，用用户户手手册册中中经经常常缺缺少少关关于于某某些些方方面面的的说说明明，有有时时缺缺少少的的还还是是十十分分重重要要的的内内容容，让让用用户户使使用用时时，感感到到困困难难，甚甚至至是是无无所所适适从从。而而质质量量良良好好的的用用户户手手册册，至至少少应应该该是是能能够够包包括括软软件件产产品品的的所所有有相相关关内内容容，能能够够指指导导用用户户顺顺利利的的安安装装、设设置置和和使使用用软件。软件。因此，保证内容的全面性和完整性是把握用户手册质量的重要方面。因此，保证内容的全面性和完整性是把握用户手册质量的重要方面
24、。2.2.用户手册的描述与软件实际功能的一致性用户手册的描述与软件实际功能的一致性 用用户户手手册册的的内内容容不不仅仅要要保保证证其其全全面面性性和和完完整整性性，还还要要确确保保它它与与一一起起发发行行的的软软件件版版本本的的实实际功能相一致。际功能相一致。现现实实情情况况是是，由由于于开开发发企企业业产产品品研研发发管管理理和和产产品品版版本本管管理理方方面面存存在在的的问问题题，产产生生用用户户手手册册描描述述内内容容和和软软件件实实际际运运行行情情况况不不一一致致，造造成成用用户户使使用用中中的的困困惑惑和和误误解解，进进而而影影响响软软件件的的正正常常使使用。用。2023/2/24
25、1818第18页，本讲稿共34页3.3.用户手册的易理解性用户手册的易理解性 由由于于软软件件产产品品的的用用户户往往往往对对计计算算机机方方面面的的专专业业知知识识了了解解不不多多，对对软软件件运运行行缺缺少少实实际际的的脑际映像，因此，用户手册的可理解性，是其质量的重要指标。脑际映像，因此，用户手册的可理解性，是其质量的重要指标。对对于于软软件件使使用用中中那那些些关关键键的的、重重要要的的、文文字字难难表表述述清清楚楚的的，或或者者使使用用图图表表方方法可以简化描述，增加可理解性的内容，应该采用图表或附有图表的方式描述。法可以简化描述，增加可理解性的内容，应该采用图表或附有图表的方式描述
26、。优秀的用户手册应该是图文并举，易读、易理解、易对照。优秀的用户手册应该是图文并举，易读、易理解、易对照。4.4.用户手册应提供学习操作的实例用户手册应提供学习操作的实例 一一个个没没有有软软件件运运行行和和操操作作实实例例的的用用户户手手册册，对对于于用用户户来来说说，其其实实并并没没有有太太大大的的帮帮助助。例例如如，软软件件中中关关于于系系统统网网络络参参数数配配置置的的说说明明，如如果果没没有有具具体体实实例例的的辅辅助助演演示示，相相信信绝绝大大多多数数没没有有多多少少网络知识的用户是很难胜任的。网络知识的用户是很难胜任的。一一个个优优秀秀的的用用户户手手册册，不不仅仅要要对对软软件
27、件主主要要功功能能和和关关键键操操作作提提供供应应用用实实例例，而而且且实实例的描述还应做到详细、充分，易于理解，实例最好由图示的方法描述。例的描述还应做到详细、充分，易于理解，实例最好由图示的方法描述。2023/2/241919第19页，本讲稿共34页5.5.用户手册的印刷与包装质量用户手册的印刷与包装质量 用用户户手手册册作作为为商商品品化化软软件件产产品品的的重重要要组组成成内内容容，其其纸纸张张、印印刷刷、装装订订、包包装装等等的的质质量量，包包括括版版面面、封封面面等等的的设设计计质质量量，手手册册和和软软件件应应用用类类型型的的吻吻合合程程度度等等，都将直接影响软件的形象、市场可接
28、受度和最终的销售业绩。都将直接影响软件的形象、市场可接受度和最终的销售业绩。另另外外，用用户户手手册册不不同同于于用用户户使使用用说说明明书书，它它除除了了向向用用户户提提供供基基本本的的产产品品操操作作方方法法，还还要要提提供很多与产品相关的其它信息。主要的有以下方面：供很多与产品相关的其它信息。主要的有以下方面：-介绍：软件的基本情况介绍：软件的基本情况-用途：介绍软件的适用范围、功能、性能主要及其特点用途：介绍软件的适用范围、功能、性能主要及其特点-运运行行环环境境：介介绍绍软软件件最最基基本本的的和和推推荐荐的的运运行行配配置置、软软件件安安装装说说明明、参参数数设设定定等等，以以及及
29、可可能引起的和系统的冲突，解决途径等能引起的和系统的冲突，解决途径等-使用过程：向用户介绍软件具体的使用方法使用过程：向用户介绍软件具体的使用方法-相关信息：必要的开发者信息，软件注册、升级途径等相关信息：必要的开发者信息，软件注册、升级途径等2023/2/242020第20页，本讲稿共34页7.4 7.4 操作手册操作手册 操操作作手手册册是是指指导导软软件件具具体体操操作作的的工工具具书书。操操作作手手册册涉涉及及软软件件设设计计完完成成后后的的以后所关心的有关操作的内容。以后所关心的有关操作的内容。由由于于操操作作的的项项目目不不同同，操操作作手手册册的的内内容容和和形形式式也也有有所所
30、不不同同。在在形形式式上上，有有技技术术指指导导书书，也也有有操操作作规规程程等等类类型型。内内容容上上，伸伸缩缩的的余余地地较较大大。但但一一般般而而言言，操操作作手手册册的的内内容容主主要应包括：要应包括：1.1.引引言言。主主要要简简介介软软件件的的外外围围特特性性、软软件件名名称称、开开发发单单位位、专专用用名名称称，概概述述软软件件内内部部的的一一些些结结构构，介介绍绍手手册册涉涉及及的的技技术术、设设备备或或产产品品的的特特点点、用用途途、使使用用对对象象、指指导导的的内内容容，以以及及手手册册的的编编排排格格式式等等，一一些些规规模模较较大大的的手手册册，还还要要介介绍绍手手册册
31、的的使使用用方方法法和和检检索索示示例例，使读者对手册和软件产品都有一个大概的了解。使读者对手册和软件产品都有一个大概的了解。写写作作上上，要要求求简简明明扼扼要要，叙叙述述全全面面、真真实实，读读者者读读后后能能感感受受到到对对手手册册和和软软件产品的一个提纲式的了解。件产品的一个提纲式的了解。2023/2/242121第21页，本讲稿共34页2.2.操操作作原原理理。这这部部分分内内容容是是对对操操作作对对象象或或过过程程的的主主要要性性质质或或步步骤骤的的解解释释，为操作者提供理论依据和操作基础。为操作者提供理论依据和操作基础。这这部部分分内内容容要要求求适适合合操操作作者者的的专专业业
32、水水平平，一一般般不不宜宜过过于于专专深深，内容描述可结合公式、框图、图表等，要求易于阅读、理解。内容描述可结合公式、框图、图表等，要求易于阅读、理解。3.3.操作说明。操作说明。介绍操作的具体步骤和要求，是操作手册的核心部分。介绍操作的具体步骤和要求，是操作手册的核心部分。步步骤骤的的组组织织结结构构一一般般按按每每一一步步骤骤分分点点说说明明。操操作作说说明明的的辅辅助助叙叙述述方方法法主主要要有有图图解解、框框图图、程程序序、表表格格等等。这这些些辅辅助助表表述述方方法法有时也会成为手册内容的主要表述形式。如操作过程的说明。有时也会成为手册内容的主要表述形式。如操作过程的说明。操操作作说
33、说明明要要求求简简练练、准准确确、形形象象、清清晰晰、易易懂懂，表表述述内内容容应应与与系系统统实实际际操操作作过过程程对对应应一一致致，语语句句多多采采用用短短句句和和主主动动语语态态，经经常常是是一一个个动作、一个步骤为一个编号单位。动作、一个步骤为一个编号单位。2023/2/242222第22页，本讲稿共34页4.4.注注意意事事项项。注注意意事事项项是是指指系系统统操操作作过过程程中中应应该该注注意意的的内内容容。注注意事项和故障排除也经常放在操作说明中。意事项和故障排除也经常放在操作说明中。但但更更多多的的时时候候，为为了了强强调调，将将其其单单独独列列出出，还还有有那那些些不不属属
34、于于基基本本操操作作的的内内容容，也也可可放放在在这这一一部部分分。如如软软件件与与运运行行环环境境的的维维护护、保保管管、技术故障的判断、排除、操作质量的分析等。技术故障的判断、排除、操作质量的分析等。5.5.附附录录。主主要要用用于于非非操操作作说说明明内内容容的的补补充充叙叙述述。如如运运行行环环境境的的配配套套设设备备、技技术术指指标标的的误误差差范范围围、非非常常规规过过程程部部分分和和远远程程操操作作部部分分等等，以以及及在在其其它它方面的应用或其典型操作的示例等。方面的应用或其典型操作的示例等。附附录录也也经经常常提提供供一一些些与与软软件件产产品品密密切切相相关关的的理理论论、
35、技技术术、方方法法、工工具具、资资料料、数数据据及及其其发发明明、创创作作或或提提供供者者的的出出处处、来来源源、介介绍绍等等资资料料，包括技术文档、资料的引用列表等。包括技术文档、资料的引用列表等。2023/2/242323第23页，本讲稿共34页7.5 7.5 维护修改文档维护修改文档 根根据据软软件件生生命命周周期期的的阶阶段段理理论论，软软件件投投入入运运行行后后，在在相相当当长长的的时时间间里里，由由于于业业务务、政政策策、市市场场、法法规规、管管理理、技技术术等等方方面面的的发发展展和和变变化化，都都会会使使得得软软件件应应用用机机构构的的业业务务经经历历着着持持续续不不断断的的变
36、变化化，这这些些变变化化或或者者产产生生了了新新的的需需求求，或或者者需需要要修修改改原原先先的的软软件件需需求求。再再好好的的软软件件系系统统，都都会会随随着着系系统统应应用用领领域域业业务务的的变变化化而而变变化化。因因此此，软软件件在在其其生生命命周周期期中中是是会会不断的进行着维护修改工作的。不断的进行着维护修改工作的。1.1.软件运行系统的结构软件运行系统的结构 对对运运行行中中的的软软件件进进行行维维护护修修改改，将将涉涉及及技技术术和和社社会会的的双双重重因因素素。这这不不仅仅是是由由客客观观的的工工程程准准则则决决定定，还还会会受受到到软软件件运运行行环环境境和和机机构构策策略
37、略的的影影响。响。如如图图，软软件件运运行行系系统统的的不不同同逻逻辑辑部部分分，会会产产生生各各自自不不同同的的相相互互影响。影响。2023/2/242424第24页，本讲稿共34页支持软件支持软件应用软件应用软件业务策略和规则业务策略和规则硬件系统硬件系统应用数据应用数据业务过程业务过程使用使用使用使用使用使用约束约束嵌入知识嵌入知识运行在运行在运行在运行在软件运行系统的例子：软件运行系统的例子：图中，各部分的含义如下：图中，各部分的含义如下：-硬件系统：硬件系统：当时的硬件系统现在可能已过时，或者维护费用过高当时的硬件系统现在可能已过时，或者维护费用过高-支支持持软软件件：系系统统运运行
38、行所所依依赖赖的的操操作作系系统统、数数据据库库系系统统、与与硬硬件件相相关关的的实实用用程程序序、驱驱动动程程序、编译系统等，现在可能已无法得到生产厂家的支持序、编译系统等，现在可能已无法得到生产厂家的支持-应用软件：应用软件：应用系统是由多个程序组成的，并且这些程序是独立的，在不同的时段开发的应用系统是由多个程序组成的，并且这些程序是独立的，在不同的时段开发的-应应用用数数据据：在在系系统统以以往往的的运运行行历历史史中中，积积累累了了大大量量的的数数据据，不不同同文文档档的的数数据据可可能能不不一一致致或或有有重复重复-业务过程：业务过程：业务过程受到业务策略和规则的约束，对应用软件提出
39、具体的需求业务过程受到业务策略和规则的约束，对应用软件提出具体的需求-业务策略和规则：业务策略和规则：规定了业务执行的规则和流程规定了业务执行的规则和流程2023/2/242525第25页，本讲稿共34页 上上面面软软件件运运行行系系统统的的示示意意图图可可以以进进一一步步抽抽象象为为右右图图所所示示的层次结构。的层次结构。从从图图中中可可以以看看到到，每每一一层层依依赖赖于于其其下下方方的的一一层层，层层与层之间有接口。与层之间有接口。因因此此，对对系系统统的的一一个个层层次次进进行行维维护护或或变变更更，势势必必引起其它各层作出相应的变更。引起其它各层作出相应的变更。业务过程业务过程应用软
40、件应用软件应用软件应用软件支持软件支持软件硬件硬件 一一个个应应用用软软件件通通常常包包含含有有多多个个不不同同的的程程序序，不不同同的的程程序序针针对对不不同同的的数数据据操操作作，有有些些数数据据还还可能为多个程序共享。如图，程序变更影响到数据，也影响到其它程序的变更。可能为多个程序共享。如图，程序变更影响到数据，也影响到其它程序的变更。程序程序1程序程序2程序程序3程序程序4程序程序5程序程序6程序程序7文件文件1文件文件2文件文件3文件文件4文件文件5文件文件6 本本例例说说明明，当当需需要要对对软软件件进进行行修修改改、变变更更时时，应应评评估估其其影影响响，并并慎慎重重地地提提出出
41、建建议议，以以提提交交审审批。批。2023/2/242626第26页，本讲稿共34页2.2.维护修改方案维护修改方案 软软件件的的维维护护、修修改改需需要要资资金金的的支支持持，需需要要对对投投资资做做精精心心安安排排，以以期期获获得得好好的的回回报报。因因此此，对对所所维维护护修修改改的的软软件件系系统统作作出出客客观观的的分分析析和和评评估估，制定合理、恰当的维护修改方案，是维护取得成功的前提。制定合理、恰当的维护修改方案，是维护取得成功的前提。根据实际软件维护可能的类型，可以有下面几种可选的维护方案：根据实际软件维护可能的类型，可以有下面几种可选的维护方案：-彻底抛弃现有系统。彻底抛弃现
42、有系统。当系统不能对现有业务过程产生有效作用时选择当系统不能对现有业务过程产生有效作用时选择-继继续续维维护护现现有有系系统统。当当系系统统运运行行平平稳稳，能能够够继继续续发发挥挥作作用用，用用户户也也没没有有大大的的变变更要求时，可选择此方案更要求时，可选择此方案-转转换换系系统统以以改改善善其其可可维维护护性性。当当系系统统质质量量应应经经常常变变更更，或或系系统统的的功功能能、性性能能增增加加及及改改善善后后，现现运运行行环环境境已已不不敷敷适适应应，并并且且系系统统维维护护修修改改的的需需求求仍仍然然是是经经常常性性的的时候，应选择此方案时候，应选择此方案-以以一一新新系系统统代代替
43、替现现系系统统。当当新新的的硬硬件件环环境境无无法法使使现现软软件件系系统统继继续续正正常常运运行行；或或虽虽现系统仍然能使用，但新开发系统的成本已很合理时，可考虑采用此方案现系统仍然能使用，但新开发系统的成本已很合理时，可考虑采用此方案-综合方案。综合方案。根据实际情况，选择上面几种方案进行综合维护工作根据实际情况，选择上面几种方案进行综合维护工作2023/2/242727第27页，本讲稿共34页3.3.维护过程与记载维护过程与记载 在通常情况下，一个规范的维护过程，都应有规范的结构化维护文档的生成机制。在通常情况下，一个规范的维护过程，都应有规范的结构化维护文档的生成机制。由由于于维维护护
44、过过程程是是由由一一系系列列变变更更请请求求所所触触发发的的，这这些些变变更更请请求求可可以以来来自自于于系系统统用用户户、管管理理层层或或者者是是客客户户。从从抽抽象象层层面面看看，所所有有维维护护过过程程都都有有相相同同的的基基本本活活动动，包包括括变变更更分分析析、版版本本规规划划、系系统统实实现现和和交交付付使使用用。下下图图描描述述了了系系统统维维护护过过程程的的概概况。况。变更请示变更请示影响分析影响分析版本规划版本规划变更实现变更实现缺陷修补缺陷修补平台适应平台适应系统增强系统增强系统发布系统发布2023/2/242828第28页，本讲稿共34页 在在维维护护过过程程的的变变更更
45、实实现现阶阶段段，应应该该修修改改系系统统描描述述、实实际际和和实实现现，以以反反映映对对系系统统所所做做的的变变更更。要要对对提提出出的的反反映映系系统统变变更更的的新新需需求求进进行行详详细细分分析，明确变更的内容。析，明确变更的内容。变变更更的的过过程程由由于于变变更更涵涵义义在在变变更更分分析析的的早早期期阶阶段段的的不不清清晰晰性性，而而变变得得曲曲折折反反复复，因因此此，对对变变更更需需求求应应进进行行反反复复的的修修改改和和有有效效性性验验证证，然然后后再再进进入入相相应应的的组组件件设设计计和和实实现现阶阶段段，最最后后通通过过测测试试，完完成成系系统统变变更更维维护护。其过程
46、如下图所示。其过程如下图所示。变更提议变更提议需求分析需求分析需求更新需求更新变更开发变更开发2023/2/242929第29页，本讲稿共34页 软件生命周期的所有阶段的文档，对软件维护工作都是十分重要的。软件生命周期的所有阶段的文档，对软件维护工作都是十分重要的。这些文档将作为评估维护技术的有效性，确定软件产品的这些文档将作为评估维护技术的有效性，确定软件产品的“优良优良”程度，程度，以及确定维护的实际代价等的重要依据。因此，维护过程内容的记载应以及确定维护的实际代价等的重要依据。因此，维护过程内容的记载应该要确定。下面是维护记载的基本内容参考：该要确定。下面是维护记载的基本内容参考：-程序
47、标识程序标识-源语句数源语句数-机器指令条数机器指令条数-使用的程序设计语言使用的程序设计语言-程序安装的日期程序安装的日期-自从安装以来程序运行的次数自从安装以来程序运行的次数-自从安装以来程序失效的次数自从安装以来程序失效的次数-程序变动的层次标识程序变动的层次标识-因程序变动而增加的源语句数因程序变动而增加的源语句数-因程序变动而减少的源语句数因程序变动而减少的源语句数-每个改动耗费的人时数每个改动耗费的人时数-程序改动的日期程序改动的日期-软件工程师的名字软件工程师的名字-维护要求表的标识维护要求表的标识-维护类型维护类型-维护开始和完成的日期维护开始和完成的日期-累计用于维护的人时数
48、累计用于维护的人时数-与完成的维护相联系的纯效益与完成的维护相联系的纯效益2023/2/243030第30页，本讲稿共34页4.4.维护修改建议维护修改建议 维维护护过过程程应应该该可可以以视视同同一一个个缩缩微微了了的的软软件件开开发发过过程程，因因此此，在在软软件件维维护护过过程程中中和和维维护护完完成成后后，都都因因编编制制规规范范的的文文档档，如如为为软软件件使使用用者者提提供供内内容容翔实、完整的软件维护手册。翔实、完整的软件维护手册。软软件件维维护护手手册册主主要要包包括括软软件件系系统统说说明明、程程序序模模块块说说明明、操操作作环环境境、支支持持软软件件的的说说明明、维维护护过
49、过程程的的说说明明等等，维维护护手手册册的的软软件件使使用用部部分，还应介绍系统功能、性能及操作在维护后的变化。分，还应介绍系统功能、性能及操作在维护后的变化。维护要求表维护要求表 应应该该是是一一张张标标准准化化格格式式的的表表格格，用用以以表表达达软软件件维维护护修修改改的的要要求求，描述维护修改的建议。描述维护修改的建议。维维护护要要求求表表也也称称软软件件问问题题报报告告表表，由由要要求求维维护护活活动动的的用用户户负负责责填填写写，完完整整的的描描述述导导致致出出现现错错误误的的环环境境(包包括括输输入入数数据据、全全部部输输出出数数据据，以以及及其它有关信息其它有关信息)。对于适应
50、性或完善性维护要求，还应该提供简短的需求说明书。对于适应性或完善性维护要求，还应该提供简短的需求说明书。2023/2/243131第31页，本讲稿共34页 编写维护修改建议编写维护修改建议 由由用用户户提提交交的的维维护护要要求求表表是是编编写写维维护护修修改改建建议议书书的的基基础础。通通过过维维护护管管理理员员和和系系统统管管理理员员，评评价价用用户户提提交交的的维维护护要要求求表表，确确定定用用户户维维护护要要求求的的合合理理性性，明明确确维维护护范范围围和和内内容容，制制定定软软件件组组织织内内部部应应该该执执行行的的软件维护修改建议。维护修改建议主要包括以下信息：软件维护修改建议。维