用户文档和帮助指南及 10 个最佳示例

如果您向客户销售产品，您可能会听说过用户文档。

客户总是需要帮助，而用户文档是提供这种帮助的最佳方式之一。

如果没有文档，客户只能在黑暗中摸索，或者联系您的支持团队。

很可能的是，如果他们必须向人工寻求支持，许多客户就不会打扰。他们只会放弃你的产品，也许会要求退款，而这个结果对任何人都没有好处。

提供用户文档意味着您使客户能够进行自助服务。每当他们对您的产品有疑问时，他们都可以查阅您的在线知识库以获取答案。

但不明确或令人困惑的用户文档会让客户生气，对产品其他部分的质量产生怀疑，并对公司未来的购买产生负面影响。为客户提供有价值的用户文档时，风险很高。

什么是用户文档？

用户文档是您向最终用户提供的内容，以便他们更成功地使用您的产品或服务。用户文档也称为用户指南、说明手册或用户手册，可以帮助客户了解您的产品。

用户文档可以通过各种不同的媒介交付给客户。它可以是在线知识库、印刷手册或视频教程。由您决定什么最适合您的客户并提供对他们最有用的格式。

提供有用的用户文档可能会决定客户体验的成败。它可以帮助客户充分利用您的产品或服务，并提供联系客户支持团队的可行替代方案。

另请阅读： 什么是客户自助服务？客户自助服务的优点和最佳实践。

用户文档的好处

让新用户轻松入门

对于产品的任何新用户来说，总是有一个学习曲线。没有任何产品如此直观，以至于客户可以立即了解其所有功能和用例。

如果您为新用户提供信息丰富的用户文档，他们更有可能成功使用您的产品。他们可以花时间浏览文档并了解产品的工作原理。

这一切都是为了在售后创造积极的客户体验。 86% 的客户表示，如果企业投资于欢迎和教育客户购买产品后的入职内容，他们将更有可能保持对企业的忠诚度。

降低客户支持成本

当客户有可以依赖的用户文档时，您的客户支持团队的电话和电子邮件就会减少。减轻客户支持团队的负担意味着成本降低，您可以用更少的客服人员帮助更多的客户。

一旦启动并运行，用户文档的维护成本几乎为零。自助服务交互的成本以便士为单位，而实时客户支持交互的成本可能高达 12 美元。

客服人员可以从处理平凡、重复的查询中解放出来，并有更多时间来帮助那些真正需要帮助的客户。当您有可用的用户文档时，支持代理可以将客户指向相关文章，并显着缩短解决问题所需的时间。

另请阅读：帮助中心和客户服务台的知识管理：来自全球 500 强企业的经验教训。

提高客户满意度

用户文档使您的产品更易于使用并提高客户满意度。当您为客户提供帮助自己摆脱困境的方法时，您就真正改善了客户体验。

您不是放弃您的客户或强迫他们致电您的支持团队，而是授权他们自己解决问题。用户文档是客户期望的最基本的支持形式，如果他们找不到它——或者质量不够——他们会感到失望。

70% 的客户现在希望公司网站包含自助服务应用程序。自助文档确实是黄金标准。

记录的用户指南将减少错误使用的责任

如果您不警告客户不要错误使用，则可能会导致您的产品出现危险应用并对客户造成人身伤害。贵公司有法律义务为客户的健康和安全提供警告。

当您正确记录您的产品时，可以防止客户错误地使用它。如果您针对产品的错误使用方式提供足够的警告，那么这意味着您的公司不太可能成为法律诉讼的接受者。

更好的销售宣传品

当潜在客户可以访问您的用户文档时，他们可以更深入地了解您的产品的工作原理，这可以帮助他们做出购买决策。它还会给客户留下良好的印象，因为这表明您将在售后支持他们。

更好的是，当与客户交谈时，您的销售团队可以参考文档。这有助于销售代表与客户就产品进行更有意义的对话，并提高客户购买的可能性。记录、存储和共享技术手册变得简单。

