如何构建最佳用户文档

如果您的产品比一卷纸巾更复杂，您可能会创建某种用户文档来帮助人们学习如何使用它们。

精心制作、用户友好的产品手册或用户指南可能意味着出色的客户体验和糟糕的客户体验之间的区别。

此外，用户文档不仅适用于新用户。

有经验的客户还可以参考用户手册或产品指南，以刷新他们不经常使用的功能的记忆或解决他们遇到的特定问题。

在这篇文章中，我们将主要关注为软件等非物理产品创建用户文档的最佳实践，但这些技巧中的大多数（如果不是全部）也适用于硬件领域。

以下是您将学到的内容：

• 什么是用户文档以及为什么它很重要。
• 最终用户文档如何成为客户体验的一部分。
• 良好的用户文档如何帮助减轻您的客户支持团队的负担。
• 为什么视觉内容是最佳文档的秘诀。
• 确保最佳用户文档的基本要素。
• 创建令您的客户满意并经受住时间考验的文档的四个步骤。

什么是用户文档？

用户文档（也称为最终用户手册、最终用户指南、说明手册等）是您为最终用户提供的内容，以帮助他们在您的产品或服务上取得更大的成功。

这些是与您的产品一起提供的指导材料，以帮助人们学会正确使用它，或者——在实体产品的情况下——甚至是组装它。

如果您曾经组装过一件宜家家具，那么您就使用过最终用户文档。

但是，用户文档有多种形式。

视频游戏附带手册，告诉您按下哪些按钮可以射击坏人。 软件文档向您展示了您的购买可以做什么以及如何做。

税表附带如何正确填写的指南。

割草机和吹雪机有产品指南，向您展示如何启动发动机以及在何处补充燃料。

跳到如何制作用户文档

为什么用户文档很重要？

你知道你的产品很棒。 您也希望您的客户也知道这一点。 用户文档有助于确保您的客户或用户真正了解如何充分利用您的产品。

无论是如何保存文档、启动电机、使用特定工具，甚至是重要的安全信息，您的最终用户文档都是您与客户关系的重要组成部分。

用户文档可以取悦您的客户

用户文档很容易，对吧？ 我的意思是，只要写一些关于如何使用你的产品的东西，你就可以开始了！

这不是那么简单。

它不仅仅是“操作方法”材料。 这是客户体验的一部分。 这意味着它也是营销材料。

作为一名消费者，我经历过伟大而糟糕的用户指南。 我敢打赌，你们中的大多数人都有过类似的经历。

出色的用户手册或产品指南向您的客户表明，您不仅关心他们是否购买您的产品，还关心他们在实际使用产品时是否拥有真正出色的体验。

觉得您对他们的关心超出了他们的钱包范围的客户会不断地回到您身边。

如果您希望他们向全世界宣传他们对您的产品和服务的喜爱程度，那么提供出色的用户文档是购买后体验的重要组成部分。

用户文档如何支持您的支持团队

人们通常会在出现问题时联系您的支持团队，但他们也可能会在无法解决问题时致电。 拥有出色的用户文档可以通过两种主要方式帮助您的支持团队。

1. 给他们一个简单的参考指南

出色的用户文档不仅仅需要为客户服务。 当您的客户寻求帮助时，您的产品支持团队可以使用文档来帮助他们更好地支持他们。 当您包含重要部分（例如目录或索引）时，他们可以快速找到所需的信息。 而且，如果它是可搜索的电子文档，那就更好了！ 我们将在本文后面详细了解这一点。

2. 减少通话

如上所述，当人们无法解决问题时，他们通常会致电支持。 但是，如果客户能够自己弄清楚，他们需要帮助的可能性就会小得多。 事实上，超过 70% 的人更愿意使用公司的网站寻求帮助，而不是通过电话或电子邮件获得帮助。

即使是最好的文档也不会消除所有这些调用，但创建清晰、全面和简洁的用户指南和手册将大大减少支持请求的总体数量。

