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

1,第八章 软件用户文档 用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。 8.1 编制用户文档的基本要求 1. 描述规范准确 用户文档的阅读对象通常是非计算机专业的人员，因此对用户有很强的实用和指导意义。要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分。文档需要反映哪些内容、如何描述、口气、分寸等，都应与编制目的、使用对象协调一致。用词应标准、统一、规范。 2. 叙述简练生动 用户文档应简洁、精炼，少用用户难懂的专业术语，并力求形象生动、图文并茂，便于用户学习、理解和掌握软件的使用、操作。 3. 语言严密平实 用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。 4. 内容系统完整 用户文档作为软件系统开发者和用户之间的界面，应能提供给用户关于软件整体结构、功能、安装、运行和操作的有关知识，并且用户文档的内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图”。,2,8.2 软件常用表示形式 软件的表示方法为软件系统建立一个基本构架，对理解软件，特别是对于软件的维护，将是非常重要的。 1. 容器模型 基于一个共享数据库的系统模型一般称为容器模型。 如果系统的工作所使用的数据是围绕共享数据库进行的，这可以考虑采用容器模型来表达其系统结构。下图是一种集成CASE工具集的体系结构。,在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。,3,2. 客户机/服务器模型 这个模型用于表示一个分布式系统，说明数据和加工过程在多个处理器之间的分配。其例子如下图所示。,4,3. 抽象机模型 抽象机模型，也称分层模型，常用来表示子系统的接口模型。 将下图组织成一系列的层次，每一层次定义一组服务。一个著名的例子是网络协议OSI参考模型。,4. 接口描述 大型系统总是分解成独立开发的一些子系统。因此，在软件描述中的一个必要成分就是定义子系统接口。接口的示意如下图。,5,接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。,接口描述主要包括三方面信息： - 类型名：即一组对象的名字 - 接口语法：定义接口操作的名字、参数个数、参数类型及操作结果类型 - 接口描述：对接口操作给出无二义的语法和语义解释,6,5. 控制模型 控制模型在体系结构层次上描述子系统之间的控制流。有两种表示形式：集中式控制和事件驱动控制。 集中式控制模型中，由一个称为系统控制器的子系统来负责管理其它子系统的执行，模型工具子系统是顺序执行还是并发执行，而分成调用-返回模型和管理者模型。 下图是一个调用-返回式集中控制模型的结构示例：,7,下图是一种实时系统的管理者集中控制模型的结构示例：,在基于事件驱动控制模型中，各个子系统都可以接受来自外部子系统的事件，并对此作出响应。 典型的有广播型事件驱动控制模型和中断型控制模型。,8,广播型事件驱动控制模型的结构示例如图：,中断驱动型控制模型的结构示例如图：,9,6. 数据流模型 数据流模型是描述系统数据处理的一种很直观的方式。下图是一个订单处理的数据流图。,下图是一个CASE工具集的数据流图。,10,7. 状态机模型 状态机模型是一种描述系统对内或外部事件响应的行为模型，用来表示系统状态和事件，以及事件引发系统在状态之间的转换。下图是一个简单微波炉的状态机模型示例。,11,8. 数据模型 绝大多数的软件系统都要使用数据库，因此，系统建模的一项重要工作就是定义系统处理的逻辑结构。数据模型就是要表达这样的一个结构。 数据模型可以表示为一个有向图，包含一系列不同类型的结点，结点之间的连线表示结点之间的关系，每个结点有结点标示和若干属性描述。下图是一个由一组结点和一组关联构成的ERA数据模型，表是对应的数据字典。,12,ERA图所对应的数据字典,9. 对象模型 对象模型是一种映射真实世界中实体及对其操作的自然方法。对象模型既可以表达系统数据，又可以表达对数据的处理。因此，对象模型可以看作是数据流模型和数据模型的结合。 下面的图是用UML描述对象类的例子。图中，每个矩形表示一个对象类，其中包括对象名字、对象类中的属性、对象类的中操作。向上的空三角箭头表示继承。,13,图书馆系统的部分类层次,14,除了通过继承来组织系统，对象类还可以由其它的对象组合而成，称为对象成员。这种关系称为对象的聚合，使