让您的用户文档脱颖而出的技巧

在这里，我们将介绍一些有用的提示，这些提示将提升您的用户文档并确保您为客户提供帮助。

首先，你应该明白你是为谁写作。

• 谁是你的客户？

• 他们的需求是什么？

• 他们试图解决什么问题？

在开始编写任何文档之前，您需要清楚地了解您的客户实际上是谁。您可能会发现您的客户是各种各样的，并且您的文档可以满足不同的需求。

尝试安排一些客户访谈，以了解更多有关他们如何使用您的产品的信息。您还可以与距离您的客户最近的支持团队交谈，他们将能够为您提供有关您的客户的真实情况。

当您清楚地了解您的客户是谁时，您可以定位您的文档并使其更易于使用。您可以将写作的基调调整到正确的水平，以便与用户产生共鸣，并为他们提供足够的信息来完成任务。

使用通俗易懂的语言

在实际编写文档时，请确保您的语言简单明了。如果客户无法理解您的文档或必须通过 Google 搜索您所选择的单词的含义，他们将不会欣赏它。

用通俗易懂的语言写作并不意味着简化内容，而是以任何人都能理解的方式编写。远离行业术语和复杂的术语，除非您确实需要使用它们并且在这种情况下提供定义。

当你完全沉浸在一个产品中时，很难从局外人的角度来写它。您每天使用的各种术语会让客户感到困惑。

在查看文档的阶段，请尝试从客户的角度来看待它。假设他们对你的产品一无所知——他们会理解你的帮助内容吗？

准备分步说明

将用户文档格式化为分步说明意味着您的客户将可以访问您的内容。没有向用户展示一长串的文字，而是清晰地列出了分步说明，以便客户可以一次按照一个步骤进行操作。这可以让他们专注于任务并避免分心。

当您被迫将文档分解为步骤时，您将更容易看出您的内容是否有意义。通过以这种方式简化您的文档，您可以更轻松地遵循并改善客户的用户体验。

分步说明可以降低用户犯错误的可能性，并增加他们阅读完文档的可能性。

添加视觉内容

一张图片胜过千言万语。通过提供图像、视频和 GIF，让您的文档对您的客户来说更有趣。由图像和视频组成的文档比令人畏惧的文本墙更吸引用户。

有时，使用视觉表示来展示某物如何工作会更容易，并且您应该以最方便的方式向客户传达信息。用文字描述某事物可能比简单地提供代表同一事物的图像要困难得多。

当您提供视觉表示时，用户可以将他们正在做的事情与您用于说明的图像或视频进行比较。这使客户可以更轻松地检查他们所做的事情是否正确，并更快地完成故障排除体验。

使内容易于搜索

拥有在线用户文档的优点是您可以让客户对其进行搜索。能够在文档中搜索关键字使客户可以轻松地立即找到他们需要的内容，而不必浪费时间阅读整个手册。

如果您投资了像 Baklib 这样的知识库软件，您的在线知识库将配备一个强大的搜索栏，可以为您网站的每个页面建立索引。客户只需在搜索栏中输入他们要查找的内容，系统就会在他们输入时预测结果。使用人工智能驱动的搜索引擎搜索整个知识库，而不仅仅是文章标题，可在几毫秒内返回上下文相关的结果。

能够搜索文档中的内容可以使整个用户体验变得更好，因为它可以节省寻找问题解决方案的宝贵时间。搜索栏应该固定在每个页面上，以防您的内容不完全是客户正在寻找的内容，从而允许他们再次搜索。

添加目录

除了在文档中搜索内容之外，客户还会在各个文章中寻找特定部分。这是目录可以真正派上用场的地方。

目录出现在文章的开头，列出了文档中包含的所有部分。客户可以点击他们认为与他们最相关的部分，而不必从头到尾阅读整篇文章。