优秀的用户文档的基本要素是什么？

尽管每个产品都是独一无二的，并且需要不同的元素来创建真正出色的用户文档，但无论如何都需要遵循一些最终用户文档的最佳实践。

出色的用户文档应包括：

• 平白的语言
• 简单
• 视觉效果
• 关注问题
• 逻辑层次结构和流程
• 目录
• 可搜索的内容
• 无障碍内容
• 好的设计
• 真实用户的反馈
• 更多资源的链接

平白的语言

没有什么比阅读他们无法理解的内容更让客户感到沮丧的了。 没有人愿意感到愚蠢，而让您的客户有这种感觉的语言肯定无法培养良好的体验。

尽可能使用简单明了的语言来帮助您的客户理解最复杂的概念。

请记住，为用户而不是开发人员写作。

这听起来很简单，但是用通俗易懂的语言来描述你从前到后都知道的产品或服务比你想象的要困难。 您知道客户可能不知道的各种行话、首字母缩略词和其他“内幕”信息。 你使用它是很自然的。

但这就是您可能遇到严重麻烦的地方。

不要假设您的客户对您的产品一无所知。 不要以为他们知道您可能每天在办公室使用的所有技术和/或行业流行语。

不要像孩子一样写作，但要明白他们可能需要额外的帮助才能真正让他们跟上进度。 以易于阅读的方式编写文档。

简单

保持文档尽可能简单以实现其目标。 这既适用于文档的内容，也适用于其设计。 长长的文本块和挤满了书面和图形内容的页面会使用户指南或手册感觉令人生畏和不友好。

被您的用户材料吓倒的客户更有可能致电您的支持团队寻求帮助，而不是尝试自己解决问题。 此外，他们不太可能拥有良好的客户体验。

视觉效果

最好的用户文档完美地说明了“展示，不告诉”这句话。

视觉内容，包括图像、带注释的屏幕截图、图形和视频，可以快速向人们展示您的产品是如何工作的。 他们不必阅读它：他们可以看到它！

TechSmith 最近的研究表明，当提供视觉或视频内容的指令时，人们实际上更快地吸收视觉信息并更好地执行任务。

视觉内容还有助于分解长文本块，并有助于消除许多使许多用户指南或手册感到恐惧和不愉快的文本。

在用户文档中包含视觉内容的流行方式包括屏幕截图、屏幕录像、教程视频等。

你听说过简化图形吗？ 有时称为简化用户界面（或 SUI），简化图形获取用户界面或其他图形的图像，并且——顾名思义——简化它们。 这个更基本的版本突出了最重要的信息，同时减少了对简单形状不重要的文本和图形。

所以，看起来像这样的东西：

现在看起来像这样：

如果我试图向某人展示如何选择“连接移动设备”菜单项，则第二张图片会消除所有杂乱，并让客户的眼睛能够专注于他们需要的地方。

您可能已经遇到过简化图形并且甚至没有意识到这一点，例如 G Suite 学习中心的这个：

那里有很多工具，但是如果您正在寻找创建屏幕截图和屏幕录像的强大而简单的方法，我强烈建议您下载 Snagit 的免费试用版。

专注于要解决的问题

每个产品都解决一个问题。 但很多时候，我们非常喜欢我们酷炫的产品功能，以至于我们想做的只是强调它可以做什么，而不是我们的客户需要它的原因。

确保向用户展示如何使用您的产品执行任务。

当然，这将涉及产品功能，但要在帮助用户了解他们最初购买您产品的原因的背景下突出它们 - 以解决特定问题。

例如，我们的 Camtasia 和 Snagit 教程（是的，教程视频可以是一种文档形式）强调了特定的功能，但它们是在为什么有人可能会使用该特定功能的背景下这样做的。 这是关于为什么，而不仅仅是如何。

这是一个很好的例子……

逻辑层次结构和流程

