你想创建信息丰富的用户指南吗?我们的10个顶级提示可以帮助你

Avatar of Author
Ciaran Sweet
on September 22, 2021 · · filed under Product Documentation Product Updates Best Practices Product Documentation Tutorials

用户指南是数字服务交付的一个重要部分。数字化客户期望获得自助服务,要求立即获得信息。通过电话进行的演练已经不能满足要求了;花费数小时的时间来解释那些可以在用户文档指南中得到更好说明的东西。

在Docsie,我们提倡所有企业为客户创建一个信息丰富的用户指南库。这将实现自助服务,减少你的支持工作量,并提供24/7实时访问你的客户所需的信息,以享受和使用你的产品或服务。

Docsie中用户指南和文档的10大提示

。 在我们开始之前,你有办法存储、编写和托管文档吗?

请前往Docsie Onboarding页面,了解以客户为中心的协作、广泛的嵌入、定制的翻译和强大的发布功能,尽在掌握。

现在你已经加入了这个俱乐部,让我们来看看我们的10个顶级技巧吧

1 - 用媒体丰富你的用户指南

。 文字、单词、字母--我们每天都在使用它们。遗憾的是,书面文字无法与视频的真实性或图像的灵感相比。

当创建用户文档指南时,要从用户的角度来阅读。这一节是否可以用GIF、嵌入式视频或注解的图像来更好地解释?如果是的话,请添加一个!

你可以在Docsie中添加图片、嵌入视频和整合iFrame内容。试一试吧!

Docsie中的图像、视频和GIF

2 - 创建一个命令,不,不是绝地的那种!

3 - 适应所有的阅读水平。 你是否认为客户会从你的顶级提示中了解他们的JavaScript?在技术用户指南中,通常建议使用专业术语和复杂的术语。然而,对于非专业人士来说,语言越简单越好! 大多数读者只想知道如何做这件事,并重复做这件事。一种方法是在纸上提供一个复杂的、高层次的概念--然后用一个简化的版本再重复给非专业人士。这就同时满足了技术用户和非专业人士的需求,用一支笔就能写出两页。 "人工智能涉及对人类智能的算法模仿,以追求生产力;人工智能的目的是通过使用计算机代码匹配人类智能来完成工作。"- 两者意思相同,但针对的是不同的受众。 使用Docsie为非专业人士创建书架,为技术用户创建书架。这样,你就可以有书来帮助这两种受众,并通过Docsie门户网站提供完整的托管服务。 ![Docsie实例中为普通人简化的复杂代码](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)

4 - 使用模板,不要再熬夜了!

5--快速编写,经常迭代。 在敏捷软件开发中,口号是快速失败,经常迭代。把这句话应用于用户文档指南,你的员工应该以快速编写和经常迭代为目标。 这并不意味着为了速度而牺牲质量。相反,这可以使客户的反馈和回应在最初的努力中得到减少。这种反馈可以在进一步的用户文档指南迭代中得到利用,并帮助企业变得更加以客户为中心。 Docsie Vocally阐明了读者的反馈,通过评级和屏幕记录来确定他们所阅读的确切内容。在你快速写作和频繁迭代的时候,给它一个机会吧! ! [Docsie Vocally Feedback View](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_8uO5DnYSHSsLteI2X/boo_dqsfhc7ObadQ3xWmV/b9f841c9-1dde-5eee-c723-809f13df3255DocsieVocallyLivePreview.png)

6 - 使用内部反向链接的嵌套知识

