第7章软件尊重用户文档.pptVIP

软件文档与标准 徐承志 * 第7章 软件用户文档 7.1 软件用户文档 用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议等。 7.1 编制用户文档的基本要求 1. 描述规范准确 用户文档的阅读对象通常是非计算机专业的人员，因此对用户有很强的实用和指导意义。要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分。文档需要反映哪些内容、如何描述、口气、分寸等，都应与编制目的、使用对象协调一致。用词应标准、统一、规范。 2. 叙述简练生动 用户文档应简洁、精炼，少用用户难懂的专业术语，并力求形象生动、图文并茂，便于用户学习、理解和掌握软件的使用、操作。 3. 语言严密平实 用户文档的价值在于科学性。文字表达必须合乎逻辑，才能有助于用户使用、操作软件。 4. 内容系统完整 用户文档作为软件系统开发者和用户之间的界面，应能提供给用户关于软件整体结构、功能、安装、运行和操作的有关知识，并且用户文档的内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图”。 7.2 软件常用表示形式 软件的表示方法为软件系统建立一个基本构架，对理解软件，特别是对于软件的维护，将是非常重要的。 1. 容器模型 基于一个共享数据库的系统模型一般称为容器模型。 如果系统