拥有目录可以节省客户的时间，并确保他们可以轻松浏览长文章。如果他们阅读目录并发现他们要查找的内容未包含在内，他们会很快离开页面并找到另一篇与他们的搜索更相关的文章。

相关文章链接

在编写用户文档时，您的内容可能需要更广泛的上下文来解释某些术语，或者更详细地了解产品的特定方面。最好的方法不是重复自己，而是链接到客户可能认为有用的相关文章。

要记住的关键是要谨慎使用互连。您不想向客户展示除了链接之外什么都没有的整个页面。在新选项卡中打开链接也是一个好主意，这样您就不会让客户离开他们当前正在使用的页面。

借助Baklib ，您可以利用我们的损坏链接检查器，它可以帮助您验证和监控知识库中的所有链接。立即修复所有损坏的链接并为您的客户提供更好的读者体验。

收集反馈

您的用户文档从未真正完成。您需要持续收集客户的反馈，以便找出可以改进的领域或缺失的内容。

您需要查明您的用户文档是否真正为您的客户提供帮助，而最好的方法就是询问他们。文档不应仅仅成为阻止客户联系人工支持的障碍。它应该是您的支持团队的可行替代方案，并且很有可能解决他们的问题。

客户会很感激您询问他们的反馈——只要确保在您实施了他们的更改后告诉他们，从而关闭反馈循环即可。使用 Baklib 这样的软件，您可以收集文章评级等反馈，并启用对文章的评论。

保持新鲜和更新

请记住，您的用户文档必须与您的产品和服务保持同步。设置定期审查以更新您的文档并确保其准确反映您的产品。

您的用户文档可能需要新文章和现有文章的更新。让您的代理可以轻松标记文档何时需要更新，并为他们创建一个工作流程来请求创建新文章。您的支持代理可能是编写文档的最佳人选，因此请授权他们这样做。

不要害怕删除旧文章或删除从未读过的文章。最好只在用户文档中包含高性能内容，以便用户可以更轻松地浏览您的内容。

用户文档的 10 个最佳示例

1.Baklib

Baklib 提供了以下客户自助服务数字平台：

问答社区

客户可以在问答社区中提出问题，其他客户或企业的客服人员、专家等可以进行回答和交流。问答社区有助于形成客户之间的互助氛围，同时也能让企业收集到客户常见的问题和痛点，进一步完善知识库和产品服务。点击这里查看。

• 知识库：作为多组织多层级的文档知识库中心，用于管理和规范企业知识，是连接资源库和应用库的内容中枢。企业可将产品手册、操作指南、常见问题解答等内容整理到知识库中，客户能够自主访问知识库，快速查找所需信息，解决常见问题，减少对人工客服的依赖。

• 帮助中心：Baklib 的帮助中心支持多主题模板样式、权限管理、协同管理、多级栏目分类、多端适配，支持富文本和 Markdown 编辑，可绑定独立域名，还能接入百度统计、友盟、51LA 等统计工具以及美洽、udesk 等客服系统，并且具有数据统计功能，方便企业了解客户对帮助中心内容的使用情况，以便优化和改进。点击这里查看。

2. Wibu

WIBU构建的在线用户文档，好处：

• 帮助中心简洁直观，块级结构，方便阅读，帮助用户自主学习；

• 全天候帮助支持，减缓客服压力，提升用户使用舒适感；

• 客户在线就能观看到完整的操作指南和产品更新，传输效率高零成本。

威步科技帮助中心预览：

威步科技帮助中心-首页

Wibu-Systems全球领先的软件加密技术提供商，全球加密狗领导厂商。提供独创的全自动软件加壳工具，帮助软件商5分钟完成软件加密，防止代码反编译；提供6000种授权组合方案，帮助获得更多商业机会；提供先进的授权管理平台，帮助节约授权流转成本,提高授权工作效率。

》》点击这里了解更多

3. Convertlab

在之前，Convertlab在官网做一个自带CMS系统的知识分享模块，但是自主开发费时费力，影响项目进度。

