产品使用手册写作规范

《用户手册》写作法律规范一 编写原则1 基本原则面对初、中级用户，语言风格应简炼、通俗。不用不常见的形容词、名词等，避开语句过长（尤其是定语过长）。以循序渐进为原则，力求逻辑清楚、用词准确，同时也要注意写作内容的完整。2 注意事项在手册中，应写明操作流程，包括整个系统的操作流程，以及每个功能的操作流程。举例应‘多’而‘精’。多指应尽量多为用户提供一些解决方案，将每个功能的各种处理通过举例来说明；精指每个例子的数据量不必太大，例如录入一张发票，有 2-3条记录即可。手册中所举的例子应能前后联系。主要例子应同演示数据一致 ，例如，销售系统中的发货单、出库单、发票、以及帐表应能前后对应；应收系统中的应收单、收款单、帐表应能前后对应。各手册中所引用的公用目录信息应一致（见系统管理手册）。在每一部的结尾，都增加一个‘现在该往何处去’的说明，以说明到目前为止，用户已经做了哪些工作，下一步该怎样做。二 格式法律规范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=1、2…’ ——操作步骤以阿拉伯数字以表明次序‘X=（1）、（2）…’ ——每步操作步骤的小步骤【例 X-N】 —— 举例，按章编号。例 3-1、例 3-2….  技术细节——这个图标提醒你，这段讨论还是跳过去为好  要诀——这个图标提醒你，就要有捷径或其它与论题有关的有用线索了。  提醒——这个图标提醒你，假如你想把事情做得好些，就要牢记这些信息。   警告——假如你想避开灾难，就要牢记这些信息。  菜单项用【XXX】表示。例如【采购入库单】 图标用〖XXX〗表示...