如何在 2023 年创建用户指南

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices
简单的分步指南

您终于决定为您的神奇产品编写一份新的用户指南。

到了 2021 年,人们才意识到,创建用户指南大部分还是一个手动过程。于是,您使用下一个最佳应用程序来创建用户指南,并开始整理内容。

那么,如何开始,为什么开始,甚至为什么需要用户指南(咄......)?我将尝试回答一些关于创建用户指南的常见问题,并指导您使用 Docsie 创建第一份用户指南,但您也可以使用任何其他工具...

创建用户指南的原因和好处

制作用户指南的原因有很多。用户指南非常有用,在消费者、电子产品、软件程序以及有形或无形产品的各个方面都发挥着至关重要的作用。用户指南为用户提供如何使用和/或组装产品的简单、循序渐进的指导。

您的客户需要了解您销售的产品、提供的服务或必须遵循的方法和程序。用户指南提供了一个循序渐进的过程,让客户可以学习如何使用产品,并了解产品的不同特性和功能。

创建适当的用户指南可限制产品的法律责任:

用户指南还可以限制错误使用产品的法律责任。对于那些因使用或组装不当而可能造成潜在伤害甚至死亡的产品,用户指南非常有用。例如:高压设备、起火设备甚至激光器都需要大量的使用手册,以保护客户免受不当使用的伤害。

制作好的用户指南可以节省时间:

质量上乘的用户手册可为技术团队或销售团队提供产品使用说明,从而节省大量时间。许多复杂的软件产品都需要良好的技术用户指南,以帮助客户学习如何使用其产品,发挥最大潜能。软件通常都有很多功能,如果有适量的用户指南为客户提供有用的信息,从长远来看有助于留住客户,并节省解释如何使用软件和复杂产品各个方面的时间。

教育客户了解产品的用途:

让客户了解技术产品是非常重要的。如果没有适当的用户指南,客户可能会被大量隐藏功能所迷惑,不知道如何充分发挥技术产品的潜力。有了用户指南,客户就可以轻松学习产品的各种技术知识,当他们需要深入了解产品时,有了用户指南就会感到轻松自如。这将减轻他们在没有正式书面指导的情况下摸索的压力。对于使用危险的产品,用户指南还可以提供警告,防止以危险的方式误用产品。

怎样才能编写出优秀的用户指南

因此,在开始制作用户指南时,你需要了解你要帮助特定客户解决什么问题。如果事无巨细都要编写用户指南,那就会把指南弄得一团糟,包括目标受众在内的所有人都无法理解。如果你看看网上一些由超级明星公司撰写的用户指南的最佳范例,如 StripeSlack。你会发现一个特殊的模式。

每个用户指南都侧重于解决一个特定的问题。

那么,每份指南应该做些什么呢?它应该专注于用户按照本指南可以完成的简单操作。没有必要搞得太复杂。相反,如果您专注于解决常见的简单操作,帮助用户解决产品中常见的简单问题,那么您就会拥有一套让客户爱不释手的精彩用户指南。

因此,让我们仔细研究几份用户指南,了解一份出色的用户指南的结构是怎样的,这样我们就可以以此为参考,了解自己如何才能写出一份出色的用户指南。

那么,怎样才能编写出一份出色的用户指南呢?

让我们看看上面的《管理图书》指南,并总结出以下几点

整理用户指南

使用Docsie创建用户指南

Docsie 拥有各种工具和功能,可以让你制作出超棒的用户指南。首先,让我们来看看 Docsie 是如何工作的。Docsie 以书籍、书架和收藏为工作前提。

集合用于隔离各种书籍,以显示不同类型的客户。例如,该集合仅用于显示商业用户。这意味着我们从所有创建的图书中只选择了 3 本图书来显示这些特定客户。

当你有各种不同类型的客户使用你的产品时,这一点非常有用。在 Docsie 上,点击 "全部 "旁边的三个点,然后按添加,即可实现无缝添加。

进入 Docsies Collection 工具栏后,您可以创建收藏的名称,还可以选择您希望在此特定收藏中显示哪些用户指南。这一点很重要,因为不同的客户可能需要了解你的产品的不同用户指南,而这个工具可以让你只显示他们需要查看的特定用户指南。

现在,让我们开始用 Docsie 编写你的第一份用户指南吧。

把一本书想象成你的用户指南或手册。在打开的 "书 "中,你会看到 "编辑器",这里可以创建 "文章 "和标题。

编辑器位于顶部,左上角可以创建各种版本和语言,当然还有 "左侧的文章和小标题部分"。

编辑器使用简单,您可以通过简单的拖放操作添加视频、图片和代码。 此外,您还可以根据自己的喜好对内容进行风格化设计。

创建文章非常简单,只需输入标题即可。本例中的标题是 "Docsie 是什么",但您也可以输入任何您想要的用户指南标题。

要在用户指南中创建显示为 1.1、1.2...ext 的分节,只需选择文本位置并将文本设置为 "页眉",点击编辑器选项卡中的 H 即可。

Docsie 还允许您创建不同版本和语言的用户指南。这对于本地化和讨论产品用户指南的各种改动非常有用和方便。

一旦您准备好了用户指南,写出了它们,并用照片对它们进行了风格化处理,帮助解释了产品和功能的各个方面,下一步就是发布了。

总之,以下是创建用户指南的技巧和窍门

大多数软件和技术产品都非常复杂,涉及多个方面。为了解决这个问题,在为复杂产品创建用户指南时,最好将信息和说明分解成较小的部分。从根本上说,就是创建各种小型用户指南,并将其汇编成用户指南手册。

您的客户不熟悉您的产品和服务。在创建阶段,产品技术含量越高,用户指南的描述性就越强。在这一过程中,含糊不清的词语和措辞不会成为你的朋友。要尽可能具体,以便客户能够理解产品中的补救性内容。

一张图片胜过千言万语。这一点尤其适用于用户指南和手册。大多数公司都非常忽视这一步,但在用户指南中解释产品功能和方面时,拥有正确的照片或快照是非常重要的。这样,您的客户就能明白您所指的是产品的哪些方面。

用户指南的目的是帮助客户了解产品的各种用途。尽可能以简单的方式进行解释,这样他们就能很容易地理解产品的各种功能和方面。


Subscribe to the newsletter

Stay up to date with our latest news and products