好的文档需要标题和子标题的层次结构，让用户知道每个部分将显示什么。 并且该层次结构应遵循逻辑流程，以帮助用户学习以最有用的方式使用您的产品。

例如，您可能不想通过向客户展示如何使用更高级的功能而不首先向他们展示您的产品如何工作的基础知识来开始您的文档。 首先从简单的东西开始，然后随着您的用户积累知识，向他们展示高级功能。

目录

目录为您的客户提供了一种简单、有效且熟悉的方式来快速找到他们的问题或问题的解决方案。 它位于文档的开头，因此他们无需筛选文本页面即可找到所需内容。 它应包括上述所有主要标题和小标题。

使其可搜索

曾经有一段时间打印了大多数用户文档。 现在，在几乎每个人都可以使用智能手机的时代，创建电子文档更有意义。 这并不意味着您也不能创建打印版本，但电子版本提供了许多优势，我们将在下面更详细地讨论。

就像目录一样，可搜索的内容使用户可以更轻松地访问您的内容，并帮助他们自己找到解决方案。

可访问性

创建可访问的内容。 这意味着确保电子文档符合盲人或视力障碍、耳聋或听力障碍或可能有认知障碍的人的可访问性标准。

请记住，您的许多客户需要它来理解和完全访问您的用户文档。 不要让他们落后！

好的设计

为您的用户提供他们想要查看的文档，他们将更有可能使用它。

设计材料时要考虑到您的客户。 让它可用和友好。 避免长段落的文本或内容过于丰富的页面。 留出空白有助于打破单调，让学习新产品的前景变得不那么令人生畏。

包括尽可能多的图形和图像来展示而不是告诉您的客户如何使用您的产品。 对于电子文档，请使用视频和 GIF。

在多个文档中使用一致的字体和互补色。 如果您的组织有样式指南（如果尚不存在，我强烈建议您创建），请确保您的文档符合它。

Snagit 模板使从一系列屏幕截图或其他图像创建具有专业外观的用户文档变得异常容易。 只需收集您需要的图像，选择“创建”，然后选择“模板中的图像”，您就可以开始使用了。

Snagit 附带了一堆免费的、专业设计的模板，并且使用 TechSmith Assets for Snagit，您可以获得更多！

来自真实用户和/或 Beta 测试人员的反馈

在您听取组织外部实际使用产品的人的意见之前，您无法创建真正出色的用户文档。

了解他们的痛点并尽力解决它们。 找出他们告诉您需要知道什么才能最好地使用您的产品。 虽然其中一些看起来很明显，但我保证你会学到一些你从未考虑过的东西。

其他文档的链接

确保您的客户可以访问您组织的更多资源，了解如何使用您的产品取得成功。 对于电子用户文档，这可以像提供指向教程、常见问题解答、用户论坛等的链接一样简单。

但即使是打印文档也可以包含网站地址和电话号码等内容，以提供进一步的支持。

奖金！ 添加分步说明

分步指南有助于避免使用长文本块，并提供一种更清晰的方式来显示流程，而不是仅通过文本来解释它。 与简单地告诉某人如何完成一项任务相比，它们更易于遵循、更易于理解并提供更加用户友好的体验。

请记住，在您的分步说明中包含视觉内容会使它们变得更好。

Snagit 提供了一个易于使用的分步工具，可帮助您创建出色的分步文档。 此外，组合图像工具使您能够将单个屏幕截图和其他图像组合成一个图像，以便于编辑和标记。

如何创建出色的用户文档

第 1 步：计划

每一套优秀的用户文档都从一个计划开始。 这里有一些关于如何到达你想去的地方的提示。

知道从哪里开始

许多人认为，如果您了解自己的产品，就可以开始创建文档。 但还有更多内容。 相反，从一个计划开始，以确保您实际上是在帮助您的用户。

在制作文档之前，需要考虑以下几点：

