写好操作手册的秘笈

写好操作手册的秘笈

操作手册是随机(产品)文档,是必须提供给用户的法律性文件,使其能够了解产品整体结构、性能(功能)、安装和拆卸、操作和保养,特别是安全注意事项。从而能够安全、高效、经济、环保、长寿命地使用产品。如何高效地编制高品质的操作手册呢?

首先,操作手册要贯彻极简主义原则,这一原则是一种以用户为中心的方法,确保操作手册为目标受众提供必要的信息,安全、高效并有效地使用产品。极简主义原则主要包括:

  1. 安全信息要突出并确保描述的一致性;

  2. 文字表达要清晰/避免含糊和误解;

  3. 尽量使用插图代替文字描述(一张好图胜过千言万语);

  4. 尽量使用列表而不是长篇段落,营造更清晰的逻辑概念;

  5. 涉及的技术术语要正确且保持前后一致性;

  6. 衡量单位采用国际标准。

其次,编制操作手册需要专业工具