用户手册编写规范.doc

用户手册编写规范 文档标识：comtop-std-ugud 深圳市康拓普信息技术有限公司 Shenzhen Comtop Information Technology Co.,Ltd. 二六年十一月 用户手册编写规范 深圳市康拓普信息技术有限公司 修订记录 版本版本说明说明作者作者批准批准批准日期批准日期 1.0新增何明辉 2.0修订何明辉 所有权声明： 深圳市康拓普信息技术有限公司 版权所有 不得复制 Copyright 2006 by Shenzhen Comtop Information Technology Co., Ltd. - 1 - 目 录 1目的目的1 2适用范围适用范围.1 3编写规范编写规范.1 3.1使用 ROBOHELP1 3.2编写规范 1 3.2.1文件规范.1 3.2.2页面规范.3 3.3导出规范 4 深圳市康拓普信息技术有限公司 第 1 页 1 目的目的 1.使软件项目的用户手册编写工作有章可寻。 2.使编写的用户手册更加完整和规范。 2 适用范围适用范围 深圳市康拓普信息技术有限公司的所有软件测试项目。 3 编写规范编写规范 3.1 使用使用 RoboHelp 参见“Robohelp 编写在线帮助使用说明.doc” 。 文档存放位置：testSCMTEST GROUPTest Document6-Regulation TemplateSupportFile 3.2 编写规范编写规范 3.2.1 文件规范文件规范 1.用户手册的文件名使用系统名称+下划线+UserGuide 组成。比如：技改科技修理项目管理系统 的用户手册文件名为：Itmpms_UserGuide。 2.用户手册右上角的 RoboHelp 图标需改为公司名称（即：Comtop） 。 3.用 RoboHelp 工具编写用户手册时必须使用标准模板。模板参见“template_UserGuide.rar” 。 如下图（二）的 Template 字段选择了已经定好的物资管理帮助文档模板。标准模板中的格式规 定为：标题 14 号；注意标题 11 号加粗；概述、正文和注意事项均为 10 号字体；概述需首行 缩进 2 个汉字，概述中的参见描述使用带圆点项目符号的正文格式；正文和注意事项之间需空 一行，且格式为正文格式；概述、正文和注意事项的行间距均为：1.5Lines；模板中需去掉所 有空格。 标准模板文档存放位置：testSCMTEST GROUPUser Guidetemplate user guide。 4.用户手册的目录结构按照软件系统的菜单层次建立，如下图（一）的菜单层次所示。页面上的 功能名称在目录结构中的先后顺序按照该功能在系统中的主次排列。 深圳市康拓普信息技术有限公司 第 2 页 图（一） 5.新增一个页面的 Topic Title、File Name 和页面标题这 3 个名称必须保持一致。如下图（二）和 图（三）所示。 图（二） 深圳市康拓普信息技术有限公司 第 3 页 图（三） 6.整个系统中的每个页面的 File Name 必须唯一。 7.每个页面的 Topic Title 命名方式尽量使用动宾结构短语。比如：上报申购单。 8.页面上使用到的图片文件名必须按一定的规范统一命名。在图片名称前面加上作者名字的拼音 缩写，比如：张三使用的一张删除功能的图片可以这样命名：zhs_delete.gif。这样命名后，在 合并多人同时编写的用户手册时，就不会相互覆盖相同文件名的图片。并且，必须先分别命名 各自的图片名称后再合并。 9.删除用户手册中没有用到的图片文件。而且把把各分系统的图片放在相应的目录下。 10. 系统中出现次数较多的功能需放在通用性功能中。 11. 每个模块必须增加概述页面。用简单、准确和清晰的语言描述出此模块的主要功能。 12. 在 Project 标签页新增了页面后，需把该页面添加到 Topics 中。 3.2.2 页面规范页面规范 1.多数模块都有的、页面中非主要的通用性功能需在概述页面加以说明并使用超链接。使用超链 接的描述说明统一为：“XX 请参见通用性功能的 XX” 。比如：查询请参见通用性功能的查 询。且使用正文的格式。 2.在每个模块概述里面的多个“参见”说明要分行书写。 3.页面正文中的一个步骤为一个操作。比如：1.点击【新增】按钮。2.填写项目进度。 4.正文中的页面名称用空心中括号 ；功能按钮用实心中括号【 】 ；下拉列表、菜单和属性字 段名称用双引号“ ” ；“概述”和“注意事项”中的功能按钮和页面名称原则上都不需要加括 号或引号，容易引起语义混淆的可加上双引号。 5.统一使用点击和双击 XX 按钮或图标（点击即代表单击） 。比如：“点击【删除】按钮” 。 6.描述中最好不要使用“没有” 、 “只有” 、 “不超过”和“不成功”等字样的描述。 深圳市康拓普信息技术有限公司 第 4 页 建议这样写：“有” 、 “最大”等，即只描述系统中已有的和正确的功能。 7.不要在每个步骤中加“首先”或“其次”之类的词语。 8.系统中的一些重要提示、注意和有特色功能的地方需要在注意事项里加以说明。 9.描述中避免使用难以理解的计算机专业词汇。比如：字段等。 10. 描述中的“窗口”用“页面”一词替换。 11. 页面上的控件名称描述要准确。比如：“操作分类下拉列表”不能写为“操作分类下拉菜单” 。 12. 系统中比较重要的功能和通用性功能中的操作需要展开并分步骤写清楚。比如：选择人员的操 作需要分为按组织显示、不按组织显示、在所属部门的用户中以及在通讯录中选择这四种情况 分别描述选择步骤。 13. 页面中无需使用“返回” 、 “上一页”以及“下一页”等超链接。 14. 用户手册中的图片大小适当，并且居中显示。 15. 去掉页面上多余的空格。否则，导出到 Word 后的文档中还要逐一清除。 16. 图表索引的文字用“（图）图片名称”描述。如：（图）新增申购单。 3.3 导出规范导出规范 1.导出 Word 格式的用户手册时需要加上文档目录、系统简介、系统运行环境以及图表索引等。 详细的说明请参见“Robohelp 导出 word 操作说明.doc” 。 文档存放位置：testSCMTEST GROUPTest Document6-Regulation T