《软件文档写作14用户课件》由会员分享，可在线阅读，更多相关《软件文档写作14用户课件（15页珍藏版）》请在金锄头文库上搜索。
1、第八章第八章 软件用户文档软件用户文档 用用户户文文档档是是软软件件开开发发人人员员为为软软件件用用户户了了解解、使使用用、操操作作和和维维护护等等提提供供的的详详细资料。用户文档包括用户手册、操作手册和维护修改建议等。细资料。用户文档包括用户手册、操作手册和维护修改建议等。8.1 8.1 编制用户文档的基本要求编制用户文档的基本要求1. 1. 描述规范准确描述规范准确 用用户户文文档档的的阅阅读读对对象象通通常常是是非非计计算算机机专专业业的的人人员员，因因此此对对用用户户有有很很强强的的实实用用和和指指导导意意义义。要要求求在在描描述述内内容容、说说明明方方法法、提提出出见见解解时时都都应
2、应准准确确无无误误，恰恰如如其其分分。文文档档需需要要反反映映哪哪些些内内容容、如如何何描描述述、口口气气、分分寸寸等等，都都应应与与编编制制目目的的、使用对象协调一致。用词应标准、统一、规范。使用对象协调一致。用词应标准、统一、规范。2. 2. 叙述简练生动叙述简练生动 用用户户文文档档应应简简洁洁、精精炼炼，少少用用用用户户难难懂懂的的专专业业术术语语，并并力力求求形形象象生生动动、图图文并茂，便于用户学习、理解和掌握软件的使用、操作。文并茂，便于用户学习、理解和掌握软件的使用、操作。3. 3. 语言严密平实语言严密平实 用用户户文文档档的的价价值值在在于于科科学学性性。文文字字表表达达必
3、必须须合合乎乎逻逻辑辑，才才能能有有助助于于用用户户使使用、操作软件。用、操作软件。4. 4. 内容系统完整内容系统完整 用用户户文文档档作作为为软软件件系系统统开开发发者者和和用用户户之之间间的的界界面面，应应能能提提供供给给用用户户关关于于软软件件整整体体结结构构、功功能能、安安装装、运运行行和和操操作作的的有有关关知知识识，并并且且用用户户文文档档的的内内容容组组织织应该有系统性、层次性，使之成为软件使用、操作的清晰的应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图交通图”。1软件文档写作14-用户8.2 8.2 软件常用表示形式软件常用表示形式 软软件件的的表表示示方方法法
4、为为软软件件系系统统建建立立一一个个基基本本构构架架，对对理理解解软软件件，特特别别是是对对于于软件的维护，将是非常重要的。软件的维护，将是非常重要的。1. 1. 容器模型容器模型 基于一个共享数据库的系统模型一般称为容器模型。基于一个共享数据库的系统模型一般称为容器模型。 如如果果系系统统的的工工作作所所使使用用的的数数据据是是围围绕绕共共享享数数据据库库进进行行的的，这这可可以以考考虑虑采采用用容器模型来表达其系统结构。下图是一种集成容器模型来表达其系统结构。下图是一种集成CASECASE工具集的体系结构。工具集的体系结构。设计编辑器设计编辑器代码生成器代码生成器设计分析器设计分析器报告生
5、成器报告生成器程序编辑器程序编辑器设计转换器设计转换器项目存储项目存储 在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。2软件文档写作14-用户2. 2. 客户机客户机/ /服务器模型服务器模型 这这个个模模型型用用于于表表示示一一个个分分布布式式系系统统，说说明明数数据据和和加加工工过过程程在在多多个个处处理理器器之间的分配。其例子如下图所示。之间的分配。其例子如下图所示。用户用户用户用户用户用户用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程用户接口客户进程多媒体数据库服务器及中间件
6、多媒体数据库服务器及中间件图像图像服务器服务器视频视频服务器服务器声音声音服务器服务器文本文本服务器服务器图像图像数据库数据库视频视频数据库数据库声音声音数据库数据库文本文本数据库数据库3软件文档写作14-用户3. 3. 抽象机模型抽象机模型 抽象机模型，也称分层模型，常用来表示子系统的接口模型。抽象机模型，也称分层模型，常用来表示子系统的接口模型。 将将下下图图组组织织成成一一系系列列的的层层次次，每每一一层层次次定定义义一一组组服服务务。一一个个著著名名的的例例子子是网络协议是网络协议OSIOSI参考模型。参考模型。 4. 4. 接口描述接口描述 大大型型系系统统总总是是分分解解成成独独立
7、立开开发发的的一一些些子子系系统统。因因此此，在在软软件件描描述述中中的的一一个必要成分就是定义子系统接口。接口的示意如下图。个必要成分就是定义子系统接口。接口的示意如下图。子系统子系统A子系统子系统B4软件文档写作14-用户 接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员函数，也可以是若干个类抽象出的接口对象。接口抽象开的数据成员或成员函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。概念如图所示。Class1- - 用于接口数据成员用于接口数据成员- - 其它数据成员其它数据成员Cl
8、ass2+ + 用于接口的成员函数用于接口的成员函数()()+ + 其它成员函数其它成员函数()()Class3Class4interface接口对象接口对象Class5 接口描述主要包括三方面信息：接口描述主要包括三方面信息：- - 类型名类型名：即一组对象的名字：即一组对象的名字- - 接口语法接口语法：定义接口操作的名字、参数个数、参数类型及操作结果类型：定义接口操作的名字、参数个数、参数类型及操作结果类型- - 接口描述接口描述：对接口操作给出无二义的语法和语义解释：对接口操作给出无二义的语法和语义解释5软件文档写作14-用户5. 5. 控制模型控制模型 控控制制模模型型在在体体系系结
9、结构构层层次次上上描描述述子子系系统统之之间间的的控控制制流流。有有两两种表示形式：种表示形式：集中式控制集中式控制和和事件驱动控制事件驱动控制。 集集中中式式控控制制模模型型中中，由由一一个个称称为为系系统统控控制制器器的的子子系系统统来来负负责责管管理理其其它它子子系系统统的的执执行行，模模型型工工具具子子系系统统是是顺顺序序执执行行还还是是并并发发执执行行，而分成，而分成调用调用- -返回模型返回模型和和管理者模型管理者模型。 下图是一个调用下图是一个调用- -返回式集中控制模型的结构示例：返回式集中控制模型的结构示例：主程序主程序程序程序1程序程序2程序程序3程序程序1.1程序程序1.
10、2程序程序3.1程序程序3.26软件文档写作14-用户 下图是一种实时系统的管理者集中控制模型的结构示例：下图是一种实时系统的管理者集中控制模型的结构示例：故障处理器故障处理器传感器进程传感器进程传动装置进程传动装置进程计算进程计算进程系统控制系统控制用户界面用户界面 在基于事件驱动控制模型中，各个子系统都可以接受来自在基于事件驱动控制模型中，各个子系统都可以接受来自外部子系统的事件，并对此作出响应。外部子系统的事件，并对此作出响应。 典型的有典型的有广播型事件驱动控制模型广播型事件驱动控制模型和和中断型控制模型中断型控制模型。7软件文档写作14-用户 广播型事件驱动控制模型的结构示例如图：广
11、播型事件驱动控制模型的结构示例如图：子系统子系统1子系统子系统2子系统子系统3子系统子系统n时间和消息处理器时间和消息处理器 中断驱动型控制模型的结构示例如图：中断驱动型控制模型的结构示例如图：处理器处理器1 1处理器处理器2 2处理器处理器3 3处理器处理器4 4进程进程1 1进程进程2 2进程进程3 3进程进程4 4中断向量中断向量8软件文档写作14-用户6. 6. 数据流模型数据流模型 数数据据流流模模型型是是描描述述系系统统数数据据处处理理的的一一种种很很直直观观的的方方式式。下下图图是是一一个个订订单单处理的数据流图。处理的数据流图。完成订完成订单表单表完成订完成订单表单表完成订完成
12、订单表单表验证订单验证订单记录订单记录订单订单明细订单明细+ +空白订单表空白订单表订单文件订单文件预算文件预算文件 下图是一个下图是一个CASECASE工具集的工具集的数据流图。数据流图。设计设计编辑器编辑器设计交叉设计交叉检查器检查器设计设计分析器分析器报告报告生成器生成器代码框架代码框架生成器生成器设计设计数据库数据库设计设计数据库数据库检查过检查过的设计的设计引用的引用的设计设计输出输出代码代码输入输入设计设计有效有效设计设计设计设计分析分析用户用户报告报告检查过检查过的设计的设计9软件文档写作14-用户7. 7. 状态机模型状态机模型 状状态态机机模模型型是是一一种种描描述述系系统统
13、对对内内或或外外部部事事件件响响应应的的行行为为模模型型，用用来来表表示示系系统统状状态态和和事事件件，以以及及事事件件引引发发系系统统在在状状态态之之间间的的转转换换。下下图图是是一一个个简简单单微微波波炉炉的状态机模型示例。的状态机模型示例。全功率全功率Do: set power=600等待等待Do: displaytime半功率半功率Do: set power=300设置时间设置时间Do:get numberExit:set time屏蔽屏蔽Do: displayWaiting激活激活Do: displayready等待等待Do: displaytime操作操作Do: operateop
14、en全功率全功率半功率半功率全功率全功率半功率半功率机时器机时器机时器机时器门开门开门开门开门关门关开始开始取消取消系统出错系统出错数字数字10软件文档写作14-用户8. 8. 数据模型数据模型 绝绝大大多多数数的的软软件件系系统统都都要要使使用用数数据据库库，因因此此，系系统统建建模模的的一一项项重重要要工工作作就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。 数数据据模模型型可可以以表表示示为为一一个个有有向向图图，包包含含一一系系列列不不同同类类型型的的结结点点，结结点点之之间间的的连连线线表表示示结结点点之之间
15、间的的关关系系，每每个个结结点点有有结结点点标标示示和和若若干干属属性性描描述述。下下图图是一个由一组结点和一组关联构成的是一个由一组结点和一组关联构成的ERAERA数据模型，表是对应的数据字典。数据模型，表是对应的数据字典。设计设计NamedescriptionC-dateM-date标签标签Nametexticon链接链接Nametype链接链接Nametype有结点有结点n1有标签有标签11is an有链接有链接有标签有标签1nn1有链接有链接12链接链接11软件文档写作14-用户ERAERA图所对应的数据字典图所对应的数据字典名名 字字描描 述述类类 型型日日 期期has-labels
16、在结点或关联实体和类型标签实体间的在结点或关联实体和类型标签实体间的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、。图图中中，每每个个矩矩形形表表示示一一个个对对象象类类，其其中中包包括括对对象象名名字字、对对象象类类中中的的属属性性、对对象象类类的的中中操操作作。向向上上的的空空三三角角箭箭头头表示继承。表示继承。12软件文档写作14-用户- Catalogue number- Acquisition- Cost- Type- Status- Number of copies+ Acquire()+ Catalogue()+ Dispose()+ Issue()+ Return()- Author- Edition- Publication date- ISBN- Title- Publisher- T
19、itle- Medium- Year- Issue- Version- Platform- Director- Date of release- Distributor图书馆系统的部分类层次图书馆系统的部分类层次13软件文档写作14-用户 除除了了通通过过继继承承来来组组织织系系统统，对对象象类类还还可可以以由由其其它它的的对对象象组组合合而而成成，称称为为对对象象成成员员。这这种种关关系系称称为为对对象象的的聚聚合合，使使用用菱菱形形表表示示聚聚合合关关系系。如如图图所所示示的的是课程的聚合对象表示。是课程的聚合对象表示。课程课程Course titleNumberYearInstructor作业作业Credits幻灯片幻灯片Slides课堂笔记课堂笔记Text录像带录像带Tape ids练习练习ProblemsDescription解答解答TextDiagrams14软件文档写作14-用户 对对象象行行为为建建模模用用序序列列图图来来表表示示。如如图图，描描述述一一组组对对象象上上的的一一个个序序列列图图，操作由带标签的箭头指示，操作顺序是自上而下。操作由带标签的箭头指示，操作顺序是自上而下。读者读者目录目录图书馆项目图书馆项目服务器服务器查找查找显示显示发行发行发行许可发行许可接受许可接受许可打包打包交付交付电子科目的发放对象行为建模15软件文档写作14-用户
