内容

• 踩
• 第4部分（共1部分）：规划用户手册
• 第2部分（共4部分）：嵌入基本信息
• 第4部分的第3部分：描述产品维护
• 第4部分（共4部分）：编写易读的手册
• 尖端

软件，计算机，游戏和设备需要用户手册；指导说明如何使用产品（以及如何不使用）。用户手册是具有特定结构的正式文档，必须由完全了解产品的人员（例如技术作家或产品设计师）编写。编写有效的用户手册要求您知道谁将使用该产品，并且在铭记这些用户的同时编写手册。保持文字清晰，准确和简单，以确保无忧的用户体验。

踩

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

1. 进行用户分析。 应该为用户（即购买您的产品或服务并阅读用户手册的用户）编写用户手册。用户分析将告诉您您的主要受众或目标受众是谁，并将指导您编写文本。
   • 与将使用您的设备的人交谈。向测试用户提供设备原型，并在受控条件下起草用户手册。要求这些测试用户提供有关用户指南中不清楚或令人困惑的问题的反馈，并根据此反馈对用户指南进行更改。
   • 您永远无法满足整个听众的需求。编写针对目标受众或最大受众的手册。
   • 考虑年龄，健康状况（他们是否有任何疾病，学习障碍或残障？）以及受众的教育水平，以确定编写用户手册的最佳方法。
2. 协调用户手册的设计。 如果您是帮助设计和开发设备或产品的团队的一员，那么很难客观地查看产品以解释其工作原理。因此，您应该征询作家（最好是具有撰写指导的经验的人）和图形设计师的建议，以帮助您准备用户手册。您可以通过外部顾问或从您自己的公司或组织中选择这些人。
3. 做任务分析。 作业分析是识别和组织使用设备所需步骤的过程。全面的作业分析可确定每个步骤所需的材料和设备（例如电池，药品或其他用户提供的产品），以及每个步骤可能需要的操作，错误和故障排除建议。
   • 如果您的产品可以执行许多不同的任务或子任务，则必须对每个任务执行任务分析。例如：在汽车中，您可以鸣喇叭，系好安全带并打开或关闭大灯。如有必要，请对每一项进行工作分析。
4. 确保您的产品符合标签和营销授权的要求。 这些要求确保在制造产品时考虑到用户的安全，并且限制了用户在危险条件下的暴露，例如辐射和触电。广告应明确说明产品的用途和基本操作准则，并且在编写用户手册时应使用这些资源。
   • 为了使产品的用户手册生效，必须按照直接粘贴在产品上的标签进行书写。
   • 在编写用户手册之前，请确保您的设备已获得正式的销售许可。
5. 确定手册的布局。 有几种重要的方法可以简化您的手册。您必须在每个部分的开头放置一个粗体标题，并用大写字母表示每个单词。例如，“设置设备”，“操作设备”和“故障排除”都可以是粗体部分标题。
   • 简化指南的另一种方法是使用两列，一列在文本的右侧，另一列在文本的左侧，带有项目符号，数字或小图标，例如警告标记或红色感叹号。
   • 该手册可能主要由在每个图像下方带有一些文本的图像组成，以说明设备，或者可能主要是仅带有少量伴随图像的文本。您还可以使用流程图来指导用户。考虑一下您的产品以及每种方法如何帮助您编写手册。但是，请避免在一本手册中混合使用不同的布局。选择一个并坚持下去。

第2部分（共4部分）：嵌入基本信息

1. 从逻辑上组织手册。 该手册的结构应使用户能从中获得最大收益。将手册分成适合使用产品的章节或章节，并在手册的开头包含目录，以便可以快速找到每个章节。
   • 对于较长的手册，特别需要目录。
   • 如果有很多术语可以解释您的听众可能不熟悉，则需要使用词汇表或索引。但是，不建议使用词汇表。最好的选择是在手册本身的文本中解释令人困惑的术语。如果选择包含词汇表，请将其放在手册的前面，紧挨目录的后面。
   • 仅当手册中有多个表格或数字时，才需要表格或数字的列表。
   • 需要附录的内容需要在手册中进行解释，但不能在其他地方进行解释，因为这会干扰流程和重点。
