产品使用手册写作规范.doc

PAGE 8 第X章 XXXX UF/QP/2-10/QI/006 M产品使用手册写作规范 第X部 XXXX PAGE 7 《用户手册》写作规范 一 编写原则 1 基本原则 面向初、中级用户，语言风格应简炼、通俗。 不用不常见的形容词、名词等，避免语句过长（尤其是定语过长）。 以循序渐进为原则，力求逻辑清楚、用词准确，同时也要注意写作内容的完整。 2 注意事项 在手册中，应写明操作流程，包括整个系统的操作流程，以及每个功能的操作流程。 举例应‘多’而‘精’。多指应尽量多为用户提供一些解决方案，将每个功能的各种处理通过举例来说明；精指每个例子的数据量不必太大，例如录入一张发票，有2-3条记录即可。 手册中所举的例子应能前后联系。主要例子应同演示数据一致，例如，销售系统中的发货单、出库单、发票、以及帐表应能前后对应；应收系统中的应收单、收款单、帐表应能前后对应。 各手册中所引用的公用目录信息应一致（见系统管理手册）。 在每一部的结尾，都增加一个‘现在该往何处去’的说明，以说明到目前为止，用户已经做了哪些工作，下一步该怎样做。 二 格式规范 目录规范 第Ｘ部 ＺＺＺＺＺ X 第Ｘ章 ＺＺＺＺＺ X x.x ＺＺＺＺＺ X x.x.x ＺＺＺＺＺ X x.x.x.x ＺＺＺＺＺＺX x.x.x.x ＺＺＺＺＺＺX x.x.x ＺＺＺＺＺ X ... x.x ＺＺＺＺＺ X 第Ｘ章 ＺＺＺＺＺ X 第Ｘ部 ＺＺＺＺＺX 2 标题符号规范 ‘■’大项说明——用于无先后次序的明细条目的说明 ‘◆’小项说明——用于在大项下的无先后次序的小项说明 ‘●’提醒说明——用于在要诀、提醒、警告等文字中的分项说明 ‘N=1、2…’ ——操作步骤以阿拉伯数字以表明次序 ‘X=（1）、（2）…’ ——每步操作步骤的小步骤 【例 X-N】 —— 举例，按章编号。例3-1、例3-2…. ? 技术细节——这个图标提醒你，这段讨论还是跳过去为好 ? 要诀——这个图标提醒你，就要有捷径或其它与论题有关的有用线索了。 ? 提醒——这个图标提醒你，如果你想把事情做得好些，就要牢记这些信息。 ? 警告——如果你想避免灾难，就要牢记这些信息。 菜单项用【XXX】表示。例如【采购入库单】 图标用〖XXX〗表示。例如〖增加〗 快捷键用[XXX]表示。例如[ Ctrl+B] 界面中的字段和项目用“ XXX ”引用。例如“余额方向”选择框 3 插图表规范 表格按章编号 表XX-1 表XX-2 ...表XX-N 图按章编号 图XX-1 图XX-2 .. 图 XX-N 图表编号放在图表正下居中 4 页面格式 章与节间空两行；节与节间空二行；节与本节内容间空一行；两表(图)间空二行；其它节内内容间空行不得超过一行 章、节、小节顶头写 录入文字时，左侧起始处一律不要加入空格，各级标题及正文间层次通过格式菜单中段落的左缩进功能完成；也可直接用鼠标移动横标尺上缩进标记进行设置。 一级标题（篇）、二级标题（章）、三级标题（1.1）、四级标题（1.1.1）、五级标题（1.1.1.1）：位于距页面最左侧起始处0.5CM处（段落左缩进0.5CM）。 ……级标题、章节内标题（如1.）、正文：位于距页面最左侧起始处2.5CM处（段落左缩进2.5CM）。 根据实际需要录入所需层次。 在段落内不要加入硬回车，只在分段处使用硬回车。 在全角状态下，输入中文及中文行中标点；半角状态下输入英文、数字及英文行中标点。注：数字中涉及到的分隔符、小数点用半角；图表连接符“－”用全角。 5 页眉规范 左页页眉：XX页 第X章 XXXX 右页页眉：第X部 XXXX XX页 6 字体规范 正文：细园体 11号 字距：标准 行距：固定值18镑 页面设置 纸张选择：B5纸 页边距：上—2.4CM，下—3.9CM，左—1CM，右—1CM 页眉（与边界距离）：1.4CM 页脚：0CM 装订线：0.8CM 其它为缺省值。 8 关于提醒的背景 symbol 74 \f Wingdings \s 11J、symbol 37 \f Wingdings \s 11%、symbol 77 \f