如何创建用户手册：从零到英雄（完整指南）

已发表: 2022-11-24

不确定如何创建用户手册来帮助您的客户从您的产品中获得更多价值？

用户手册是帮助您的客户（或员工）有效使用您的产品或服务的内容。您还可能看到它被称为用户指南、说明手册、产品手册等。

除了帮助您的客户有效地使用您的产品之外，创建高质量的用户手册还可以帮助您减少客户服务和支持请求，因为用户无需寻求支持即可解决他们的问题。

在本详细指南中，您将学习如何创建帮助客户取得成功的用户手册。

为了实现这一点，我们将介绍以下所有内容：

不同类型的用户手册
在哪里发布您的用户手册
如何创建用户手册

让我们开始吧！

不同类型的用户手册

用户手册有多种类型，包括面向客户的内容和内部内容。

在开始之前，了解您想要创建哪种类型的手册非常重要，因为这会影响您处理内容的方式。

以下是不同类型用户手册的简要总结：

用户手册——经典的用户手册教用户如何使用产品。
培训手册——培训手册教用户如何执行某项任务或完成某项工作。
操作手册——操作手册通常是记录贵公司运营情况的内部手册。
服务手册——服务手册着重于教导用户如何在产品生命周期的不同阶段正确维护产品。
标准操作程序 (SOP) – SOP 是内部手册，教导组织成员如何“以正确的方式”正确完成某些流程。

对于下面的说明，我们主要关注创建面向公众的用户手册。但是，以下基本原则适用于任何类型的用户手册。

在哪里发布您的用户手册

发布用户手册的位置取决于您创建的用户手册的类型。

对于面向客户的用户手册，您几乎总是希望将它们发布在您的网站上。这样，用户可以从任何地方访问该手册。

更重要的是，在网络上发布用户手册内容还可以让您创建比使用物理用户手册更友好的用户体验，例如添加可点击的目录和实时搜索建议。

但是，对于实体产品，您可能还希望将实体用户手册作为基于网络的手册的补充。

对于内部用户手册，您通常希望将它们隐藏起来不让公众看到。

实现此目的的一种方法是仅在公司内部网上提供它们。但是，由于有这么多人在家工作，除非您的公司有自己的 VPN 设置，否则很难做到这一点。

相反，您可以考虑使用密码保护内容，方法是要求员工登录用户帐户或仅添加密码以访问页面。

对于实体用户手册，您可以使用专门的知识管理工具来帮助您发布更复杂的手册。或者，对于更简单的用户手册，您可以直接在 Google 文档中编写并从那里发布——我们的技术写作工具集合中有一些有用的工具可以让您的生活更轻松。

要在线发布您的用户手册，您可以使用大多数文档或知识库软件。如果您想要一个可以处理面向公众和内部用户手册的工具，您可以考虑 WordPress 的开源 Heroic Knowledge Base 插件。我们将在本教程中更深入地讨论这一点。

这是来自 Heroic Knowledge base 的在线用户手册示例（以及关于 Heroic Knowledge Base）：

说到教程……

如何通过六个步骤创建用户手册

现在您已经了解了一些背景信息，让我们开始了解如何创建用户手册，从零开始，一直到完成用户手册。

1. 创建你的用户画像

在开始创建任何内容之前，您需要了解内容是为谁准备的，这可以通过创建用户角色来实现。

您可能已经很清楚您的客户是谁，但将其写下来有助于真正集中精力。

为什么这很重要？

好吧，这是一个例子：

为机械工程师创建技术内容与为非技术用户创建技术内容之间存在很大差异。

对于大多数产品，差异不会那么明显。但了解您的客户角色仍然很重要，这样您才能确保您的用户手册对实际使用它的人有意义。

2. 确定关键问题和目标

一旦您了解了您的客户是谁，下一步就是了解他们试图通过您将要创建的用户手册实现的目标。

也就是说，阅读本手册的人的最终目标（或最终目标）是什么？

理解这一点很重要，因为您的手册的目的应该是帮助您的用户尽可能高效地实现该目标。

在某些情况下，这个最终目标可能是一件具体的事情。例如，如果你有一个社交媒体管理工具，它可能是“在社交媒体上安排一个帖子”。

在其他情况下，它可能是一个更抽象的目标，例如“改进我们的项目管理流程”。

对于较大的产品，用户可能会尝试实现多个目标，这将我们带到下一节。

3.创建逻辑结构和层次结构

现在您了解了您的客户是谁以及他们想要实现什么，您可以开始为您的用户手册规划结构。

您想要创建一个结构，使您的用户从“零”到实现您在上一节中列出的最终目标。

这里有一些提示可以帮助您做到这一点：

考虑如何帮助客户尽快开始从您的产品中获得价值。
从中提取您自己的个人知识。你显然对你的产品了解很多，但你的客户不会有那么多背景知识。
确保涵盖客户在尝试使用您的产品时可能遇到的任何常见问题或令人困惑的细节。这些应该在客户最有可能遇到问题的时候逻辑地解决。

