很棒的用户文档的 9 个技巧（附示例）

用户文档是交付给客户的整个产品的重要组成部分。 它可以帮助最终用户更成功地使用您的产品或服务。

过去，用户文档是通过用户机器本地的帮助文件或物理手册或小册子提供的。 这意味着它无法轻松更新或更改，并且软件提供商获得的关于其内容如何使用的数据非常少。

如今，用户文档几乎总是在线提供，这有助于技术作家在如何帮助用户方面更具想象力。 他们可以收集数据，尝试不同的学习技术，更快地迭代，为用户提供更丰富的内容体验。

这就是这篇博文的用武之地！ 一世

在这篇文章中，我们将探讨您可以做些什么来改进您的用户文档并查看一些优秀的用户支持内容示例。

从计划开始

就像生活中的大多数事情一样，最好从计划开始，创建用户文档也不例外。 这就是为什么您要确保在开始之前问自己（可能还有那些请求文档的人）很多问题。

1.考虑你的听众

你为谁做这个？ 最终用户？ 系统管理员？ 此内容是否只会在内部进行审查，还是也会在外部看到？ 您为谁创建用户文档有助于构建您共享的信息。

2. 评估并牢记您的最终目标

任何文档的主要目的都是教你的听众一些东西。 在确定谁将使用您的文档后，您需要决定希望他们从中获得什么。

在查看文档后，您希望您的听众能够执行什么操作？ 通过牢记该问题的答案，您将能够为相关任务提供适量的内容。

3. 确保您的用户文档易于找到

隐藏的用户文档几乎与糟糕的用户文档一样无用。 确保您创建的用户文档对于需要它的人来说很容易找到，这一点很重要。

这不仅意味着确保它是可见的，还意味着用户可以在您的技术文档中导航并快速找到他们问题的答案。

您的听众越快找到这些答案，他们就会越开心。 它还可以节省您回答有关产品的重要但常见问题的时间。

简洁有力的文笔

强大的写作对于出色的用户文档至关重要。 但写作影响的不仅仅是用户文档的阅读或声音。 它也会影响浏览用户文档的难易程度。

4.写描述性的标题和副标题

确保你的标题是有用的，最重要的是，是具体的。 编写用于回答问题的标题或副标题通常是最好的。 以这种方式构建标题可以让您的最终用户更轻松地找到他们正在寻找的内容，还可以帮助您编写直接满足用户需求的文章。

Unbounce 在整个用户文档中编写有效的标题和副标题方面做得非常出色。 这使得他们的文档易于浏览。 每篇特定文章都有自己的目录，这使得找到特定问题的答案变得轻而易举。

5. 便于浏览

以易于扫描的方式提供信息有助于用户节省时间。 作为人类，我们感谢我们能节省的任何时间。 此外，用户可能并不确切知道他们在寻找什么。 这时候易于浏览的内容是最有益的。

IBM 通过组织干净的目录并提供相关主题，在使他们的帮助内容易于浏览方面做得很好。

6.使其易于搜索

谷歌已经训练我们找到我们问题的答案就像在搜索框中输入它们一样简单。 您的帮助文档应该反映这种期望。 如果您的帮助内容不可搜索，那么它可能不是很有帮助。

Hubspot 深入的知识库使客户的自助服务变得容易。

使用视觉效果来提高理解

好的用户文档是高度可视化的。 虽然强大的写作和文本对于出色的用户文档至关重要，但当视觉效果也存在时，人们学得最好。

7. 使用带注释的截图

带注释的屏幕截图是在用户文档中使用的强大视觉效果。 他们通过准确显示他们需要采取的步骤来消除用户的猜测。

使用 TechSmith Snagit 之类的程序，可以轻松地将文本标注、箭头等添加到屏幕截图中。 例如，您会注意到我在这篇博文中使用了我用 Snagit 制作的带注释的屏幕截图。

如果您受到启发，您甚至可以尝试 Snagit 的 Step Tool，它允许您通过在指向和单击时放置有序标注来识别图像的各个部分。 每次单击以添加另一个步骤时，数字会自动增加。

一家在文档中利用屏幕截图功能做得非常出色的公司是 Asana。 在他们出色的用户文档中，他们使用带注释的屏幕截图来清楚地指导客户。

8.利用视频展示而不是告诉

视频很好地展示了一个过程。 许多很棒的用户文档结合了视频的力量和文字说明。 例如，使用短视频快速完成流程是一种很好的做法。

然后，在视频旁边，您可以提供文本分步指南供用户在自己尝试该过程时参考。 这样，如果他们只需要快速提醒，他们就不必一遍又一遍地观看视频。

在我们的 TechSmith 产品教程中，我们使用主视频来完整概述我们正在讨论的功能或主题。 然后，在视频下方，我们提供了带有屏幕截图或动画 GIF 的片段，以重申视频的要点。

9. 展示示例和最终结果

用户需要知道成功完成每项任务的样子。 向用户提供示例最终结果的屏幕截图是向观众展示理想结果的好方法。

出色的用户文档使最终用户可以轻松找到问题的答案，从而创造快乐、满意的用户。

创建出色的用户文档的一个关键部分是提供清晰、易于扫描的信息。 屏幕截图、视频或动画 GIF 等视觉效果都是与您的用户更有效地交流的好方法。