软件文档写作14-用户文档

第八章

软件用户文档

用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。8.1编制用户文档的基本要求1.描述规范准确用户文档的阅读对象通常是非计算机专业的人员，因此对用户有很强的实用和指导意义。要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分。文档需要反映哪些内容、如何描述、口气、分寸等，都应与编制目的、使用对象协调一致。用词应标准、统一、规范。2.叙述简练生动用户文档应简洁、精炼，少用用户难懂的专业术语，并力求形象生动、图文并茂，便于用户学习、理解和掌握软件的使用、操作。3.语言严密平实用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。4.内容系统完整用户文档作为软件系统开发者和用户之间的界面，应能提供给用户关于软件整体结构、功能、安装、运行和操作的有关(yǒuguān)知识，并且用户文档的内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图”。1共十六页8.2软件常用表示形式软件的表示方法为软件系统建立一个基本构架，对理解软件，特别是对于软件的维护，将是非常重要的。1.容器(róngqì)模型基于一个共享数据库的系统模型一般称为容器模型。如果系统的工作所使用的数据是围绕共享数据库进行的，这可以考虑采用容器模型来表达其系统结构。下图是一种集成CASE工具集的体系结构。设计编辑器代码生成器设计分析器报告生成器程序编辑器设计转换器项目存储在上面的例子中，容器(róngqì)是被动的，对它的控制是由其它子系统完成的。2共十六页2.客户机/服务器模型这个模型用于表示一个分布式系统，说明数据和加工过程在多个处理器之间的分配。其例子(lìzi)如下图所示。用户用户用户用户接口客户进程用户接口客户进程用户接口客户进程多媒体数据库服务器及中间件图像服务器视频服务器声音服务器文本服务器……图像数据库视频数据库声音数据库文本数据库3共十六页3.抽象机模型抽象机模型，也称分层模型，常用来表示子系统的接口模型。将下图组织成一系列的层次，每一层次定义一组服务(fúwù)。一个著名的例子是网络协议OSI参考模型。

4.接口描述大型系统总是分解成独立开发的一些(yīxiē)子系统。因此，在软件描述中的一个必要成分就是定义子系统接口。接口的示意如下图。子系统A子系统B4共十六页接口(jiēkǒu)是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员函数，也可以是若干个类抽象出的接口(jiēkǒu)对象。接口(jiēkǒu)抽象概念如图所示。Class1-用于接口数据成员-其它数据成员Class2+用于接口的成员函数()+其它成员函数()Class3Class4《interface》接口对象Class5接口描述主要包括三方面信息：-类型名：即一组对象的名字-接口语法：定义接口操作(cāozuò)的名字、参数个数、参数类型及操作(cāozuò)结果类型-接口描述：对接口操作给出无二义的语法和语义解释5共十六页5.控制模型控制模型在体系结构层次上描述子系统之间的控制流。有两种表示(biǎoshì)形式：集中式控制和事件驱动控制。

集中式控制模型中，由一个称为系统控制器的子系统来负责管理其它子系统的执行，模型工具子系统是顺序执行还是并发执行，而分成调用-返回模型和管理者模型。下图是一个调用-返回式集中控制模型的结构示例：主程序程序1程序2程序3程序1.1程序1.2程序3.1程序3.26共十六页下图是一种实时系统的管理者集中控制模型的结构(jiégòu)示例：故障处理器传感器进程传动装置进程计算进程系统控制用户界面在基于事件驱动控制模型(móxíng)中，各个子系统都可以接受来自外部子系统的事件，并对此作出响应。典型的有广播型事件驱动控制模型和中断型控制模型。7共十六页广播型事件驱动控制模型的结构(jiégòu)示例如图：子系统1子系统2子系统3子系统n…时间和消息处理器中断驱动型控制模型(móxíng)的结构示例如图：处理器1处理器2处理器3处理器4进程1进程2进程3进程4中断向量8共十六页6.数据流模型

数据流模型是描述系统数据处理的一种很直观的方式(fāngshì)。下图是一个订单处理的数据流图。完成订单表完成订单表完成订单表验证订单记录订单订单明细+空白订单表订单文件预算文件下图是一个(yīɡè)CASE工具集的数据流图。设计编辑器设计交叉检查器设计分析器报告生成器代码框架生成器设计数据库设计数据库检查过的设计引用的设计输出代码输入设计有效设计设计分析用户报告检查过的设计9共十六页7.状态机模型

状态机模型是一种描述系统对内或外部事件响应的行为模型，用来表示系统状态和事件，以及事件引发(yǐnfā)系统在状态之间的转换。下图是一个简单微波炉的状态机模型示例。全功率Do:setpower=600等待Do:displaytime半功率Do:setpower=300设置时间Do:getnumberExit:settime屏蔽Do:display‘Waiting’激活Do:display‘ready’等待Do:displaytime操作Do:operateopen全功率半功率全功率半功率机时器机时器门开门开门关开始取消系统出错数字10共十六页8.数据模型

绝大多数的软件系统都要使用数据库，因此，系统建模的一项重要工作就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。数据模型可以表示为一个有向图，包含一系列不同类型的结点(jiédiǎn)，结点(jiédiǎn)之间的连线表示结点(jiédiǎn)之间的关系，每个结点(jiédiǎn)有结点(jiédiǎn)标示和若干属性描述。下图是一个由一组结点(jiédiǎn)和一组关联构成的ERA数据模型，表是对应的数据字典。设计NamedescriptionC-dateM-date标签Nametexticon链接Nametype链接Nametype有结点n1有标签11isan有链接有标签1nn1有链接12链接11共十六页ERA图所对应(duìyìng)的数据字典名字描述类型日期has-labels在结点或关联实体和类型标签实体间的1:n关系关系2005-12-30label存放结点或关联的结构化的或非结构化的信息。标签由一个图标(可能是一个透明方块)和相关的文本表示实体2005-12-30link表示设计实体的结点间的1:1关系，关联具有类型和名字关系2005-12-30name(label)每个标签具有一个说明类型的名字，该名字在设计中的标签类型必须唯一属性2005-12-30name(node)每个结点名字在整个设计中必须唯一，名字可以长达64个字符属性2005-12-309.对象模型对象模型是一种映射真实世界中实体及对其操作的自然方法。对象模型既可以表达系统数据，又可以表达对数据的处理。因此，对象模型可以看作是数据流模型和数据模型的结合。下面(xiàmian)的图是用UML描述对象类的例子。图中，每个矩形表示一个对象类，其中包括对象名字、对象类中的属性、对象类的中操作。向上的空三角箭头表示继承。12共十六页-CataloguenumberAcquisitionCostType-Status-Numberofcopies+Acquire()+Catalogue()+Dispose()+Issue()+Return()-Author-Edition-Publicationdate-ISBN-Title-Publisher-Title-Medium-Year-Issue-Version-Platform-Director-Dateofrelease-Distributor图书馆系统(xìtǒng)的部分类层次13共十六页除了通过继承来组织系统，对象类还可以由其它的对象组合而成，称为对象成员(chéngyuán)。这种关系称为对象的聚合，使用菱形表示聚合关系。如图所示的是课程的聚合对象表示。课程CoursetitleNumberYearInstructor作业Credits幻灯片Slides课堂笔记Text录像带Tapeids练习ProblemsDescription解答TextDiagrams14共十六页对象行为建模用序列图来表示。如图，描述一组对象上的一个序列图，操作由带标签的箭头指示，操作顺序(shùnxù)是自上而下。读者目录图书馆项目服务器查找显示发行发行许可接受许可打包交付电子科目的发放——对象(duìxiàng)行为建模15共十六页内容(nèiróng)总结