。 你的用户指南文档是否与其他页面有反向链接?通过添加链接到文档的相关部分,你可以帮助读者在概念层面上充实和理解你的产品或服务。 当你提到一个特定的特征或功能时,一定要添加一个链接。允许读者快速访问该信息,而不是强迫他们自己去搜索和加载页面。说到账户登录?在你的页面上的 "登录到你的账户 "的文字中添加一个登录URL,以及其他每一个页面。使你的文档在正文中方便和可浏览,而不是一个无尽的图书馆来筛选。 Docsie允许用户指南撰写者创建内部反向链接。只要突出一些文本,然后点击Docsie编辑器工具栏中的🖇️ 按钮。此外,你可以用相对对象链接使链接与语言和版本无关。 ![在Docsie中用对象参考链接建立反向链接](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_dclZdrsTWJrB8WETc/boo_dqsfhc7ObadQ3xWmV/7d8c9e37-3aa6-580d-644b-0d7a8039fa89DocsieObjectLinksforBacklinking.png)

7 - 刷掉蜘蛛网,刷新旧内容

。 你是否有旧的用户指南和文档在网上可见?如果你有1.2版本的文档,而你的产品是1.3版本的,你的文档就不再有意义了。与其为每个版本发布新的文档,不如使用Docsie Versioning。 Docsie版本管理允许用户访问历史和现在的文档版本。随着新版本的发布,旧版本被归档,以达到冗余的目的,同时可以从一个下拉菜单中访问。这一切都在同一个网页上,使用户更容易浏览和找到相关信息。 同样,如果你2021年的最高提示指南在2022年仍在出版,那就更新它吧!改变名称,用最新的研究刷新任何引文和来源,并仔细检查信息是否仍然相关。拂去蜘蛛网,保持常青;内容总是可以被重新利用。 ![在Docsie中寻找较早的内容的版本选择器](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_OaCUumTVGz3CQ2ha2/boo_dqsfhc7ObadQ3xWmV/4edbd225-b61b-0921-4f63-e55b3052ed28DocsieVersionsPickerMenu.png)

8 - 小型化的任务,分批完成

。 在写作时,你是否一次性写完了整个页面,没有任何预先计划?这其中有一些归结为作家的个人偏好。然而,通过将任务小型化,可以更快、更专注地完成工作。 用H1和H2标签创建一个简单的结构,并对每个部分进行简要描述。写作时使用这个结构,解决个别章节的问题,而不是担心整个页面的问题。这在写作行业中被称为大纲。大纲提供了在写作开始前与编辑进行反馈的机会,并在作者写作时充当指导性框架。 在Docsie中创建一个新书,并为大纲添加一些基本的标题和文字。你还可以使用右侧的菜单添加任务,在多个团队成员合作编写内容时,将工作分解成小批量。版本历史意味着,如果作家添加了不太理想的内容,你可以返回去--这对于快速写作和经常迭代来说是完美的 ![Docsie中任务分配者的日历](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)

9 - 为更多的内容阅读者提供目录

。 对于复杂多样的用户指南文档,文字墙会让读者望而生畏。这可以通过一个全面的目录来解决。这在百科全书中很常见,可以帮助用户识别和跳转到相关信息,同时为知识门户环境提供结构。 Docsie文章、书架和工作空间可以创建一个目录。这将自动显示在你的知识门户的左侧--为你的知识库提供一种简单的导航方式。有了这个绝招,Docsie就为你做到了 ![目录由Docsie自动生成](https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_oxDNcw0pA6rCZa3J7/boo_dqsfhc7ObadQ3xWmV/35d48662-895e-b83f-c7c3-abb0ce6edd0dTableofContentsDocsie.png)

10 - 掌握你的主题

。 你的作家是一个主题专家吗?同样地,你的作家是否足智多谋,善于研究他们可能不熟悉的主题?最终,尽管有我们所有的提示,作者决定了你的用户文档指南的质量。 他们越了解你的产品,他们的工作就越准确。允许写手灵活地测试和破解你的产品,因为用户可能会遇到类似的问题。更好的是,让你的作者与你的销售团队一起完成产品演示,让他们亲身体验销售管道和其中包含的信息。这再次推动了一致性,同时把你的写手变成了用户。不是所有的写手都能成为用户,但所有的用户都能通过实践知识成为好的写手。

在Docsie中把这些技巧付诸实践!


Subscribe to the newsletter

Stay up to date with our latest news and products