后来使用Baklib迁移在线文档之后：

• 知识分享模块有现成模板可以迅速上线，省去了自主开发的时间成本和人力成本；

• 支持自定义域名，可以直接加载到官网，使用灵活；

• 操作简单功能强大，有效降低了日常运营时间。

Convertlab以融合“营销技术”和“运营艺术”为特长，基于自主创新开发的DM Hub产品，提供专业、便捷、智能的一体化营销云解决方案。 借助互联网大数据、人工智能等技术，帮助企业构建贴近用户真实行为的画像洞察。

通过营销自动化精准触达和交互，提升客户体验，落地数据驱动的新型营销，实现业绩的超级增长。 目前，Convertlab已为超过250家企业提供企业级服务并获得最佳实践，服务行业涉零售、金融、互联网、快消。

》》点击这里了解详情

4.Stripe文档

Stripe 是针对互联网企业的在线支付处理。各种规模的企业（从小型初创公司到大型企业）都使用 Stripe 来接受付款、发送付款以及在线管理其业务。

Stripe 拥有一些最好的文档。 Stripe 拥有干净整洁的界面，通过突出的搜索栏立即欢迎客户访问文档。它为想要直接深入了解 Stripe 的更多信息的用户提供了方便的指南。

然后，您可以通过 Stripe 了解更多有关业务运营和金融服务的信息。每个部分附带的大而简单的图像邀请客户探索知识库并从 Stripe 订阅中获得更多收益。

您可以探索 Stripe 产品，这些产品以简单列表的形式呈现，旁边还有代表产品的彩色图标。

Stripe 有大量的文档需要组织，并且可以很好地隐藏页面上不必要的元素。当您导航到文档的页面级别时，会打开左侧导航菜单，其中显示该类别中的所有页面。

当您阅读文章底部时，您可以评价该页面是否有帮助，并且有一个联系支持团队的链接。

Stripe 的文档确实非常出色，并且为用户带来乐趣。

5. Whatfix 文档

Whatfix 是一个数字采用平台，可帮助企业引入、培训和支持其应用程序用户。

他们有一些出色的文档来帮助用户掌握他们的技术。他们的知识库的第一页是入门指南，用于引导新用户并告诉他们 Whatfix 的全部内容。

Whatfix 投资制作了入门视频，向客户解释如何使用该软件。他们意识到许多客户可能对数字采用平台的概念感到陌生，并煞费苦心地解释它们是什么。

Whatfix 在可见的左侧菜单中清楚地显示其知识库的内容，因此客户可以自由单击以查找他们感兴趣的文章。

在单独的文章页面上，Whatfix 为用户提供了请求演示的选项。这反映了这样一个事实：他们的许多文档用户可能是试图了解有关 Whatfix 的更多信息的潜在客户。

如果您通过真实的电子邮件地址找不到所需的内容，他们会邀请您联系支持团队。您可以通过简单的“赞成”或“反对”来评价该文章是否有帮助。

6.Ahrefs 文档

Ahrefs 是一个 SEO 软件套件，允许客户建立链接、研究关键词、进行竞争对手分析并跟踪他们的排名。 Ahrefs 的独特卖点之一是它的易用性，因此提供用户文档是其产品的重要组成部分。

Ahrefs 从一个巨大的搜索栏开始他们的知识库，邀请客户开始寻找内容。搜索栏下方是一个类别列表，从入门指南开始。

如果您向下导航到类别级别，突出的搜索栏仍然在视图中。它列出了该集合中有 20 篇文章，以便用户知道有多少内容可供浏览。

在单个文章级别，搜索栏仍然存在。 Ahrefs 的界面非常简单，除了出现在文章顶部的面包屑之外，不会向您显示任何类别。他们不希望任何事情分散用户阅读文档的注意力。

7. 微软文档

微软是一家跨国科技公司，生产计算机软件、消费电子产品、个人电脑及相关服务。

