简单的一步一步的指南
所以你终于决定写一份关于你的神奇产品的新用户指南。
在2021年,人们意识到的是,创建一个用户指南仍然主要是一个手动过程。你得到了下一个最好的应用程序来创建你的用户指南,并开始把内容放在一起。
那么,你如何开始,为什么开始,为什么你甚至需要一个用户指南(咄...)?我将尝试回答一些关于用户指南创建的常见问题,以及指导你帮助你在Docsie中创建你的第一个用户指南,但你实际上可以使用任何其他工具...
创建用户指南的原因和好处
创建用户指南有很多原因。用户指南是非常有用的,在消费者、电子产品、软件程序和有形或无形产品的所有方面发挥着关键作用。用户指南为你的用户提供简单的、一步一步的关于如何使用和/或组装产品的说明。
你的客户需要了解你所销售的产品、你所提供的服务或他们必须遵循的方法和程序。它们提供了一个循序渐进的过程,你的客户可以学习如何使用,并了解你产品的不同特点和功能。
创建适当的用户指南限制了产品的法律责任:
用户指南也限制了不正确使用你的产品的责任。对于那些由于没有正确使用或组装产品而可能造成潜在伤害甚至死亡的产品,用户指南是非常方便的。例如:高压设备、发火装置甚至激光器都需要大量的手册来保护客户不被不当使用。
创建良好的用户指南可以节省时间:
优质的用户手册分享了如何使用你的产品的说明,这可以为你的技术团队解释事情或销售团队做演示节省大量的时间。很多复杂的软件产品需要良好的技术用户指南,以帮助他们的客户学习如何使用他们的产品,发挥最大潜力。软件通常被许多功能所困扰,拥有适当数量的用户指南,为客户提供有用的信息,从长远来看,可以帮助留住客户,并节省解释如何使用软件和复杂产品的各个方面所需的时间。
教育你的客户了解你的产品用途:
教育客户了解技术产品是非常重要的。如果没有适当的用户指南,你的客户可能会被一连串的隐藏功能所迷惑,不知道如何使用技术产品的全部潜力。用户指南允许一个简单的过程,你的客户可以学习参与你的产品的各种技术方面,当他们需要深入研究你的产品时,有一个用户指南在手,他们会感到很舒服。这将使他们在没有正式书面指导的情况下试图弄清事情的压力消失。此外,对于有使用危险的产品,用户指南可以提供警告,防止以危险的方式滥用产品。
什么是伟大的用户指南
因此,要开始制作用户指南,你需要了解你试图帮助特定客户解决什么问题。为所有的东西做一个用户指南会使它变成一个难以理解的混乱,没有人会理解,包括它的目标客户。如果你看看网上一些最好的用户指南的例子,由超级明星公司如[Stripe](https://stripe.com/docs/payments?payments=popular)或[Slack](https://slack.com/intl/en-ca/help/categories/200111606-Using-Slack)编写的。你会注意到一个特别的模式。
每个用户指南都专注于解决一个特定的问题。
那么,每个指南应该做什么?它应该专注于你的用户在遵循本指南时可以完成的简单行动。没有必要复杂化。相反,如果你专注于解决常见的简单动作,帮助你的用户解决与你的产品有关的常见的简单问题,你将会得到一套令人惊叹的用户指南,你的客户会喜欢。
所以,让我们仔细看看一些用户指南,了解什么是一个令人惊奇的用户指南的结构,这样我们就可以把它作为一个参考点,了解我们如何自己写一个令人惊奇的用户指南。
##那么,什么会进入一个伟大的用户指南?
让我们看看上面的《管理手册》指南,并提出以下几点建议
组织你的用户指南
使用Docsie来创建用户指南
Docsie有各种工具和功能,可以让你制作出很棒的用户指南。首先,让我们来看看Docsie是如何工作的。Docsie是在书籍、书架和收藏的前提下工作的。
集合用于隔离你想显示不同类型客户的各种书籍。例如,这个集合只用于显示商业用户。这意味着,我们从所有创建的书籍中只选择了3本,以显示这些特定的客户。
当你有各种不同类型的客户使用你的产品时,这很有用。在Docsie上,通过点击 "所有 "旁边的三个点并按下添加键,就可以无缝地实现这一功能。
一旦你在Docsies Collection工具条上,你可以创建你的集合的名称,也可以选择你想在这个特定的集合中看到什么用户指南。这一点很重要,因为不同的客户可能需要了解你产品的不同用户指南,这个工具可以让你只显示他们需要看到的特定用户指南。
现在让我们开始用Docsie编写你的第一份用户指南,这是用Docsies "Book "完成的
把书看成是你的用户指南或手册。在你打开的书中,你会看到编辑器,这是一个可以创建 "文章 "和标题的地方。
顶部的编辑器,在左上角可以创建各种版本和语言,当然还有 "左边的文章和副标题部分。
编辑器使用起来很简单,它允许你用我们简单的拖放过程添加视频、图片和代码。 它还允许你按照你认为合适的方式对你的内容进行风格化。
文章真的很容易创建;只需键入你的标题。本例中的类型是 "什么是Docsie",但你可以输入任何你希望的用户指南的标题。
要在你的用户指南中创建分节,显示为1.1,1.2...ext,你需要做的就是选择文本的位置并将文本设置为 "标题",这可以通过点击编辑器标签中的H来完成。
Docsie还允许你创建各种版本和语言的用户指南。这对于本地化和谈论你的产品用户指南的各种改变是非常有用和方便的。
一旦你准备好了你的用户指南,把它们写出来,用有助于解释你的产品和功能的各个方面的照片使它们风格化,下一步就是发布。
总结一下,以下是创建用户指南的技巧和窍门
大多数软件和技术产品都是非常复杂和多面的。为了解决这个问题,在为复杂的产品创建用户指南时,最好将信息和指令分解成小部分。基本上是创建各种小的用户指南,并将其编入用户指南手册设置中
你的客户对你的产品和/或服务不熟悉。你的产品技术性越强,你的用户指南在创建阶段就应该更具描述性。在这个过程中,模糊的词语和短语不会成为你的朋友。要尽可能地具体,以便你的客户能够理解你的产品的更多补救方面。
一张图片比一千字更有价值。这是真的,特别是或用户指南和手册。这一步被大多数公司高度忽视,但在用户指南上解释你的产品特点和方面时,有正确的照片或快照是非常重要的。这样,你的客户就能理解你的产品的哪些方面。
你的用户指南是为了帮助你的客户了解你产品的各种用途。以尽可能简单的方式解释事情,使他们能够轻松地理解其各种功能和方面。