2. 包括必要的警告。 一般警告或预防信息应提供有关因不正确使用产品而导致的潜在危险的信息，包括死亡或严重伤害。这些警告应放在手册的最前面，首页之后，以便用户首先看到它们。建议在可能存在危险的步骤之后或之前，在手册文本中还应包含特定的警告。
   • 例如，在下雨天时，电器的一般警告可能是不要使用它。
   • 一种特定的说明可能是在将设备插入电源插座之前，确保双手和设备都处于干燥状态。
   • 提供图像（例如骷髅和交叉骨）或不同颜色的文本（例如红色文本）以区分警告和IFU中的其他指示，并引起用户的注意。
3. 描述设备。 您的描述应包括有关设备用途的书面说明以及有关设备外观的小图形表示。该图应标记并命名设备中包含的所有开关，按钮和可连接部件。
4. 提供安装说明。 安装部分应包含有关如何准备使用产品或设备的基本信息。如果家庭用户无法构建或设置设备，请在安装部分顶部的粗体标题中明确说明。您还应该包括以下内容：
   • 零件清单
   • 开箱说明
   • 安装警告
   • 错误安装的后果
   • 安装过程中遇到困难时应与谁联系
5. 提供有关操作的信息。 本部分是用户手册中最重要的部分，应提供有关如何使用该设备的具体详细信息。从使用本机的基本准备工作开始，例如插入电源线或洗手。继续进行逻辑编号的步骤，描述如何使用设备以及用户正确使用设备时可能期望得到的任何反馈（例如，“您会听到喀哒声……”）。
   • 在本章的最后，应使用户参考“故障排除”一章，以解决无法快速解释的问题。
   • 将图像放置在必要的地方。最好用图片和文字来说明一些步骤。考虑使用手册中的照片或插图。
   • 与任何部分一样，在此部分中，您应包括有关不当使用或操作的相关安全警告。例如，您可以警告电锯使用者在使用某些药物时不要喝酒或使用电锯。
   • 如果您认为用户会从中受益，请考虑添加指向在线视频的链接，以证明设备的正确使用和操作。您可以在本节开始时录制这些视频，也可以在每一步结束时录制视频（对于仅说明一个步骤的视频）。
6. 最后附上产品摘要。 该摘要应出现在手册的末尾，索引之前，以提供基本的操作步骤。这应该是操作信息的简化精简版本，并且不得超过一页。总结如何使用设备或产品。包括基本警报，带编号的步骤（说明如何使用该产品）以及引导用户寻求帮助的电话号码或电子邮件地址。
   • 如果希望用户经常删除或参考摘要表，则可以将其打印在可移动的层压卡或厚纸板上，以方便用户携带和参考。
   • 或者，您可以将摘要直接应用于产品，以供用户快速轻松地参考。

第4部分的第3部分：描述产品维护

1. 说明如何清洁设备。 如果您的设备或产品需要清洁，请说明如何进行清洁。列出所需的清洁剂。告诉读者多久清洁一次。然后，与本手册的任何其他部分一样，包括有关如何清洁它的带编号的逐步说明。
   • 如果清洁要求拆卸产品或拆卸特定零件，请说明如何拆卸产品。
   • 提供有关清洁设备失败结果的警告。例如，您可能会说：“如果不清洁设备，性能将达不到最佳状态。”
2. 统计用户如何执行基本维护。 如果用户可以维修产品或设备以纠正性能问题，请为用户提供有关如何执行此操作的编号说明。例如，如果每300小时使用一次后需要更换电池，请提供有关如何检查是否需要更换电池，如何取出旧电池以及如何安装新电池的说明。
   • 如果某些维护任务只能由经过认证的技术人员执行，请将手册的维护部分分为两部分。
3. 讨论存储选项。 如有必要，手册应说明如何正确存放产品或设备。您还应该包括有关为什么需要存储以及存储不当后果的信息。例如：您可以编写：
   • 将产品存放在阴凉干燥的地方。储存不当会由于积聚水分而缩短产品的使用寿命。”
   • “请勿将本产品加热或将其存放在高于摄氏50度的温度下。如果这样做，可能会导致燃烧。”
