软件文档写作-第8讲用户文档(完整).pptVIP

* 4. 维护修改建议 维护过程应该可以视同一个缩微了的软件开发过程，因此，在软件维护过程中和维护完成后，都因编制规范的文档，如为软件使用者提供内容翔实、完整的软件维护手册。 软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明等，维护手册的软件使用部分，还应介绍系统功能、性能及操作在维护后的变化。 ① 维护要求表 应该是一张标准化格式的表格，用以表达软件维护修改的要求，描述维护修改的建议。 维护要求表也称软件问题报告表，由要求维护活动的用户负责填写，完整的描述导致出现错误的环境(包括输入数据、全部输出数据，以及其它有关信息)。 对于适应性或完善性维护要求，还应该提供简短的需求说明书。 * ② 编写维护修改建议 由用户提交的维护要求表是编写维护修改建议书的基础。通过维护管理员和系统管理员，评价用户提交的维护要求表，确定用户维护要求的合理性，明确维护范围和内容，制定软件组织内部应该执行的软件维护修改建议。维护修改建议主要包括以下信息： - 满足维护要求表中提出的要求所需要的工作量 - 维护要求的性质 - 该项维护修改要求的优先次序 - 与维护修改有关的数据 * ③ 评价维护修改 软件生命周期所有阶段生成的文档是评价维护修改活动的依据。对维护活动的评价可以做一些定量的度量。至少可以从以下7个方面对维护活动进行评价： - 每次程序运行平均失效的次数 - 用于每一类维护活动的总人时数 - 平均每个程序、每种语言、每种维护类型所做的程序变动数 - 维护过程中增加或删除一个源语句平均花费的人时数 - 维护每种语言平均花费的人时数 - 一张维护要求表的平均周转时间 - 不同维护类型所占的百分比 根据对维护工作的定量度量，可以作出关于开发技术、语言选择、维护工作量规划、资源分配及其它相关方面的决策，并且可以利用这些数据去分析和评价维护过程的质量，发现维护过程改进的方向和内容。 第八讲 软件用户文档 * 用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。 8.1 编制用户文档的基本要求 1. 描述规范准确 用户文档的阅读对象通常是非计算机专业的人员，因此对用户有很强的实用和指导意义。要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分。文档需要反映哪些内容、如何描述、口气、分寸等，都应与编制目的、使用对象协调一致。用词应标准、统一、规范。 2. 叙述简练生动 用户文档应简洁、精炼，少用用户难懂的专业术语，并力求形象生动、图文并茂，便于用户学习、理解和掌握软件的使用、操作。 3. 语言严密平实 用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。 4. 内容系统完整 用户文档作为软件系统开发者和用户之间的界面，应能提供给用户关于软件整体结构、功能、安装、运行和操作的有关知识，并且用户文档的内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图”。 * 8.2 软件常用表示形式 软件的表示方法为软件系统建立一个基本构架，对理解软件，特别是对于软件的维护，将是非常重要的。 1. 容器模型 基于一个共享数据库的系统模型一般称为容器模型。 如果系统的工作所使用的数据是围绕共享数据库进行的，这可以考虑采用容器模型来表达其系统结构。下图是一种集成CASE工具集的体系结构。 设计编辑器 代码生成器 设计分析器 报告生成器 程序编辑器 设计转换器 项目存储 在上面的例子中，容器是被动的，对它的控制是由其它子系统完成的 * 2. 客户机/服务器模型 这个模型用于表示一个分布式系统，说明数据和加工过程在多个处理器之间的分配。其例子如下图所示。 用户 用户 用户 用户接口客户进程 用户接口客户进程 用户接口客户进程 多媒体数据库服务器及中间件 图像 服务器 视频 服务器 声音 服务器 文本 服务器 …… 图像 数据库 视频 数据库 声音 数据库 文本 数据库 * 3. 抽象机模型 抽象机模型，也称分层模型。 将下图组织成一系列的层次，每一层次定义一组服务。一个著名的例子是网络协议OSI参考模型。 4. 接口描述 大型系统总是分解成独立开发的一些子系统。因此，在软件描述中的一个必要成分就是定义子系统接口。接口的示意如下图。 子系统A 子系统B * 接口是一种抽象的概念，在面向对象的程序设计中，可以是一个类的公开的数据成员或成员函数，也可以是若干个类抽象出的接口对象。接口抽象概念如图所示 Class1 - 用于接口数据成员 - 其它数据