第1部分第1部分，共4部分：规划用户手册

1. 1进行受众分析。用户手册应该是为那些购买你的产品或服务并阅读用户手册的人编写的。受众分析将告诉你谁是你的主要或目标受众，并将指导你的写作。与将使用你的设备的人交谈。在受控条件下向测试用户提供设备原型和用户手册草稿。征求这些测试用户对用户指南中不明显或不易混淆的内容的反馈，并根据这些反馈将更改纳入用户手册中。你永远无法取悦你的所有观众；编写适合目标或最大受众的手册。想想观众的年龄、健康状况（他们是否有疾病、学习障碍或残疾？），以及教育水平，以确定编写用户指南的最佳方法。

2. 2协调用户手册的设计。如果你是帮助设计和开发设备或产品的团队的一员，可能很难客观地看待产品以解释其操作。因此，您可能需要征求作者（最好是有编写说明经验的作者）和平面设计师的建议，以帮助您起草用户手册。你可以从外部咨询公司或你自己的公司或组织中选择这些人。

3. 3进行任务分析。任务分析是识别和组织使用设备所需步骤的过程。彻底的任务分析将确定每个步骤所需的材料和设备（如电池、药物或其他用户提供的产品），以及每个步骤可能需要的操作、错误和故障排除建议。如果您的产品可以执行许多不同的任务或子任务，则需要对每个任务执行任务分析。例如，在汽车中，你可以按喇叭，系好安全带，打开或关闭大灯。根据需要为每一项创建任务分析。

4. 4确保您的产品符合标签和营销许可要求。这些要求确保产品的生产考虑到用户安全，并将限制用户暴露在辐射和触电等危险条件下。广告必须清楚地说明产品的用途和基本操作指南，并且在编写用户手册时应使用这些来源。为了使产品的用户手册有效，它需要与直接贴在产品上的标签一致。在编写使用说明书之前，请确保您的设备已获得合法的销售许可。

5. 5.决定手册的布局。有几种重要的方法可以简化手册。你应该在每一节的开头放一个粗体标题，每个单词都大写。例如，“设置设备”、“操作设备”和“故障排除”都可以是粗体部分标题。另一种简化手册的方法是使用两列，一列在右边有文本，另一列就在文本的左边有项目符号、数字或警告标志或红色感叹号等小图标。您的手册可能主要是图像，每个图像下都有一些文字来解释设备，也可能主要是文字，只有几个附带的图像。您还可以使用流程图为用户提供指导。在编写用户手册时，请思考您的产品以及每种方法的用途。但是，避免在手册中混合不同的布局。选择一个并坚持下去。

第2部分第2部分，共4部分：包括基本信息

1. 1合理组织手册。用户手册应以用户认为最有益的方式进行。将手册拆分为对产品使用有意义的章节，并在手册前面包含目录，以便快速找到每个章节。对于较长的手册，目录尤为必要。当有许多术语需要解释，而你的听众可能不熟悉时，就需要一个词汇表或索引。但是，不建议使用词汇表；最好的选择是在手册文本中解释容易混淆的术语。如果选择包含术语表，请将其放在手册前面，目录的后面。只有在手册中有多个表格或图形时，才需要表格或图形列表。应该解释但不能在手册的另一点解释的事情需要一个附录，因为它会干扰流程和焦点。

2. 2包括必要的警告。一般警告或警告信息应提供有关不当使用产品可能造成的潜在威胁的信息，包括死亡或重伤。这些警告应该放在手册封面之后的最前面，以便用户首先看到。在建议潜在危险步骤之后或之前，用户手册的文本中还应包含特定警告。例如，电动设备的一般警告可能是避免在下雨时使用。具体的指导可能是，在插入设备之前，确保双手和设备都干燥。包括图形（如骷髅和交叉骨）或不同颜色的文本（如红色文本），以区分警告与用户手册中的其他说明，并提请用户注意。你可以解释遵循手册而不是独立工作的好处。

3. 3描述设备。你的描述应该包括对设备用途的书面解释和描述设备外观的小图形。图形应正确标记和命名设备包括的所有开关、旋钮和可连接部件。

4. 4包括安装说明。设置部分应包括有关如何准备使用产品或设备的基本信息。如果家庭用户无法构建或设置设备，请在设置部分顶部的粗体标题中明确说明这一事实。您还应该包括：零件清单拆包说明与设置相关的警告错误设置的结果如果设置遇到困难，请致电谁

5. 5提供有关操作的信息。本节是用户手册的主要部分，应提供有关如何使用设备的具体详细信息。从使用设备的基本准备开始，比如插上电源或洗手。接下来是描述如何使用该设备的逻辑编号步骤，以及反馈（例如，“你会听到一声咔嗒……”）用户可以预期何时正确使用设备。在本节末尾，用户应参考故障排除部分，以解决无法快速解释的问题。包括必要的图形。有些步骤最好用图片和文字来解释。考虑在用户手册中使用照片或插图。与每一节一样，在本节中，一定要包括有关不当使用或操作的相关安全警告。例如，您可能会警告电锯用户在服用某些药物时不要饮酒或使用电锯。如果你认为用户将受益，考虑包括链接到在线视频，演示设备的正确使用和操作。你可以在本节的开头，或者在每一步的结尾（如果视频只演示了一个步骤），加入这些视频。尽量让你的指示尽可能简单。如果你的手册变得太复杂，你可能会失去很多人。

6. 6.在结尾处附上产品摘要。为了提供基本的操作步骤，总结应该放在手册末尾，索引之前。这应该是操作信息部分的简化、精简版本，并且不应超过一页。总结如何使用设备或产品。包括基本警告、说明如何使用产品的编号步骤，以及指导用户提供帮助的电话号码或电子邮件地址。如果您希望用户删除汇总表或需要经常查阅汇总表，可以将其打印在删除的层压卡片或厚卡片上，以便于用户随身携带和参考。或者，在产品上直接添加一份摘要表，以便用户可以快速方便地查阅。

