创建用户文档时应避免的错误

我见过太多企业在搭建在线帮助中心时，把大量精力花在内容排版和设计上，却忽略了最根本的问题——用户能不能快速找到它？作为长期研究数字内容体验的人，我始终认为，一个无法被用户轻松定位的帮助中心，跟不存在没什么两样。今天我们就来聊聊那些常见但致命的文档设计误区。

大多数用户只有在遇到迫切问题或需要快速解决时才会去寻找文档。这并不奇怪，因为用户文档的主要目的就是提供一个可访问的产品知识资源。因此，用户依赖文档来实现这一目的。

那么，如何让文档访问尽可能快速直接？答案就是让它容易被找到。正如技术内容专家Adam DuVander总结的那样：“找不到的文档和不存在的文档没有区别。”

例如，如果用户需要在你网站上上下滚动却没有任何指向文档的提示，那至少可以说是不理想的。PCCW Global的网站就是这种情况。这家大型信息通信技术公司提供一系列通信、语音和数据解决方案，但其“资源”选项卡中只有宣传册、案例研究和推广视频。然而，尽管在其主页上找不到任何文档，PCCW Global确实有一份用户指南——你只能通过Google搜索才能找到。更糟糕的是，其一个产品还有更全面的用户文档（包括指南和技术文档），但这些内容托管在另一个网站Console Connect上，而PCCW Global主页上没有任何跳转提示，只有通过弹窗通知才能知晓。这种状况很容易让用户感到沮丧并浪费大量时间。如果你想让用户满意，就别让他们在多个渠道中大海捞针。

用户不应花太长时间在文档中找到所需信息。一旦你确保文档容易找到，还需要提供轻松导航的方式，其中搜索功能必不可少。一个简单的搜索栏可以为用户节省大量宝贵时间。尽管搜索功能已被广泛接受，但有些公司仍然犯下不包含它的错误。例如，流行的消息平台Telegram提供了详细的用户文档，但无论开发文档页面还是高级用户FAQ页面，都没有搜索栏。这意味着用户需要通读整个网页或使用浏览器快捷键来查找信息。换句话说，不包含搜索栏等于告诉用户：你没有考虑他们的便利性。

除了搜索功能，目录也能极大改善导航体验。以Basecamp的用户文档页面为例：登陆后，你立即拥有搜索栏和指向所有内容类型的链接。进入任意指南后，左侧还有另一个搜索栏和目录，显示你当前打开的内容。这些让导航更容易的元素对用户文档至关重要。正如Jonathan DeVore所说：“用户只想阅读他们需要的特定信息，而不是你和团队写的每一个字。”

你知道你的用户是谁吗？你可能能推测出对产品感兴趣的人群画像，但你知道他们的背景、知识水平、兴趣和行业吗？在软件行业，用户的知识水平跨度尤其大。产品营销经理Elizabeth Garcia指出：“你的用户可能包括新手和专家。”那么，如何创建对如此多样化用户群都有价值的文档？最安全的方式就是避免假设用户的知识水平。即使你的研究显示大部分用户是开发人员，你也不应该假设他们知道什么不知道什么。刚毕业的开发者与25年经验的开发者技能水平自然不同。因此，确保文档易读，使用平实的语言，尽可能避免技术行话。以Amazon Alexa语音服务文档的一部分为例，它面向开发者，但即使你不是开发者也能轻松理解——因为作者以故事开头，提供上下文而非直接跳入技术细节。开发者可以了解他们的产品如何与Alexa集成，并思考产品设计、交互和使用等关键问题。

避免技术行话是值得推荐的，但现实是并非总能做到。当必须使用技术术语时，确保用户知道其含义。你可以通过术语表来实现，例如Safaricom的开发者门户网站就提供了重要术语的术语表。

---

Baklib 可帮助您的团队讲述您的故事并管理每个用例的内容：企业网站、在线社区、客服服务台、移动应用程序和客户知识库。Baklib 是一款带有可视化编辑器的无头 CMS，适用于开发人员、营销人员和内容编辑。问题：使用无头 CMS 管理数字内容可能是一项艰巨的任务。如果没有可视化预览，编辑人员通常会迷失方向，即使是简单的更改也需要指导。解决方案：Baklib 拥有页面构建器的用户体验，背后是独创的资源库+知识库+应用库三层架构。这为开发人员提供了自由，并为编辑人员提供了自解释的直观界面。