9-用户类文档写作.pptxVIP

用户类文档写作 第九课 本节的目的 了解用户类技术文档的写作方法与格式 掌握用户类软件文档的写作要点 熟悉常用的用户类文档：产品用户手册、软件操作手册、软件维护手册等 概述 什么是软件用户文档 用户文档是软件开发人员为软件用户了解、使用、操作和维护等提供的详细资料。用户文档包括用户手册、操作手册和维护修改建议手册等。 基本要求 描述规范准确：要求在描述内容、说明方法、提出见解时都应准确无误，恰如其分，针对非专业用户 用户文档的易理解程度：少用用户难懂的专业术语，并力求形象生动、图文并茂，文字表达必须合乎逻辑，便于用户学习掌握 内容系统完整，与实际功能一致：作为开发者和用户之间的界面，应能提供给用户系统完整的知识：软件整体结构、功能、安装、运行和操作等，内容组织应该有系统性、层次性，使之成为软件使用、操作的清晰的“交通图” 用户手册（产品说明书） 用户手册的重要性 是指导用户选择产品、使用产品的“路标”和“向导” 可以帮助用户快速入门，是用户正确、充分使用软件的前提 对于开发者来说，质量符合要求的用户手册，至少可以减少用户培训和售后服务的投入 “好”用户手册的要求 用户手册的完整性 用户手册的描述与软件实际功能的一致性 用户手册的易理解性 用户手册应提供学习操作的实例 用户手册印刷预包装质量 用户手册的内容 用户手册不同于用户使用说明书 介绍：软件的基本情况 用途：介绍软件的适用范围、功能、性能主要及其特点 运行环境：介绍软件最基本的和推荐的运行配置、软件安装说明、参数设定等，以及可能引起的和系统的冲突，解决途径等 使用过程：向用户介绍软件具体的使用方法 相关信息：必要的开发者信息，软件注册、升级途径等 案例分析 《开票子系统软件通用版V6.15用户手册》用户手册 用户使用说明书（操作手册） 什么是操作手册 指导软件具体操作的工具书 涉及软件设计完成后的以后所关心的有关操作的内容 内容包括：引言、操作原理、操作说明、注意事项、附录 操作手册与用户手册的区别 操作手册是用户手册的一部分。 操作手册是系统级别的文档，而用户手册是需求级别的文档。 在做项目的时候操作手册可以代替用户手册，因为各方面的需求很明确。 用户手册不光是对系统操作的说明，而从头开始的服务器配置，系统安装、系统操作系统维护等，完全是成熟的流程模式 案例分析 用户操作手册模板 软件维护手册 维护手册的内容 指导软件的维护和升级 主要包括：软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明等 手册的软件使用部分，还应介绍系统功能、性能及操作在维护后的变化 维护方案的选择 彻底抛弃现有系统。当系统不能对现有业务过程产生有效作用时选择 继续维护现有系统。当系统运行平稳，能够继续发挥作用，用户需求无大的变更要求时可选择 转换系统以改善其可维护性。当系统变更后，现运行环境已不再适应，并需经常维护修改时 以一新系统代替现系统。新硬件环境无法使用现软件系统，或新开发系统的成本更好时 综合方案。根据实际情况，综合选择 维护过程与记载：清晰变更 维护过程与记载：不清晰变更 软件维护的建议 维护过程可以视同一个缩微了的软件开发过程 维护申请表。一张标准化格式的表格，用以表达软件维护修改的要求，描述维护修改的建议 也称软件问题报告表。由提出维护活动的用户负责填写，完整的描述导致出现错误的环境 编写软件维护修改建议。评价用户提交的维护申请表，确定用户维护要求的合理性，明确维护范围和内容，制定应该执行的软件维护修改建议 评价维护修改。对维护活动做一些定量的度量评价，如系统失效情况、维护活动人时、维护类型 案例分析 《宽带网用户安装 及维护手册》