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

《用户手册》写作规范
一 编写原则
1 基本原则
n 面向初、中级用户，语言风格应简炼、通俗。
n 不用不常见的形容词、名词等，避免语句过长（尤其是定语过长）。
n 以循序渐进为原则，力求逻辑清楚、用词准确，同时也要注意写作内容的完整。

2 注意事项
n 在手册中，应写明操作流程，包括整个系统的操作流程，以及每个功能的操作流程。
n 举例应‘多’而‘精’。多指应尽量多为用户提供一些解决方案，将每个功能的各种处理通过举例来说明；精指每个例子的数据量不必太大，例如录入一张发票，有2-3条记录即可。
n 手册中所举的例子应能前后联系。主要例子应同演示数据一致，例如，销售系统中的发货单、出库单、发票、以及帐表应能前后对应；应收系统中的应收单、收款单、帐表应能前后对应。
n 各手册中所引用的公用目录信息应一致（见系统管理手册）。
n 在每一部的结尾，都增加一个‘现在该往何处去’的说明，以说明到目前为止，用户已经做了哪些工作，下一步该怎样做。

二 格式规范
1 目录规范
第Ｘ部 ＺＺＺＺＺ ............................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 ‘■’大项说明——用于无先后次序的明细条目的说明
n ‘◆’小项说明——用于在大项下的无先后次序的小项说明
n ‘●’提醒说明——用于在要诀、提醒、警告等文字中的分项说明
n ‘N=1、2…’ ——操作步骤以阿拉伯数字以表明次序
n ‘X=（1）、（2）…’ ——每步操作步骤的小步骤
n 【例 X-N】 —— 举例，按章编号。例3-1、例3-2….
n & 技术细节——这个图标提醒你，这段讨论还是跳过去为好
n J 要诀——这个图标提醒你，就要有捷径或其它与论题有关的有用线索了。
n % 提醒——这个图标提醒你，如果你想把事情做得好些，就要牢记这些信息。
n M 警告——如果你想避免灾难，就要牢记这些信息。
n 菜单项用【XXX】表示。例如【采购入库单】
n 图标用〖XXX〗表示。例如〖增加〗
n 快捷键用[XXX]表示。例如[ Ctrl+B]
n 界面中的字段和项目用“ XXX ”引用。例如“余额方向”选择框

3 插图表规范
n 表格按章编号 表XX-1 表XX-2 ...表XX-N
n 图按章编号 图XX-1 图XX-2 .. 图 XX-N
n 图表编号放在图表正下居中

4 页面格式
n 章与节间空两行；节与节间空二行；节与本节内容间空一行；两表(图)间空二行；其它节内内容间空行不得超过一行
n 章、节、小节顶头写
n 录入文字时，左侧起始处一律不要加入空格，各级标题及正文间层次通过<格式>菜单中<段落>的<左缩进>功能完成；也可直接用鼠标移动横标尺上缩进标记进行设置。
u 一级标题（篇）、二级标题（章）、三级标题（1.1）、四级标题（1.1.1）、五级标题（1.1.1.1）：位于距页面最左侧起始处0.5CM处（段落左缩进0.5CM）。
u ……级标题、章节内标题（如1.）、正文：位于距页面最左侧起始处2.5CM处（段落左缩进2.5CM）。
u 根据实际需要录入所需层次。
n 在段落内不要加入硬回车，只在分段处使用硬回车。
n 在全角状态下，输入中文及中文行中标点；半角状态下输入英文、数字及英文行中标点。注：数字中涉及到的分隔符、小数点用半角；图表连接符“－”用全角。

5 页眉规范
n 左页页眉：XX页 第X章 XXXX
n 右页页眉：第X部 XXXX XX页

6 字体规范
n 正文：细园体 11号
n 字距：标准
n 行距：固定值18镑

7 页面设置
n 纸张选择：B5纸
n 页边距：上—2.4CM，下—3.9CM，左—1CM，右—1CM
n 页眉（与边界距离）：1.4CM
n 页脚：0CM
n 装订线：0.8CM
n 其它为缺省值。

8 关于提醒的背景
J、%、M 等引出的字段，要设置灰色的背景。
【操作步骤】
1. 首先选中要设置背景的段落
2. 选中‘格式’菜单项下‘边框和底纹’
3. 选中‘底纹’页签。
4. 设置底纹浓度为25%