微软有大量的文档需要组织，他们采取的方法是在主页上提供搜索栏。他们为用户可以搜索的内容提供建议，包括文章、培训和代码示例。

Microsoft 知道他们需要满足广泛的用户需求，因此他们按产品列出了文档。这可以帮助客户知道他们正在搜索什么，并且是组织内容的好方法。

当深入到类别级别时，微软为用户提供解决方案、场景和资源。当您想到 Microsoft 实际上拥有多少文档时，您会惊奇地发现他们能够将所有文档组织得井井有条。

在单个文章级别，微软将类别中的所有文章显示在左侧导航上，以便用户可以自行定位。在右侧有一个目录，以便用户可以查看文章的所有部分并跳转到正确的位置。

8.Twilio 文档

Twilio 是一个客户参与平台，数十万家企业使用它来为其客户构建独特的个性化体验。

Twilio 鼓励客户按类别浏览，列出了主要类别标题，包括 Twilio Flex、SMS 和语音。他们有一个随意的“Ahoy world”消息，指出他们的文档是为开发人员提供的。

浏览 Twilio 文档的用户可能拥有大量的技术知识。 Twilio 的内容具有适当的技术性，但以视觉上吸引人的方式布局。

当您进入类别级别时，Twilio 会打开一个左侧导航菜单，其中显示该类别中包含的所有文章。您可以使用右上角的小部件对该页面进行评分（最高为五颗星）。

9.Canva 开发者文档

Canva 是一个图形设计平台，您可以使用它根据模板创建社交媒体图形、演示文稿、海报和其他视觉内容。

Canva 开发人员文档有一个非常清晰的界面，右上角有一个小搜索栏。文档站点的主页是其知识库中包含的内容的简单概述。

当您向下导航到 Canva 的快速启动部分时，内容的布局方式完全相同，但还包括图像以帮助用户更好地理解说明。 Canva 通过在页面顶部提供链接，使开发人员可以轻松创建支持票证。

当您到达页面末尾时，您可以选择向前或向后切换到用户文档中的其他内容。您可以评价该页面的有用性，为 Canva 团队提供宝贵的反馈。

10.Netflix帮助指南

Netflix 是一家订阅流媒体服务和制作公司。它提供电影和电视剧库。

在 Netflix 用户文档的主页上，您会看到一个大型搜索栏，邀请用户开始输入他们的查询。 Netflix 强调登录以获得更个性化的帮助，这表明他们的知识库主要面向现有客户。

在单个文章级别，界面简单明了，对正在阅读文档的客户的干扰最小。 Netflix 链接到其他可能有帮助的文章，并提供可能帮助用户解决问题的建议文章列表。

在文章页面的底部，Netflix 要求客户评价文章是否有帮助。它们还包括客户如何通过致电公司或开始实时聊天与人取得联系的链接。

结论

如果您想销售成功的产品或服务，用户文档至关重要。客户期望它，您的支持团队也需要它。良好的用户文档易于使用且易于遵循，可增强客户体验并吸引客户再次光顾。

如果客户喜欢您的产品体验并相信您在照顾客户方面投入了精力，他们可能会再次向您购买。用户文档旨在了解更大的前景并规划客户保留。这是对客户支持策略的长期投资。

用户文档是一封写给您的客户的情书，他们的业务使您感到荣幸。这是您展示您对他们的关心程度的机会。

常见问题

• 文档有哪些类型？

  • 学习导向：教程。

  • 目标导向：操作指南。

  • 以理解为导向：讨论。

  • 信息导向：参考材料。

• 用户文档和技术文档有什么区别？

  • 技术文档比用户文档包含更广泛的主题。技术文档可以是内部的，也可以是外部的，但用户文档的开发始终考虑到最终用户。与技术文档相比，开发用户文档的过程需要最少的技术背景。

• 用户文档的示例是什么？

  • 用户手册、用户指南、软件文档、使用手册、培训手册、政策手册、SOP 手册。