UFQP2-10QI003 使用手册编写规范

PAGEPAGE12024UF/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（产品名称）的在特性、功能方面的描述，并教您通过使用XXXXXXXXXX（产品名称）完成具体业务的操作。在这里我们将本手册中的内容结构和一些基本约定介绍给您，以方便手册的使用。本手册的内容结构在手册中我们分两个部分：快速入门和使用指南，对产品的使用过程进行讲解。快速入门以完成整个产品的应用过程为标准，简洁介绍业务处理的流程，并以一些常见问题和应用技巧为辅助。使用指南同样以完成整个产品的应用过程为标准，详细的描述各业务处理进行的过程，并以应用案例进行辅助说明。但这两部分内容都是以以下的业务内容为基础：1、。。（本手册的业务功能）。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。手册中的术语。。。。。（加入规范中约定的术语和本系统的术语）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。手册中的约定。。。。。。。（加入手册规范中的约定）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。初级用户如何使用本手册如果您初次使用财务软件，那么在参照手册学习本软件的使用时应按以下步骤进行：仔细阅读“应用准备”一章，并按手册中的要求准备相关档案和数据。阅读本手册中“使用指南”部分，按手册中的说明掌握具体业务的应用过程和操作方法。阅读本手册中“快速入门”部分，将具体的应用过程结合起来，加深掌握软件的应用流程，并学习相关的应用技巧和常见问题的解决方法。其他用户如何使用本手册如果您使用过财务软件，对于基本业务的应用过程有一定了解，那么您可以按以下步骤进行：阅读“应用准备”一章，并按手册中的要求准备相关档案和数据阅读本手册中“快速入门”部分，直接掌握本软件的应用流程，并学习相关的应用技巧和常见问题的解决方法在使用过程中遇到细节的问题时，可以阅读本手册中“使用指南”部分，按手册中的说明掌握具体业务的操作过程第二章应用准备在使用本系统前，您应对会计资料进行整理，为后续的产品应用做好准备。启用本系统应具备的档案1、。。。。。。。。。。（应用本系统所需的会计档案）2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。启用本系统应具备的数据1、。。。。。。。。。。（应用本系统所需的会计数据）2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。注：在必要时，可以增加其他相关应用准备标题和内容快速入门部分的手册编写模板XXXXXX（该章标题）本章内容结构本章的内容包括：（本章中各业务模块功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。（如果是业务处理章节，应加入业务处理流程图）如何进行XXXXXX（业务模块处理）【操作步骤】1、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。常见问题及应用技巧。。。。。。。（对本节中可能出现的问题和应用技巧进行解答，没有可不写）。。。。。。。。。。。使用指南部分的手册编写模板第X章XXXXXX（该章标题）本章向您介绍（本章内容的情况，在整个系统中所起的作用，对企业财务或业务管理具有的影响）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。本章学习的内容本章将要学习的内容包括：（本章中各业务模块功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。在开始学习本章之前如果您已经完成了第X-Y章（上一章或前几章）内容的学习，可以省略本节，直接开始本章内容的学习。如果直接从本章开始学习，那么您应该先做完以下事情：。。。。。。。（完成启动软件，打开本章功能窗口的过程）。。。。。。。（在可以使用本功能之前，您应完成的工作，如基本档案的录入等，应视实际情况而定）。。。。。。。XXXXXXXX。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。（本业务模块功能的简介，意义，完成业务功能的说明）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。什么是XXXXXX。。。。。。。。。。。。。。（对业务功能的定义或描述，如什么是预算设置，可以解释为按科目或部门预算分别设置预算金额和预算分析方向或方法，如不能准确定义或不必定义时可不写）。。。。。。。如何进行XXXX【操作步骤】（如果无法区分操作步骤，则直接写操作方法）1、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。，如图X-N（图表）【栏目说明】。。。。。。。。。（对特殊栏目进行的说明）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。2、。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。，如图X-N（图表）应用案例X-N。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。本章内容回顾让我们重新回顾本章所学内容（本章中各业务模块功能）。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。手册中格式的规范1标题符号规范‘■’大项说明——用于无先后次序的明细条目的说明‘◆’小项说明——用于在大项下的无先后次序的小项说明‘●’提醒说明——用于在要诀、提醒、警告等文字中的分项说明‘N=1、2…’——操作步骤以阿拉伯数字以表明次序‘X=（1）、（2）…’——每步操作步骤的小步骤【例X-N】——举例，按章编号。例3-1、例3-2….菜单项用【XXX】表示。例如【采购入库单】图标用〖XXX〗表示。例如〖增加〗快捷键用[XXX]表示。例如[Ctrl+B]界面中的字段和项目用“XXX”引用。例如“余额方向”选择框2插图表规范表格按章编号表XX-1表XX-2...表XX-N图按章编号图XX-1图XX-2..图XX-N图表编号放在图表正下居中3页面格式章与节间空两行；节与节间空二行；节与本节内容间空一行；两表(图)间空二行；其它节内内容间空行不得超过一行章、节、小节顶头写录入文字时，左侧起始处一律不要加入空格，各级标题及正文间层次通过<格式>菜单中<段落>的<左缩进>功能完成；也可直接用鼠标移动横标尺上缩进标记进行设置。一级标题（篇）、二级标题（章）、三级标题（1.1）、四级标题（1.1.1）、五级标题（1.1.1.1）：位于距页面最左侧起始处0.5CM处（段落左缩进0.5CM）。……级标题、章节内标题（如1.）、正文：位于距页面最左侧起始处2.5CM处（段落左缩进2.5CM）。根据实际需要录入所需层次。在段落内不要加入硬回车，只在分段处使用硬回车。在全角状态下，输入中文及中文行中标点；半角状态下输入英文、数字及英文行中标点。注：数字中涉及到的分隔符、小数点用半角；图表连接符“－”用全角。4页眉规范左页页眉：XX页第X章XXXX右页页眉：第X部XXXX