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

* 第八章 软件用户文档 用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。 8.1 编制用户文档的基本要求 1. 描述规范准确 用户文档的阅读对象通常是非计算机专业的人员，因此对用户有很强的实用和指导意义。要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分。文档需要反映哪些内容、如何描述、口气、分寸等，都应与编制目的、使用对象协调一致。用词应标准、统一、规范。 2. 叙述简练生动 用户文档应简洁、精炼，少用用户难懂的专业术语，并力求形象生动、图文并茂，便于用户学习、理解和掌握软件的使用、操作。 3. 语言严密平实 用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。 4. 内容系统完整 用户文档作为软件系统开发者和用户之间的界面，应能提供给用户关于软件整体结构、功能、安装、运行和操作的有关知识，并且用户文档的内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图”。 8.2 软件常用表示形式 软件的表示方法为软件系统建立一个基本构架，对理解软件，特别是对于软件的维护，将是非常重要的。 1. 容器模型 基于一个共享数据库的系统模型一般称为容器模型。 如果系统的工作所使用的数据是围绕共享数据库进行的，这可以考虑采用容器模型来表达其系统结构。下图是一种集成CASE工具集的体系结构。 设计编辑器 代码生成器 设计分析器 报告生成器 程序编辑器 设计转换器 项目存储 在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的。 2. 客户机/服务器模型 这个模型用于表示一个分布式系统，说明数据和加工过程在多个处理器之间的分配。其例子如下图所示。 用户 用户 用户 用户接口客户进程 用户接口客户进程 用户接口客户进程 多媒体数据库服务器及中间件 图像 服务器 视频 服务器 声音 服务器 文本 服务器 …… 图像 数据库 视频 数据库 声音 数据库 文本 数据库 3. 抽象机模型 抽象机模型，也称分层模型，常用来表示子系统的接口模型。 将下图组织成一系列的层次，每一层次定义一组服务。一个著名的例子是网络协议OSI参考模型。 4. 接口描述 大型系统总是分解成独立开发的一些子系统。因此，在软件描述中的一个必要成分就是定义子系统接口。接口的示意如下图。 子系统A 子系统B 接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示。 Class1 - 用于接口数据成员 - 其它数据成员 Class2 + 用于接口的成员函数() + 其它成员函数() Class3 Class4 《interface》 接口对象 Class5 接口描述主要包括三方面信息： - 类型名：即一组对象的名字 - 接口语法：定义接口操作的名字、参数个数、参数类型及操作结果类型 - 接口描述：对接口操作给出无二义的语法和语义解释 5. 控制模型 控制模型在体系结构层次上描述子系统之间的控制流。有两种表示形式：集中式控制和事件驱动控制。 集中式控制模型中，由一个称为系统控制器的子系统来负责管理其它子系统的执行，模型工具子系统是顺序执行还是并发执行，而分成调用-返回模型和管理者模型。 下图是一个调用-返回式集中控制模型的结构示例： 主程序 程序1 程序2 程序3 程序1.1 程序1.2 程序3.1 程序3.2 下图是一种实时系统的管理者集中控制模型的结构示例： 故障处理器 传感器进程 传动装置进程 计算进程 系统控制 用户界面 在基于事件驱动控制模型中，各个子系统都可以接受来自外部子系统的事件，并对此作出响应。 典型的有广播型事件驱动控制模型和中断型控制模型。 广播型事件驱动控制模型的结构示例如图： 子系统1 子系统2 子系统3 子系统n … 时间和消息处理器 中断驱动型控制模型的结构示例如图： 处理器1 处理器2 处理器3 处理器4 进程1 进程2 进程3 进程4 中断向量 6. 数据流模型 数据流模型是描述系统数据处理的一种很直观的方式。下图是一个订单处理的数据流图。 完成订单表 完成订单表 完成订单表 验证订单 记录订单 订单明细+空白订单表 订单文件 预算文件 下图是一个CASE工具集的数据流图。 设计 编辑器 设计交叉 检查器 设计 分析器 报告 生成器 代码框架 生成器 设计 数据库 设计 数据库 检查过的设计 引用的设计 输出代码 输入设计 有效设计 设计分