第3部分第3部分，共4部分：描述产品护理

1. 1说明如何清洁设备。如果您的设备或产品需要清洁，请说明如何清洁。一定要列举所需的清洁用品。告知读者他们应该多久清洁一次。然后，就像您在用户手册的任何其他章节中所做的那样，包括关于如何进行清洁的编号分步说明。如果清洁需要对产品进行一些拆卸，或拆除某个或多个零件，请确保包括如何拆卸的详细信息。包括关于未能清洁设备的结果的警告将被删除。例如，你可能会说，“不清洁将导致低于最佳性能。”

2. 2向用户介绍如何进行基本维护。如果产品或设备可以由用户维修以纠正性能问题，请包括有关用户如何进行维修的编号说明。例如，如果电池每使用300小时就需要更换一次，请说明如何检查电池是否需要更换，如何取出失效的电池，以及如何插入新电池。如果有些维护任务只能由经过认证的技术人员执行，请将手册的维护部分分为两部分。

3. 3讨论存储选项。如有必要，用户手册应解释如何正确存储产品或设备。您还应该包括有关为什么需要存储的信息，以及不当存储的结果。例如，你可能会写道：“将产品储存在阴凉干燥的地方。储存不当可能会因水分积聚而缩短产品的使用寿命。”“不要将产品暴露在高温下或储存在高于120°F（49°C）的温度下。这样做可能会导致燃烧。”

4. 4包括故障排除信息。您可以将此部分组织为常见问题及其解决方案的列表。将类似问题按逻辑标题分组。这样，用户可以快速发现具体问题。例如，如果电脑显示蓝屏时出现了几个问题，请将它们列在“常见屏幕问题”这样的子标题下您还应在本节中提供客户服务的电话号码和/或电子邮件。

第4部分第4部分，共4部分：编写可读手册

1. 1阅读其他用户手册。在为自己的产品编写手册之前，先看看其他有效的用户手册。注意句子的结构、选词和句子风格。苹果、谷歌和微软等主要品牌都会提供强大、有效的用户手册，帮助你编写出更为深思熟虑的用户手册。不要只是阅读任何用户手册。阅读您销售的类似产品的手册。例如，如果你在销售婴儿产品，请阅读婴儿手册，而不是技术手册。

2. 2选择你的标准。将拼写、单词选择和措辞标准化将使用户手册更加友好。在编写用户手册时，《芝加哥风格手册》和《微软风格手册》也可能是有用的风格指南；咨询两者，看看其中一个是否适用于您的手册。例如，不要在用户手册中同时使用“开/关开关”和“电源开关”，而是选择一个或另一个术语并坚持使用。

3. 3使用主动语态。主动语态是一种写作视角，它从用户的角度解释事情。它比被动语态更容易理解，被动语态中的主语没有定义。尝试海明威应用程序（www.hemmingwayapp.com）来识别你写作中的被动段落。检查这两个句子，第一个是主动的，另一个是被动的，每一个例子：你应该慢慢小心地打开包装。包装应缓慢小心地打开。

4. 4编写编号的指令。数字顺序的说明将帮助读者更专注于使用、连接或构建相关产品的过程。不要写一个冗长、杂乱无章的段落，或一系列没有编号的段落，而是用简单、明确的步骤编写用户手册，每个步骤都有明确的编号。

5. 5.从命令开始每一步。祈使句是一个面向动作的动词。通过用动词开始每一步，你将提示读者完成这一步所需的动作。例如，根据您所写的产品，您可能会以“连接”、“附加”或“幻灯片”等命令开始步骤但是，不要以系统响应开始步骤。例如，如果屏幕将变为蓝色并闪烁，请不要以“屏幕将闪烁并变为蓝色”开始该步骤试试：“按住home键。屏幕将闪烁并变成蓝色。”

6. 6.决定你将使用什么样的词汇。如果你正在写一本溜溜球用户手册，你的读者大多是小孩子。使用简单的单词和词汇来解释溜溜球是如何工作的。如果你正在为扫描电子显微镜编写用户手册，你的读者将是训练有素的科学家，他们能够理解非常详细的信息，所以不要回避使用专门的词汇或细微的解释。一般来说，尽量避免使用行话和技术性语言。为了对最广泛的用户有效，试着在六到七年级的阅读水平上写作。

7. 7如果要将产品运往海外，请确保翻译准确。请一名翻译将您的用户手册翻译成您将产品运送到的国家的母语。或者，使用在线翻译应用程序，但要求母语人士阅读并编辑翻译错误。如果受众中有多个语言组，请将用户手册翻译成每种相关语言。译者应该熟悉产品，因为目标语言中的特定术语可能有不同的单词，而不是逐字翻译。

8. 8.保持写作简短。不要用几个长段落，而要用许多短段落。在每个部分中寻找逻辑上的中断，并将有用的信息分成一两个句子块。这同样适用于句子层面。保持你的句子简短，而不是长篇大论。如果一个步骤开始变得太长，把它分成更小的步骤。这不会导致字数下降，但换行符会使阅读更容易。

9. 9.校对手册。由于语法和拼写错误，手册可能会失去可信度。让同事或技术作者编辑并校对手册。除了拼写和语法之外，校对者还应该注意：被动语态歧义或令人困惑的语言复杂的句子结构过长的段落

• 人们以不同的方式学习；如果可能且适当，在手册中包括视觉助手或在线视频链接，以帮助视觉学习者。