使用手册编写规范.doc

UF/QP/2-10/QI/003 使用手册编写规范 手册编写原则 手册编写应从客户的角度出发，注重手册的实用性及可读性，真正成为用户学习软件的良师益友，使用户能通过手册逐步掌握进而熟练使用产品。 在手册的编写过程中，应遵循易用性和友好性的原则，尽量给用户提供各种查阅手册的简便方法。 在手册编写的过程中，应力争思路清晰，逻辑严密。 手册的编写定位 对购买我们产品的用户大致可以分为三类，第一类为初级用户，即没有接触过财务软件的用户（包括没有使用过计算机的用户）；第二类为中级用户，即使用过财务软件并有一定的计算机基础的用户；第三类为高级用户，这类用户计算机水平较高且对财务软件的应用流程比较熟悉。由于财务软件的通用性，所以对于第三类用户来讲，他们在软件的应用基础和应用流程上的能力较强，所以他们所需要解决的问题往往是具有个性的，一般不易在手册中体现出来。因此手册在编写时应集中解决初级和中级用户的使用问题上。 手册中应具备的内容 名词解释：在手册编写过程中，将不可避免的会遇到一些有关计算机和财务方面的专业术语，对这些必要的但用户又不好理解的术语，应查找相关的资料进行标准化的解释。 流程图：流程图在描述软件的处理流程和各系统关系上具备一目了然的特性，这种特性是使用文字描述所不能替代的，所以在手册的各模块中要求有相应的流程图。 操作步骤：它是对软件各个功能操作的详细描述，使用户在已经了解整体流程的基础上迅速掌握各个功能细节性的操作处理。 实例：在手册中应尽可能的为客户以实例的方式来阐明应用方案，并且各个部分实例中的数据能够前后联系，形成一个完整的系统方案。在这里建议以产品中的演示数据为手册中实例的应用方案。 常见问题：可以以问答的形式将软件使用过程中遇到的一些常见问题例举在手册中。如果用户在使用中真的遇到该类问题是即可迎刃而解，同时用户也可以不间断的进行以后的处理。 手册的结构 用户使用手册的最终目的有两个：一是通过手册学习软件，二是解决遇到的问题。 针对这种情况，使用手册在内容上可分为快速入门和使用指南两个部分，快速入门以最简介的操作步骤结合操作技巧，以及可能遇到的问题的解决方案组合而成，以满足中级用户快速掌握软件和解决问题的需要。使用指南以纯粹的操作为主，按步骤详细完成功能操作的描述。 针对产品结构复杂，功能模块较多的情况，可将产品手册分为产品综述手册和产品模块手册两个部分分别处理。产品综述手册主要介绍产品的安装环境，产品的安装过程，产品中的模块结构，产品各个模块间的处理关系，产品各个模块的启用关系，以及打印机的配置要求及产品在打印过程中的调试及问题的处理方法。产品模块手册主要介绍各个模块的功能，业务流程，操作步骤，操作技巧，以及常见问题的解答等。 产品手册的基本模式 产品综述手册 目录 前言 介绍产品的开发背景，适用范围，新的功能及特性。 第一章 产品的安装 产品的安装环境 产品安装的硬件环境 产品安装的软件环境 产品的安装过程 安装过程中的常见问题与技巧 如何卸载（删除）产品 第二章 产品升级 1如何从7。X升级 2如何从8。X升级 第三章 产品模块的结构 1 产品的模块 产品模块的结构图 系统管理 总账 现金银行。。。。。。 第四章 账套数据 为什么要进行数据奋份 如何奋份账套数据 如何恢复账套数据 第五章 如何使用帮助 获取帮助的几种形式 帮助主题的操作方法 如何使用帮助的索引功能 如何使用帮助的查找功能 第六章 打印 6．1 打印机的配置 打印机的连接 打印过程中的常见问题。。。。。。 附录 附录A ——快捷键 附录B ——术语表 。。。。。。——其他可能成为附录的内容 产品模块手册 目录 前言 介绍本系统的功能及业务处理流程 第一部分 应用准备 第一章 如何使用本手册 初级用户如何使用本手册 其他用户如何使用本手册 第二章 应用准备 启用本系统应具备的档案 启用本系统应具备的数据 第二部分 快速入门 初始设置 1本章的内容结构 2档案的录入 1．3期初余额的录入 4常见问题、应用技巧 日常业务 2．1 。。。。。。——介绍日常的业务处理、操作步骤、常见问题处理 。。。。。。 第三部分 使用指南 初始设置 1 本章学习的内容 2档案的录入 3期初余额的录入 4本章内容回顾 日常业务 本章学习的内容 。。。。。。。 本章内容回顾 第三章 。。。。。。。。。。 第四部分 新会计年度的处理 第一章 新老年度账之间的处理 附录 附录A 图标操作一栏表 手册编写模板 由于产品综述手册内容复杂，无法对手册形式进行统一，所以产品综述手册原则上遵循基本模式和手册中的约定进行编写，具体内容根据实际情况进行处理。 应用准备部分的手册编写模板 如何使用本手册 本手册和系统其他模块的使用手册共同完成XXXXXXXXXX（