4. 编写您的用户手册内容

规划好内容后，您就可以开始写作了。

根据您的产品/组织的规模，您可以自己编写所有内容。或者，您可能需要与其他团队成员协作来编写内容。

以下是编写用户手册时要考虑的一些一般用户手册最佳实践：

使用模板确保格式一致。创建格式化模板不仅可以加快您的工作速度，还可以确保手册中的每篇文章与其他文章保持一致。
包括视觉效果（图像和视频）以帮助用户。注释良好的图像或 GIF 比单独的文本说明更有帮助，无论文本多么详细和透彻。
使用通俗易懂的语言，避免行话。或者，当行话完全无法避免时，一定要解释清楚。
简明扼要。用户手册的目标应该是完全涵盖主题，但要尽可能少。不要遗漏重要信息，但要无情地删除任何不必要的内容。
尽可能使用项目符号和列表作为说明。使用编号或项目符号列表可以使用户轻松跟踪指南。或者，如果您需要比列表允许的更多细节，您可以为每个步骤制作自己的副标题。
使用主动语态。对于用户手册中的说明，被动语态尤其容易混淆。这就是“可以通过按下红色按钮打开产品”和“可以通过按下红色按钮打开产品”之间的区别。后一个示例（主动语态）更清晰，使读者更容易将自己置身于说明中。

最后，像新用户一样测试您的用户手册说明总是一个好主意。

也就是说，一旦您写完了一篇文章，请返回并实际逐步按照这些说明进行操作，以确保您没有遗漏任何内容。

5. 发布您的用户手册

拥有内容后，上线的最后一步是发布您的用户手册，以便您的客户轻松获取。

如何执行此操作取决于您提供的产品类型。例如，如果您要运送实体产品，您可能希望包含手册的实体版本。

但是，无论您提供什么类型的产品，您都希望在线发布您的用户手册，以便人们可以轻松找到它。

为了帮助您做到这一点，您可以使用知识库/文档软件。

例如，借助 Heroic Knowledge Base WordPress 插件，您可以使用开源 WordPress 软件发布您的用户手册。

这种开源方法让您完全拥有和控制您的平台，同时仍然提供许多有用的工具来帮助您的客户更有效地浏览您的用户手册：

类别组织——您可以轻松地将用户手册组织成逻辑类别，并使用拖放对这些类别进行排序。
实时搜索建议——如果客户想直接跳转到特定的教程，他们可以开始输入搜索内容，然后根据他们的查询查看实时搜索建议。
自动目录——该插件会为每篇用户手册文章自动生成一个可点击的目录，帮助读者直接跳转到与他们相关的部分。
简单标注/格式- 您可以轻松添加标注和其他格式，以引起人们对文章中关键元素的注意。
即时回答小工具——除了在您的网站上创建一个专门的用户手册页面外，您还可以添加一个可搜索的即时回答小工具，让访问者可以从您网站上的任何地方浏览用户手册内容。

如果您想查看更多软件选项来帮助您发布用户手册，您可以阅读我们关于最佳知识库软件和最佳文档工具的帖子。

6. 根据需要更新和修改您的用户手册

创建用户手册不是一次性的工作。展望未来，您需要花时间修改和更新您的内容。

您可能需要更新用户手册的主要原因有两个：

您向产品添加了新功能或更改了现有功能/界面的工作方式。
您想要改进您的用户手册内容以使其更有帮助。

第一种情况很明显——如果您以某种方式更改产品，则需要更新用户手册以说明这些更改。

然而，第二种情况也很重要，需要考虑在内。尽你所能尝试，你可能不会从第一天起就让每篇用户手册文章都完美无缺。

为了更好地帮助您的用户，您需要更新和修改性能不佳的手动内容以使其更有用。

如果您使用 Heroic Knowledge Base 等工具发布用户手册，它会包含内置的文章有用性评级，以便您可以轻松查看哪些文章需要改进。用户还可以在文章上留下文本反馈，这可以让您指出文章中没有提供应有帮助的特定部分：

您还可能缺少用户遇到问题的主题的文章。为了帮助您找到这些缺失的主题，Heroic Knowledge Base 还包括内置搜索分析，以便您可以跟踪哪些搜索没有任何主题结果（以及一般的整体搜索）：

立即创建您的用户手册

如果您想让客户获得成功，学习如何创建用户手册非常重要。

通过这篇文章中的提示和最佳实践，您现在应该掌握了使用用户手册启动和运行所需的知识。

要以一种简单的方式在线发布您的用户手册并帮助您的客户浏览它，您可以使用 WordPress 和 Heroic Knowledge Base 插件。

Heroic Knowledge Base 可以轻松发布您的文章并根据需要组织它们。此外，您的客户可以利用有用的功能，例如实时搜索建议、自动目录等。

从今天开始，您很快就会发布您的用户手册。

如果您有兴趣创建文档以提高您企业的内部知识，您也可能对我们关于如何为您的员工发布培训手册的教程感兴趣。