4. 提供故障排除信息。 您可以将本节组织为常见问题及其解决方案的列表。将类似的问题归为一个逻辑标题。这样，用户可以快速找到特定的问题。
   • 例如，如果计算机出现蓝屏问题，请将其归为一个小标题，例如“常见屏幕问题”。
   • 您还必须在此部分中提供电话号码和/或用于客户服务的电子邮件。

第4部分（共4部分）：编写易读的手册

1. 阅读其他用户指南。 在为您自己的产品编写手册之前，请查看其他有效的用户指南。注意结构，单词选择和句子结构。苹果，谷歌和微软等主要品牌制作了功能强大，有效的用户指南，可以帮助您编写更周到的用户指南。
   • 不要只是读 全部 用户手册。阅读您出售的类似产品的手册。例如，如果您销售婴儿产品，请阅读婴儿手册，而不是技术手册。
2. 选择您的标准。 标准化拼写，单词选择和措辞将使用户手册更加人性化。编写用户手册时，《芝加哥样式手册》和《微软样式手册》也可能是有用的样式指南。同时检查两者是否适合您的手册。
   • 例如，不要同时使用手册中的“电源开关”和“电源按钮”，而是选择两个术语之一并坚持使用。
3. 使用主动语音。 主动语态是一种从用户角度解释事物的书写方式。比未定义主题的被动语态更容易理解。
   • 尝试使用Hemingway App（www.hemmingwayapp.com）来识别写作中的被动段落。
   • 研究这两个示例语句-第一个是主动的，第二个是被动的：
     • 您必须缓慢而小心地打开包装。
     • 包装应缓慢而小心地打开。
4. 写编号的指令。 按数字顺序排列的说明可帮助读者将注意力集中在使用，连接或制造相关产品的过程上。无需编写冗长的冗长段落或一系列未编号的段落，而应使用简单明了的步骤来编写用户指南，每个步骤都应清楚地编号。
5. 必须从每一步开始。 祈使语是面向动作的动词。通过以动词开始每个步骤，可以为读者提供有关完成该步骤所需的操作的提示。例如，根据要编写的产品，可以使用“连接”，“确认”或“幻灯片”之类的命令开始执行步骤。但是，不要以系统的响应来开始您的步骤。
   • 例如，如果屏幕变成蓝色并开始闪烁，则不要以“屏幕将闪烁并变成蓝色。”开始该步骤。尝试：“按住Home键。屏幕将闪烁并变为蓝色。”
6. 确定您将使用的词汇。 如果您正在编写溜溜球手册，那么您的听众将主要是年幼的孩子。用简单的单词和词汇来解释悠悠球的工作原理。当您编写扫描电子显微镜手册时，您的听众是由能理解非常详细信息的高技能科学家组成，因此请不要回避使用专门的词汇或细微的解释。
   • 通常，您尝试避免使用行话和技术性语言。
   • 为了对尽可能广泛的用户群有效，请尝试在小学六年级到七年级的水平上写作。
7. 将产品运送到海外时，请确保您的翻译正确无误。 雇用翻译人员，将您的用户手册翻译成将产品运送到的国家/地区的母语。您也可以使用在线翻译程序，但是请说母语的人阅读翻译并检查是否有错误。
   • 如果您的听众中有多个语言组，请提供每种相关语言的用户手册翻译。
   • 译者必须熟悉产品，因为特定语言中目标语言中可能有不同的词，而不是逐词翻译。
8. 用简短的句子写。 而不是一些长的段落，而是使用许多短的段落。在每个部分中查找逻辑中断，并以一句话或两句话的形式摘要有用的信息。在句子级别也是如此。句子要简短明了，而不要冗长而冗长。
   • 如果步骤太长，请将其分解为较小的步骤。这不会减少字数，但是换行符会使它更易于阅读。
9. 检查手册中是否有错误。 手册可能由于语法和拼写错误而失去信誉。也请同事或技术作家编辑和校对本手册。除拼写和语法外，校对人员还应注意以下事项：
   • 被动语态
   • 语言不清楚或混乱
   • 包装的句子结构
   • 段落过长

尖端

• 人们以不同的方式学习；如果可能和适当，在手册中包括视觉辅助工具或指向在线视频的链接，以适应以视觉为导向的读者。