本文探讨了 Twilio 的知识库最佳实践，强调了其文档的结构、用户体验和对开发者的支持，展示了如何通过有效的文档提升品牌信任和用户满意度。
https://document360.com/blog/knowledge-base-best-practices/
Twilio 是一个用于消息传递、语音、视频和身份验证的 API（应用程序编程接口）。
这意味着 Twilio 帮助公司通过网络连接提供各种通信服务，这种方法比开发内部解决方案具有许多优势。
Twilio 通常用作另一家公司技术堆栈的一部分，而不是本身作为一项服务。这为 Twilio 提供了利用其文档进行营销和学习的独特机会。
我们已经将 Twilio 的知识库纳入了8 个顶级 SaaS 知识库的概览中。现在我们将对其知识库进行深入拆解，并学习一些知识库最佳实践。
Twilio 简介
Twilio 的软件是平台即服务(PaaS)，这意味着它通过云提供公司技术基础设施的核心部分。
在传统上由电信巨头主导的市场中，文档是其战略的关键部分，而电信巨头通常反对任何创新的市场采用其服务。
由于他们的战略，Twilio 现在已成为技术领域的知名品牌。该公司被列为科技独角兽，在 11 轮融资中筹集了超过 2.16 亿美元。
Twilio 还超越了许多传统行业类别，这使得它的文档更加有趣。
Twilio 是企业对企业 (B2B)，因此它需要吸引整个团队，甚至是拥有大量投资预算的大公司。该公司的商业模式也是企业对开发商（B2D）。这意味着 Twilio 还必须吸引积极使用其系统的个人开发人员。
Twilio 的知识库
Twilio 知识库在主网站导航上标记为“文档和工具”。这凸显了他们的知识库软件的交互性，这是一种实用资源，也是一种学习资源。
Twilio 的知识库针对开发人员，特别是 SaaS（软件即服务）应用程序的开发人员。他们的产品套件和系统是为有兴趣外包通信基础设施的公司设计的，以帮助他们无限扩展。
因此，Twilio 的产品文档技术性很强，而且始终是一项艰巨的工作。知识库本身基本上就是一个产品，目标最终用户是开发人员——尽管这些可能不是主要客户。
Twilio 将其开发者用户视为人类，而不是机器人。
主页
Twilio 使用了一种稍微不寻常的文档格式，因为它使用了一个大的英雄部分，然后是一个主要部分的列表。一旦您到达知识库，他们还会推送 Twilio 订阅，进一步建议他们使用他们的文档进行营销。
此时将用户引导到正确的部分，并按产品而不是文档类型进行组织。与 Stripe 不同，Twilio 不使用其产品的内部名称，而是使用描述性名称。
它很简约但很有效。只有单击某个类别后，Twilio 文档的复杂性才会显现出来。
开发商宣传
一旦您深入了解 Twilio 的公司知识库，您就会发现 Twilio 文档非常全面。
文档的完整性是开发人员最关心的问题，83% 的开发人员表示文档是他们了解新技术的主要方式（ 2018 年 Stack Overflow 开发人员调查）。
开发者宣传是 Twilio 品牌的核心部分。如果开发人员对 Twilio 文档充满热情，那么这会提升整体品牌并建立信任。开发人员会向他们的朋友推荐使用 Twilio。
因此，对于直接针对开发者的 PaaS 和 SaaS 公司来说，社区建设是核心优先事项。
这就是文档非常方便的地方。尽管 Twilio 的核心受众可能习惯于浏览大量文档，但内容的组织方式一开始就不会显得令人不知所措。这并不意味着它缺乏深度。
交互式 API 调用是 Twilio 的一项关键功能，只需单击按钮即可以多种编程语言执行这些调用。
您可以使用他们的可编程短信产品在不同的编程语言之间切换。该界面经过精心设计，具有视觉吸引力，鼓励用户尝试。
尤其是在开发人员文档中，文档始终是产品营销的一种形式。
用例
然而，对于非开发人员来说，可能很难从一开始就理解 Twilio 平台的用途，因为它是一个 API 服务。它通常与其他公司的技术堆栈集成，因此您可能在没有意识到的情况下多次使用 Twilio 的服务。
Twilio 巧妙地利用文档和营销之间的微妙界限来吸引所有客户，无论其工作角色如何。
它在其主网站上提供了方便的用例来展示 Twilio 的功能。此类内容为服务提供了一些上下文，否则乍一看可能会显得非常抽象。
这一切都归结于考虑你的受众，他们可能分为不同的群体。
虽然开发人员也可能从阅读示例用例中受益，但 CTO（首席技术官）、初创公司创始人、首席执行官和产品经理也将从客户案例研究中获得重要的理解。
Twilio 要求其客户进行如此巨额的投资，客户将把其技术架构的整个部分外包给一个未知的团队。可靠性和透明度是 Twilio 文档的关键，也是该公司在行业中取得如此成功的部分原因。
它反映了 Twilio 文档的实用性和实践性。重点是实时展示服务的工作代码示例和 API 调用。
Twilio 甚至链接到用例中的文档，将其内容结合起来以获得整体营销和文档体验。
视觉设计与布局
视觉设计在开发人员门户中尤其重要，因为文档可以让您很好地了解使用 Twilio 平台的情况。
Twilio 按照Stripe 文档的精神设计了其知识库系统。注重通过现代、时尚的界面和密集但不混乱的方式实现清晰度。
自定义您的文档设计和布局以适合您的品牌颜色和设计。
以蓝色为主色调的深色配色方案营造出一种平静的感觉——这是大多数人在使用 API 时所需要的。它是 Twilio 品牌的一部分，但也传达了一种庄重感和重要性——这正是您想要的通信基础设施。
它很有效，但仍然很独特。 Twilio 视觉品牌非常容易辨认。
代码交互性也是设计的一个重要元素，因为 Twilio 开发人员可以直接使用从内部知识库到任何面向客户的软件的 API。他们可以立即启动并运行并轻松测试他们的软件。
品牌声音
与其视觉品牌不同，Twilio 在其知识库中将其个人品牌基调和声音保持在最低限度。
其在线知识库中包含的信息非常技术性，因此，它并没有揭示 Twilio 品牌之间的任何个性。
正如高技术文档的典型特征一样，Twilio 的品牌声音是中立且切题的。 API 文档中没有文案的空间。 直接性在技术文档中非常重要。您不希望公司的议程妨碍开发人员开始使用您的技术或对您的技术进行故障排除。
信息架构/导航
一旦你真正点击主页后的文档，导航就完全不同了。您不会被一系列产品所困扰，而是会在不同的文档类型之间进行切换。
Twilio 在其顶部知识库导航中将其文档分为五个类别，分别对应于主站点页脚：
快速入门
教程
API参考
辅助库
API状态
Twilio 以其专业知识和天赋为其文档受众使用了信息架构。通过查看导航选项和互连等视觉提示，受众可以很好地了解文档包含的内容。
有时，其知识导航有点令人困惑，因为 Twilio 为如此多的产品提供复杂的信息，但总的来说，很容易重新定位自己。
分类
至于分类法，Twilio 正在打破它。您的分类基本上是您的知识库类别和内容的命名约定。
根据分类法，您可以立即看到 Twilio 提供的文档范围，并且开发人员将相对熟悉此类别术语。
就分类中的内容名称而言，Twilio 使用面向操作的内容标题来尽可能具有描述性。最好远离特殊的名称，因为您想透露尽可能多的信息。
Twilio 的核心用户不会只是浏览知识库，而是会深入了解，并将其作为其工作流程的一个组成部分。命名的简单性（这并不容易实现）使他们的工作变得更容易。
可查找性
Twilio 知识库的左侧导航确实会根据您所在的部分而变化。为了解决这个问题，它始终具有相同的顶部导航和广泛的概述类别。
将导航锚定在左侧通常是提高文档效率的更好方法。
用户可以随时查看知识库的整体结构，并在完成任务时快速导航。揭示结构使您的用户能够掌控自己的学习。
由于文档的复杂性，Twilio 必须进行调整。
搜索功能
Twilio 不会过度依赖搜索功能或强迫用户遵循预定义的路径。然而，其知识库的搜索功能非常复杂。
结果甚至包含交互式代码示例，这可能意味着他们拥有有史以来最令人印象深刻的搜索工具。在这种情况下，使用颜色和形状来分解结果也可以增加用户体验。
还在使用旧的搜索功能来查找相关信息吗？开始切换到基于人工智能的交互式搜索！
代码片段
正如我们刚刚提到的，Twilio 非常热衷于交互式代码和实时测试 API 调用。
内容页面被很好地分解，使代码片段在视觉上更具吸引力。总体而言，该界面让人想起 Code Pen 等代码编辑器，并且使用起来很有趣。
此类知识库必须能够出色地处理多种编程语言的文档。他们必须重复 PHP、.NET、Java、Node.js、Python 和 Ruby 的大部分文档，这导致需要维护大量文档。
事实上，您可以在不同语言之间切换，这使得演示文稿比在同一页面上显示所有语言更加用户友好。
左侧边栏中拥有复杂的可视化标签系统，可帮助 Twilio 的用户通过编程语言、产品或平台浏览内容。他们还必须考虑不同的操作系统（Windows、Mac、Linux），所有这些都需要处理标签和切换。
多走一英里
API 文档可能非常枯燥，但它对于成功的 API 绝对至关重要。
学术和技术作家 Bob Watson 在其专注于 API 文档的博客 Docs by Design 中讨论了优秀文档的重要性。 Bob 谈到 将您的文档视为具有自己独特客户群的产品。
Twilio Quest 是他们自己的游戏，旨在帮助潜在客户进入 Twilio 平台。这是一种独特且有趣的方式来游戏化他们的文档。
Twilio 还拥有资源用于举办自己的以客户/开发人员为中心的会议，称为 Signal：
这表明他们通过培育社区对客户和用户群进行了充分的投资。
还在寻找一流的文档门户吗？ Baklib 可能是正确的选择。
错误信息
错误消息也是文档中不可或缺的一部分，但您通常不会将它们包含在您的知识库中。 Twilio 则不同。
Twilio 在文档中包含了其 API 中的常见错误消息字符串，帮助用户了解平台出了什么问题。
例如：
Twilio 发布了完整的错误和警告目录，包括引发错误的可能原因 - 甚至更好 - 可能的解决方案。这有助于他们缩短实际的错误消息，并为需要的人提供更多信息。
用户体验
卓越用户体验的首要原则定义为：
“模范用户体验的首要要求是满足客户的确切需求，无需大惊小怪或麻烦。” （尼尔森诺曼集团）
总体而言，Twilio 的用户体验非常出色。 NN Group 继续表示，必须融合多个学科才能创建这种类型的用户体验，包括营销、工程和设计。这正是 Twilio 所做的。
Twilio 没有将他们的文档视为属于一个团队的孤岛，而是在文档背后组织了公司的全部力量。这以其卓越的用户体验得到了回报。
在这种情况下，客户的需求首先是了解 Twilio 平台，其次（但更重要的是）成功使用 Twilio。
将这些最佳实践应用到您的知识库中，并使您的文档对客户保持新鲜和干净。
热门小贴士
遵循 Twilio 的示例，并为您的特定受众使用最佳的知识库格式。
即使您不发布 API 文档，您仍然可以定制您的知识库来取悦您的用户。
以下是我们从 Twilio 文档中学到的重要技巧的总结：
敢于与众不同——考虑开发一款游戏来吸引您的客户或使您的代码示例具有交互性
迎合你的用户——如果你的受众不是花钱的人，那也没关系
保持你的写作风格直接、切中要害——不要用文案写作技巧惹恼你的开发者用户
展示您的导航 - 让您的用户更好地了解文档中的整体信息架构
博客
