软件产品用户手册编写指导规范.doc

1.总则 软件产品的用户手册是软件产品开发的重要结果，也是用户学习使用软件产品的主要工具。因此用户手册作为软件产品的组成部分，应当及时完成，并且能全面、详细地说明软件产品的功能、使用方法以及其它用户为使用、维护软件产品需知晓的事项。 2.目的 对用户手册的编写时机、职责、内容及格式要求作出规定，以保证用户手册能满足用户正确使用软件产品的要求。 3.职责 3.1.需求分析小组与项目组是用户手册的编写责任者; 3.2.支持经理是用户手册编写的组织者; 3.3.方正系统公司培训部负责用户手册的审核和印制。4.工作程序 4.1.用户手册的编写时机 用户手册的编写应当从需求分析阶段开始进行。在需求分析小组编写出需求规格说明书的同时，应完成用户手册的初稿。该初稿应包括软件产品主要的功能描述以及界面描述。在设计和实现（编码）阶段，项目组应随着软件产品的逐步细化以及变更的情况，同步完成用户手册的修改和细化。当软件产品在项目组内完成集成测试时，用户手册的编写工作应基本完成，即此时用户手册的内容部分除因系统测试中发现错误而需进行部分改动外，不需要在内容方面进行增加。但手册的格式可以暂时达不到要求。软件产品提交系统测试时，用户手册达不到以上要求的，测试部门将不受理其测试申请。4.2.用户手册的审定 用户手册内容的审定，由项目组支持经理负责，同时应征求开发中心项目负责人的意见。用户手册形式的审核由测试部门负责。4.3.用户手册编写工作的组织 在项目组建立后，用户手册的编写工作由支持经理负责组织。具体的编写工作可以由项目组的成员共同完成，但支持经理负责用户手册编写工作的组织以及监督检查，并对其质量负责。 4.4.用户手册编写的格式要求 见方正用户手册排版要求4.5.用户手册的内容要求 4.5.1.封面 用户手册的封面应包括以下内容：软件产品的名称、版本号以及版权单位信息。其中软件产品的名称须使用软件产品的正式名称，并可以注明其简称。版本号是指本次一同发行的软件产品的版本号而不是指手册的版本号。版权单位应至少包含两个单位，即方正系统公司及负责销售的方正海外公司某一专业公司。如果还有其它单位参与了软件产品的开发工作，可以按合同或其它协议，列出其名称。封面上应在适当的位置出现方正系统公司的标志图案。4.5.2.封底 在用户手册的封底，可根据需要列出方正系统公司有关的销售或服务部门的通讯地址，或是对本软件产品的简要宣传信息。除此之外，封底上不得以较大的篇幅显示其它信息。 4.5.3.扉页 在手册中应有一个扉页，对手册的版权做出声明，并对手册中提及的其它公司的商标做出说明。要求见附1中的模版。4.5.4.手册的内容布局 一般而言，用户手册应包括以下几个方面的内容 a. 目录： b. 手册使用指南：介绍本册的主要内容、使用方法，建议 c. 系统配置要求：介绍软件产品使用时对相关软、硬件环境的要求 d. 相关的基础知识：介绍使用本软件产品时，有关的软、硬件的基础知识。其中重点是有关的软件知识。如果此种知识要求比较复杂，如对操作系统、数据库或网络平台软件不可能详细介绍，可在列出本软件产品的特殊要求后，列出建议用户应当学习的知识。 e. 软件产品的总体介绍及特点：相当于一个快速的软件产品入门介绍，使用户能很快地掌握软件产品的总体情况，进入自学。 f. 产品安装指导：介绍软件产品的安装方法以及各种软、硬件环境的设置方法。这里应对安装中可能会出现的问题，如软、硬件冲突，给出解决办法。 g. 菜单功能介绍：按照某种顺序，详细介绍产品的各种菜单、对话框的功能。 h. 产品应用介绍：按照用户典型使用方法，对软件产品菜单功能的组合使用方法进行介绍。即通过一些例子，介绍完成这些任务的操作方法和过程。 i. 使用技巧：介绍使用本产品的快捷方法和技巧，如加速键的定义。 j. 常见问题的排除方法（问与答）：对用户使用容易发生的问题或是用户常犯的错误给出解决方法。 k. 错误介绍（可选）：对于软件产品已知但没有排除的错误，介绍避免的方法。 LI服务信息指南：告诉用户当遇自己不能解决的问题时，应当向哪些部门寻求帮助。注意：不可以把项目组的联系办法写入用户手册。l. 联机帮助使用方法：介绍产品附带的联机帮助系统的使用方法。 m. 附录：介绍其它有关的事项。 4.5.5.用户手册编写中的重要指导原则 4.5.5.1.语言通俗易懂：手册中应当使用大众化的语言，便于使用者理解。 4.5.5.2.对关键词语加以解释：在手册中出现特定的概念或是可能引起岐义的词语应当加以解释，减少误解。 4.5.5.3.说明尽量详细：在对产品功能、使用方法进行介绍时，应尽量详细，让相关知识较少的用户也能读懂。 4.5.5.4.图文并茂：对于软件产品的关键对话框、显示结果，应当附加对应的图片，以增加可视性，方便用户的理解。 4.5.5.5.提示相关内容：在手册中提及本手册中含有的其它内容时，应指出被提及的内容在手册中的位置，便于用户查阅。 4.6.用户手册的更新 用户手册应当及时更新，以保持与软件产品的一致性。一般情况下，至少在软件发布一个新的大版本时，如推出版x.0版时，对手册进行一次全部的更新。对软件的改进版，可采取补充说明的形式，介绍软件的改进之处。 附1 用户手册扉页 版 权 声 明本书版权为方正系统（香港）有限公司海外软件开发中心、XXXX公司所有，未经以上部门书面许可，任何公司、单位和个人不得以任何手段复制本书的全部或部分内容。注：XXXX公司系手册封面中提及的方正系统公司的专业公司。方正系统、方正、Founder是方正集团公司的注册商标XXXX是方正系统海外软件开发中心的产品。（此处XXXX是指本手册介绍的软件的名称）。以下列出手册中提及的其它公司的注册商标。应当注意此处列出的商标应当准确。 对于不能确定的，统一用以下的语言描述：本书中涉及的其它产品商标均为相应公司拥有。方正系统海外软件开发中心用户手册排版要求一、排版规则 1. 每段首行前空两字。 2. 每行之首不能排句号、分号等标点符号，不能排后半个引号、括号等。 3. 行末不能排前半个引号、括号等。 4. 转行时以下情况不能拆开排： 整个数字、年份、连点、数字前后符号(如+30，95%)、简单的化学分子式、上角指数、上角标、下角标、整组缩写的外文字(如DOS)。5. 页码号放切口边。 6. 目录、第一章(篇)等要另页排(即排在单页上)。 7. 标题转行时应在停顿处，转行后左右居中，一般上行长于下行。 8. 标题中可穿插标点，但题末不加标点。 9. 标题不能排在页末(又称背题)。 10. 表题左右居中，太长时应在可停顿处转行，题末不加标点。 11. 表线上、下线用反线，换页接排时要重加表头表题并在右上角加上续表字样。 二、版式说明 1. 版心尺寸：150220 mm2；或39行高39字宽，行距1/2字，误差33mm2；成品尺寸：190260 mm2；正文5号字，书宋体。 2. 书眉线用正线，书眉内容：单眉为章内容，双眉为书名。均用五号字。 3. 页码：放书眉线上，外口，阿拉伯数字。 4. 前3级标题统一规定，更小的标题自已定，但全书要统一格式。 一级标题是章标题，格式如下：另起一面，占五行，居中排，小二号黑体。例如：第2章 二级标题是节标题，格式如下：占三行，居中排，三号黑体。例如：2.3 三级标题是目标题，格式如下：占二行，左齐排，小四号黑体例如：2.3.1 5. 目录：取3级标题，每级向左空两字，单独排页码(即正文页码从第1页开始)。用小五号字。 6. “注：”或“注意：”用黑体