软件用户文档(PPT文档).ppt
《软件用户文档(PPT文档).ppt》由会员分享,可在线阅读,更多相关《软件用户文档(PPT文档).ppt(33页珍藏版)》请在咨信网上搜索。
1、7.1 7.1 软件用户文档软件用户文档 用用户户文文档档是是软软件件开开发发人人员员为为软软件件用用户户了了解解、使使用用、操操作作和和维维护护等等提提供供的的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。详细资料。用户文档包括用户手册、操作手册和维护修改建议等。7.1 7.1 编制用户文档的基本要求编制用户文档的基本要求1.1.描述规范准确描述规范准确 用用户户文文档档的的阅阅读读对对象象通通常常是是非非计计算算机机专专业业的的人人员员,因因此此对对用用户户有有很很强强的的实实用用和和指指导导意意义义。要要求求在在描描述述内内容容、说说明明方方法法、提提出出见见解解时时都都应应
2、准准确确无无误误,恰恰如如其其分分。文文档档需需要要反反映映哪哪些些内内容容、如何描述、口气、分寸等,都应与编制目的、使用对象协调一致。用词应标准、统一、规范。如何描述、口气、分寸等,都应与编制目的、使用对象协调一致。用词应标准、统一、规范。2.2.叙述简练生动叙述简练生动 用用户户文文档档应应简简洁洁、精精炼炼,少少用用用用户户难难懂懂的的专专业业术术语语,并并力力求求形形象象生生动动、图图文文并并茂茂,便便于于用户学习、理解和掌握软件的使用、操作。用户学习、理解和掌握软件的使用、操作。3.3.语言严密平实语言严密平实 用户文档的价值在于科学性。文字表达必须合乎逻辑,才能有助于用户使用、操作
3、软件。用户文档的价值在于科学性。文字表达必须合乎逻辑,才能有助于用户使用、操作软件。4.4.内容系统完整内容系统完整 用用户户文文档档作作为为软软件件系系统统开开发发者者和和用用户户之之间间的的界界面面,应应能能提提供供给给用用户户关关于于软软件件整整体体结结构构、功功能能、安安装装、运运行行和和操操作作的的有有关关知知识识,并并且且用用户户文文档档的的内内容容组组织织应应该该有有系系统统性性、层层次次性性,使使之之成为软件使用、操作的清晰的成为软件使用、操作的清晰的“交通图交通图”。2024/5/25 周六1 17.2 7.2 软件常用表示形式软件常用表示形式 软软件件的的表表示示方方法法为
4、为软软件件系系统统建建立立一一个个基基本本构构架架,对对理理解解软软件件,特特别别是是对于软件的维护,将是非常重要的。对于软件的维护,将是非常重要的。1.1.容器模型容器模型 基于一个共享数据库的系统模型一般称为容器模型。基于一个共享数据库的系统模型一般称为容器模型。如如果果系系统统的的工工作作所所使使用用的的数数据据是是围围绕绕共共享享数数据据库库进进行行的的,这这可可以以考考虑虑采用容器模型来表达其系统结构。下图是一种集成采用容器模型来表达其系统结构。下图是一种集成CASECASE工具集的体系结构。工具集的体系结构。设计编辑器设计编辑器代码生成器代码生成器设计分析器设计分析器报告生成器报告
5、生成器程序编辑器程序编辑器设计转换器设计转换器项目存储项目存储 在上面的例子中,容器是被动的,对它的控制是由其它子系统完成的。在上面的例子中,容器是被动的,对它的控制是由其它子系统完成的。2024/5/25 周六2 22.2.客户机客户机/服务器模型服务器模型 这这个个模模型型用用于于表表示示一一个个分分布布式式系系统统,说说明明数数据据和和加加工工过过程程在在多多个个处处理理器器之间的分配。其例子如下图所示。之间的分配。其例子如下图所示。用户用户用户用户用户用户用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程多媒体数据库服务器及中间件多媒体数据
6、库服务器及中间件图像图像服务器服务器视频视频服务器服务器声音声音服务器服务器文本文本服务器服务器图像图像数据库数据库视频视频数据库数据库声音声音数据库数据库文本文本数据库数据库2024/5/25 周六3 33.3.抽象机模型抽象机模型 抽象机模型,也称分层模型,常用来表示子下图的接口模型。抽象机模型,也称分层模型,常用来表示子下图的接口模型。将将下下图图组组织织成成一一系系列列的的层层次次,每每一一层层次次定定义义一一组组服服务务。一一个个著著名名的的例例子子是网络协议是网络协议OSIOSI参考模型。参考模型。下图是一个版本管理下图的抽象机模型的结构示例。下图是一个版本管理下图的抽象机模型的结
7、构示例。4.4.接口描述接口描述 大大型型系系统统总总是是分分解解成成独独立立开开发发的的一一些些子子系系统统。因因此此,在在软软件件描描述述中中的的一一个必要成分就是定义子系统接口。接口的示意如下图。个必要成分就是定义子系统接口。接口的示意如下图。子系统子系统A子系统子系统B2024/5/25 周六4 4 接口是一种抽象的概念,在面向对象的程序设计中,可以是一个类的公接口是一种抽象的概念,在面向对象的程序设计中,可以是一个类的公开的数据成员或成员函数,也可以是若干个类抽象出的接口对象。接口抽象开的数据成员或成员函数,也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。概念如图所示。Cla
8、ss1-用于接口数据成员用于接口数据成员-其它数据成员其它数据成员Class2+用于接口的成员函数用于接口的成员函数()()+其它成员函数其它成员函数()()Class3Class4interface接口对象接口对象Class5 接口描述主要包括三方面信息:接口描述主要包括三方面信息:-类型名:即一组对象的名字类型名:即一组对象的名字-接口语法:定义接口操作的名字、参数个数、参数类型及操作结果类型接口语法:定义接口操作的名字、参数个数、参数类型及操作结果类型-接口描述:对接口操作给出无二义的语法和语义解释接口描述:对接口操作给出无二义的语法和语义解释2024/5/25 周六5 55.5.控制模
9、型控制模型 控控制制模模型型在在体体系系结结构构层层次次上上描描述述子子系系统统之之间间的的控控制制流流。有有两两种表示形式:集中式控制和事件驱动控制。种表示形式:集中式控制和事件驱动控制。集集中中式式控控制制模模型型中中,由由一一个个称称为为系系统统控控制制器器的的子子系系统统来来负负责责管管理理其其它它子子系系统统的的执执行行,模模型型工工具具子子系系统统是是顺顺序序执执行行还还是是并并发发执执行,而分成调用行,而分成调用-返回模型和管理者模型。返回模型和管理者模型。下图是一个调用下图是一个调用-返回式集中控制模型的结构示例:返回式集中控制模型的结构示例:主程序主程序程序程序1程序程序2程
10、序程序3程序程序1.1程序程序1.2程序程序3.1程序程序3.22024/5/25 周六6 6 下图是一种实时系统的管理者集中控制模型的结构示例:下图是一种实时系统的管理者集中控制模型的结构示例:故障处理器故障处理器传感器进程传感器进程传动装置进程传动装置进程计算进程计算进程系统控制系统控制用户界面用户界面 在基于事件驱动控制模型中,各个子系统都可以接受来自在基于事件驱动控制模型中,各个子系统都可以接受来自外部子系统的事件,并对此作出响应。外部子系统的事件,并对此作出响应。典型的有典型的有广播型事件驱动控制模型广播型事件驱动控制模型和和中断型控制模型中断型控制模型。2024/5/25 周六7
11、7 广播型事件驱动控制模型的结构示例如图:广播型事件驱动控制模型的结构示例如图:子系统子系统1子系统子系统2子系统子系统3子系统子系统n时间和消息处理器时间和消息处理器 中断驱动型控制模型的结构示例如图:中断驱动型控制模型的结构示例如图:处理器处理器1 1处理器处理器2 2处理器处理器3 3处理器处理器4 4进程进程1 1进程进程2 2进程进程3 3进程进程4 4中断向量中断向量2024/5/25 周六8 86.6.数据流模型数据流模型 数数据据流流模模型型是是描描述述系系统统数数据据处处理理的的一一种种很很直直观观的的方方式式。下下图图是是一一个个订订单单处理的数据流图。处理的数据流图。完成
12、订完成订单表单表完成订完成订单表单表完成订完成订单表单表验证订单验证订单记录订单记录订单订单明细订单明细+空白订单表空白订单表订单文件订单文件预算文件预算文件 下图是一个下图是一个CASECASE工具集的工具集的数据流图。数据流图。设计设计编辑器编辑器设计交叉设计交叉检查器检查器设计设计分析器分析器报告报告生成器生成器代码框架代码框架生成器生成器设计设计数据库数据库设计设计数据库数据库检查过检查过的设计的设计引用的引用的设计设计输出输出代码代码输入输入设计设计有效有效设计设计设计设计分析分析用户用户报告报告检查过检查过的设计的设计2024/5/25 周六9 97.7.状态机模型状态机模型 状状
13、态态机机模模型型是是一一种种描描述述系系统统对对内内或或外外部部事事件件响响应应的的行行为为模模型型,用用来来表表示示系系统统状状态态和和事事件件,以以及及事事件件引引发发系系统统在在状状态态之之间间的的转转换换。下下图图是是一一个个简简单单微微波波炉炉的状态机模型示例。的状态机模型示例。全功率全功率Do:set power=600等待等待Do:displaytime半功率半功率Do:set power=300设置时间设置时间Do:get numberExit:set time屏蔽屏蔽Do:displayWaiting激活激活Do:displayready等待等待Do:displaytime操
14、作操作Do:operateopen全功率全功率半功率半功率全功率全功率半功率半功率计时器计时器计时器计时器门开门开门关门关门关门关开始开始取消取消系统出错系统出错数字数字2024/5/25 周六10108.8.数据模型数据模型 绝绝大大多多数数的的软软件件系系统统都都要要使使用用数数据据库库,因因此此,系系统统建建模模的的一一项项重重要要工工作作就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。数数据据模模型型可可以以表表示示为为一一个个有有向向图图,包包含含一一系系列列不不同同类类型型的的结结点点,结结点点之之间间的的
15、连连线线表表示示结结点点之之间间的的关关系系,每每个个结结点点有有结结点点标标示示和和若若干干属属性性描描述述。下下图图是一个由一组结点和一组关联构成的是一个由一组结点和一组关联构成的ERAERA数据模型,表是对应的数据字典。数据模型,表是对应的数据字典。设计设计NamedescriptionC-dateM-date标签标签Nametexticon链接链接Nametype链接链接Nametype有结点有结点n1有标签有标签11is an有链接有链接有标签有标签1nn1有链接有链接12链接链接2024/5/25 周六1111ERAERA图所对应的数据字典图所对应的数据字典名 字描 述类 型日 期
16、has-labels在结点或关联实体和类型标签实体间的1:n关系关系2005-12-30label存放结点或关联的结构化的或非结构化的信息。标签由一个图标(可能是一个透明方块)和相关的文本表示实体2005-12-30link表示设计实体的结点间的1:1关系,关联具有类型和名字关系2005-12-30name(label)每个标签具有一个说明类型的名字,该名字在设计中的标签类型必须唯一属性2005-12-30name(node)每个结点名字在整个设计中必须唯一,名字可以长达64个字符属性2005-12-309.9.对象模型对象模型 对对象象模模型型是是一一种种映映射射真真实实世世界界中中实实体体
17、及及对对其其操操作作的的自自然然方方法法。对对象象模模型型既既可可以以表表达达系系统统数数据据,又又可可以以表表达达对对数数据据的的处处理理。因因此此,对对象象模模型型可可以以看看作作是数据流模型和数据模型的结合。是数据流模型和数据模型的结合。下下面面的的图图是是用用UMLUML描描述述对对象象类类的的例例子子。图图中中,每每个个矩矩形形表表示示一一个个对对象象类类,其其中中包包括括对对象象名名字字、对对象象类类中中的的属属性性、对对象象类类的的中中操操作作。向向上上的的空空三三角角箭箭头头表示继承。表示继承。2024/5/25 周六1212-Catalogue number-Acquisit
18、ion-Cost-Type-Status-Number of copies+Acquire()+Catalogue()+Dispose()+Issue()+Return()-Author-Edition-Publication date-ISBN-Title-Publisher-Title-Medium-Year-Issue-Version-Platform-Director-Date of release-Distributor图书馆系统的部分类层次图书馆系统的部分类层次2024/5/25 周六1313 除除了了通通过过继继承承来来组组织织系系统统,对对象象类类还还可可以以由由其其它它的的对
19、对象象组组合合而而成成,称称为为对对象象成成员员。这这种种关关系系称称为为对对象象的的聚聚合合,使使用用菱菱形形表表示示聚聚合合关关系系。如如图图所所示示的的是课程的聚合对象表示。是课程的聚合对象表示。课程课程Course titleNumberYearInstructor作业作业Credits幻灯片幻灯片Slides课堂笔记课堂笔记Text录像带录像带Tape ids练习练习ProblemsDescription解答解答TextDiagrams2024/5/25 周六1414 对对象象行行为为建建模模用用序序列列图图来来表表示示。如如图图,描描述述一一组组对对象象上上的的一一个个序序列列图图
20、,操作由带标签的箭头指示,操作顺序是自上而下。操作由带标签的箭头指示,操作顺序是自上而下。读者读者目录目录图书馆项目图书馆项目服务器服务器查找查找显示显示发行发行发行许可发行许可接受许可接受许可打包打包交付交付电子科目的发放对象行为建模2024/5/25 周六15157.3 7.3 用户手册用户手册 软软件件的的质质量量是是由由多多个个方方面面构构成成的的,用用户户手手册册也也是是衡衡量量软软件件质质量量的的一一个个重重要要标标准准。特特别别是是目目前前软软件件需需求求快快速速增增长长,市市场场迅迅速速扩扩张张的的时时期期,不不少少软软件件开开发发者者过过于于注注重重软软件件的的功功能能、性性
21、能能,而而忽忽略略了了软软件件作作为为产产品品的的其其它它方方面面的的质质量量,而而用用户户手手册册的的质质量量问题尤为突出。问题尤为突出。一一个个优优秀秀的的用用户户手手册册可可以以帮帮助助用用户户快快速速入入门门,是是用用户户正正确确、充分使用软件的前提。充分使用软件的前提。对对于于开开发发者者来来说说,质质量量符符合合要要求求的的用用户户手手册册,至至少少可可以以减减少用户培训和售后服务的投入。少用户培训和售后服务的投入。所所以以,对对软软件件开开发发者者来来说说,应应该该充充分分认认识识软软件件产产品品用用户户手手册册的的重重要要性性,提提高高用用户户手手册册的的质质量量,以以促促进进
22、软软件件产产品品质质量量的的整整体提高。体提高。一个质量存在问题的某产品用户手册的例子。一个质量存在问题的某产品用户手册的例子。2024/5/25 周六16161.1.用户手册的完整性用户手册的完整性 在在实实际际使使用用中中经经常常发发现现,很很多多软软件件由由于于开开发发过过于于仓仓促促,在在付付诸诸使使用用时时,用用户户手手册册中中经经常常缺缺少少关关于于某某些些方方面面的的说说明明,有有时时缺缺少少的的还还是是十十分分重重要要的的内内容容,让让用用户户使使用用时时,感感到到困困难难,甚甚至至是是无无所所适适从从。而而质质量量良良好好的的用用户户手手册册,至至少少应应该该是是能能够够包包
23、括括软软件件产产品品的的所所有有相相关关内内容容,能能够够指指导导用用户户顺顺利利的的安安装装、设设置置和使用软件。和使用软件。因此,保证内容的全面性和完整性是把握用户手册质量的重要方面。因此,保证内容的全面性和完整性是把握用户手册质量的重要方面。2.2.用户手册的描述与软件实际功能的一致性用户手册的描述与软件实际功能的一致性 用用户户手手册册的的内内容容不不仅仅要要保保证证其其全全面面性性和和完完整整性性,还还要要确确保保它它与与一一起起发发行的软件版本的实际功能相一致。行的软件版本的实际功能相一致。现现实实情情况况是是,由由于于开开发发企企业业产产品品研研发发管管理理和和产产品品版版本本管
24、管理理方方面面存存在在的的问问题题,产产生生用用户户手手册册描描述述内内容容和和软软件件实实际际运运行行情情况况不不一一致致,造造成成用用户户使使用用中中的的困惑和误解,进而影响软件的正常使用。困惑和误解,进而影响软件的正常使用。2024/5/25 周六17173.3.用户手册的易理解性用户手册的易理解性 由由于于软软件件产产品品的的用用户户往往往往对对计计算算机机方方面面的的专专业业知知识识了了解解不不多多,对对软软件件运运行缺少实际的脑际映像,因此,用户手册的可理解性,是其质量的重要指标。行缺少实际的脑际映像,因此,用户手册的可理解性,是其质量的重要指标。对对于于软软件件使使用用中中那那些
25、些关关键键的的、重重要要的的、文文字字难难表表述述清清楚楚的的,或或者者使使用用图图表表方方法法可可以以简简化化描描述述,增增加加可可理理解解性性的的内内容容,应应该该采采用用图图表表或或附附有有图图表表的的方方式描述。式描述。优秀的用户手册应该是图文并举,易读、易理解、易对照。优秀的用户手册应该是图文并举,易读、易理解、易对照。4.4.用户手册应提供学习操作的实例用户手册应提供学习操作的实例 一一个个没没有有软软件件运运行行和和操操作作实实例例的的用用户户手手册册,对对于于用用户户来来说说,其其实实并并没没有有太太大大的的帮帮助助。例例如如,软软件件中中关关于于系系统统网网络络参参数数配配置
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 用户 文档 PPT
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,个别因单元格分列造成显示页码不一将协商解决,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【精****】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【精****】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。