• 你应该包括什么？ 你应该遗漏什么？ （提示：这是用户反馈真正有用的地方！）
• 我们应该以什么顺序呈现信息？ （还记得学校的论文大纲吗？使用它们！）
• 还有哪些其他资源可用？ 我们将如何提供这些访问/链接？
• 谁负责创建文档？ 谁负责对文档进行反馈？ 谁有最终批准？
• 这需要翻译或本地化吗？

这些问题的答案决定了您创建文档的方式。 规划可确保流程顺畅和更好的用户文档。

了解您的产品

确保您了解您的产品。

这并不意味着您需要成为所有方面的绝对专家，但任何创建用户手册或用户指南的人都应该对产品有实际操作经验。

依靠您的主题专家获得更深入的知识，但在尝试教别人之前，您应该知道如何自己使用它。

选择你的格式

此外，文档的最终格式同样重要。 只会打印吗？ 会是电子的吗？ 如果是这样，它会住在哪里？

不久前，几乎所有的用户文档都是打印的。 但是，除非您有充分的理由，否则我建议您至少在您的网站上提供电子版本。

大多数用户可以 24 小时使用智能手机、计算机或平板电脑，而且他们习惯于在想知道的任何时候找到他们想知道的任何东西。 将用户资源放到网上可以让他们随时随地访问，这意味着他们不必在抽屉或文件柜中寻找多年未见的用户手册。

此外，让残障人士可以更轻松地访问电子文档。 仅印刷版适用于大多数人，但您准备好为可能失明或视力受损的用户创建盲文版了吗？ 对于身体残疾的用户，他们很难用手操作物体怎么办？

存在使所有人更容易访问电子文档的工具，但仅打印版本提供了更困难的可访问性问题。

此外，电子文档更容易更新，因为它存在于网络上。

我应该将我的文档制作成 PDF 吗？

如果您想提供可下载的 PDF 版本的文档，那很好。 但请确保它在您的网站上也以非 PDF 格式提供。

第 2 步：创建您的用户文档

一旦您回答了所有问题并做出了上述所有决定，就该创建您的用户文档了。 我不会假设告诉您如何准确地为您的特定产品创建文档，但有一些关键事项需要牢记。

• 除非绝对必要（然后一定要定义它们），否则避免使用行话和高度技术性的术语。
• 避免使用首字母缩略词，除非您解释它们的含义。
• 尽可能使用公认的写作风格，例如 AP 或 Chicago。 如果您的组织有公司风格指南，请使用它。
• 不要假设用户对您的产品或产品的功能一无所知。 向他们展示成功所需的知识。
• 记得使用简单的语言。 为八年级或以下水平写作。 即使对于高级读者来说，简单的语言也会导致更快的处理和更好的理解。
• 设计应该令人愉悦、不吓人，并吸引用户。让他们想要使用您的文档。

第 3 步：测试它

只有当用户指南可以帮助您的客户尽其所能使用您的产品时，它才是伟大的。 直到有人使用它，你才能知道这一点。 在您的新创造进入整个世界之前，您想对其进行测试。 这里有一些提示！

• 最佳实践：将其提供给一组真实用户或 beta 测试人员，看看他们是如何做的。 将他们的反馈纳入完成的文档中。
• 如果您没有 beta 测试用户反馈，请在内部进行测试，最好与最不熟悉产品的员工一起测试。
• 从开发人员和工程师那里获得反馈。 他们比任何人都更了解产品，并且可以指出您可能遗漏的东西。

第 4 步：使您的文档保持最新

当您的产品发生变化时，您需要不断更新用户文档。 如上所述，这使电子文档相对于印刷具有巨大优势。 但是，即使是仅打印的文档也可以更新并在您的网站上可供下载。

请记住，您的内容只有在准确的情况下才是伟大的。 确保您提供给客户的东西实际上可以帮助他们使用您的产品。

概括

如果您什么都不记得，请记住，应该以对您的用户最有帮助的方式创建、设计和呈现出色的用户文档。

为他们提供继续让他们高兴并提供您想要的客户体验的文档。

使您的文档易于访问、有用且可视化。

常见问题