9 关于举例的序号问题：
n 在正文段落中所举的很简短的小例子可以不必排序编号。
n 用于说明操作事项或者比较复杂例子应该统一编号。

三 内容规范

如何使用本手册
n 本手册的内容结构——介绍手册的结构，以及用户该如何使用手册
n 系统和手册中术语的解释——介绍手册中常用名词的基本概念
n 本手册与系统管理手册关系
第一部 应用方案
第1章 系统介绍
1.1 系统功能
1.2 产品接口
1.3 如何使用本系统功能（应用解决方案）
1.1.2 。。。。。 -- 按不同的应用对象，类型，部门，范围提供方案，
1.1.3 。。。
第2章 系统操作流程—用流程图的形式介绍本系统的操作流程，并对每步骤加以说明
2.1 新用户操作流程——介绍用户第一年使用本系统的操作步骤，从安装开始对每步操作及该步所用的模块加以说明，应按不同的应用方案，制定不同的操作流程，使用户完全能凭借手册提供的流程完成工作。
2.2 老用户操作流程——主要介绍用户以后年度或升级使用本系统的操作流程，重点介绍新旧版或上下年之间的衔接，其它同上
2.3 。。。。。
第3章 应用准备—说明应用前应准备哪些工作，如哪些期初数据，哪些目录档案，分工等
3．1 XXX
3．X XXX
第二部 应用操作
第4章 系统初始
4.1 。。。----按业务流程顺序介绍每个功能
4.2 ．。。。
4． X系统选项
4． X系统初始完整性检查
第5章 XXXXX
5．X XXXX ——按业务流程顺序介绍每个功能。
5．X XXXX
第6章 XXX
第x章XXXX

第三部附录
附录A 图标操作一栏表
附录B XXX XX版如何升级到本系统

四 模版
1 如何使用本手册编写模版
参见帐务7。0手册阅读指南部分

2 每一部最后加：
J 现在该往哪里去？
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

现列举《AC系统使用手册》中的该项说明，仅供大家参考：
第一部后的说明：
J 现在该往哪里去？
■ 如果您刚刚购买系统管理程序和应付帐款系统，请遵循‘系统管理使用手册’中的指南，把模块安装在您的计算机上。如果您已经安装了系统管理程序，可以按‘系统管理使用手册’中的指示，安装应付帐款系统。
■ 如果您已经安装了应付帐款系统，在您开始用自己的数据使用应付帐款系统之前，我们建议您读本手册的第二部‘系统的操作流程’和第三部‘使用前须知’。
■ 如果您准备好建立您自己的应付帐款系统时，请遵循本手册第四部‘使用入门’的指示。
第二部后的说明：
J 现在该往哪里去？
■ 如果您已经熟悉了系统的操作流程，在您开始用自己的数据使用应付帐款系统之前，我们建议您读本手册的第三部‘使用前须知’。
■ 如果您不熟悉系统管理程序的操作方式，您应该阅读‘系统管理使用手册’。
第三部后的说明：
J 现在该往哪里去？
■ 如果您准备好建立您自己的应付帐款系统时，请遵循本手册第四部‘使用入门’的指示。
■ 如果您不熟悉系统管理程序的操作方式，您应该阅读‘系统管理使用手册’。
第四部后的说明：
J 现在该往哪里去？
现在，您已经掌握了本系统的使用方法。

3 使用操作模版

第Ｘ章（或X.X） ＸＸＸＸＸＸ

XXXXXXXXXXXX本章（节）概述（模块操作的业务意义，完成的主要功能等）XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

【(本章（节）主要画面)或(操作流程)】 （如没有可不写）

X.X（或X.X.X） ＸＸＸＸＸＸＸＸ

XXXXXXX模块操作的业务意义，完成的主要功能说明XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

【本节（小节）主要画面或操作流程】 （如没有可不写）

【各栏目说明】 （如没有可不写）
■ XXXX:XXXXXXXXXXX
■ XXXX:XXXXXXXXXXX

【操作步骤】 / 【操作方法】 （不能分出步骤的写为操作方法）
用操作方法时以下可用 如何XXX
（例： 如何开一新发票 然后再按操作步骤写）
1.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
[①. xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxx]
[画面][表格]
[②. xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxx]
[画面][表格]

2.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
[画面][表格]

% 注意
l XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
l XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

【例 X-N】
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

本手册适用于财务及企业管理软件事业部UFERP8.0 系列产品。