Twilio开发门户的知识库最佳实践

Twilio 是一个用于消息、语音、视频和身份验证的API。

这意味着 Twilio 帮助公司通过 Web 连接提供各种通信服务——这种方法与开发内部解决方案相比具有许多优势。

Twilio 通常作为另一家公司技术堆栈的一部分来使用，而不是作为一项独立服务。这为 Twilio 提供了独特的机会，既可以将文档用于学习，也可以用作营销。

我们已经将 Twilio 的知识库纳入了我们对 8 个顶级 SaaS 知识库的分析中。现在，我们将对其知识库进行深入剖析，并学习一些知识库最佳实践。

Twilio 简介

Twilio 的软件是 平台即服务，这意味着它通过云交付公司技术基础设施的核心部分。

在一个传统上由电信巨头主导、且通常反对任何创新性市场应用其服务的市场中，文档是其战略的关键部分。

由于他们的战略，Twilio 现已成为科技领域一个知名品牌。该公司被归类为 科技独角兽，并在 11 轮融资中筹集了 超过 2.16 亿美元。

Twilio 还超越了多个传统行业类别，这使得其文档更加有趣。

Twilio 是面向企业（B2B）的，因此它需要吸引整个团队甚至是有大量预算投资的大型公司。该公司的商业模式也是面向开发者的（B2D）。这意味着 Twilio 还必须吸引那些积极使用其系统的个体开发者。

Twilio 的知识库在其主网站导航上被标记为“文档与工具”。这凸显了他们知识库软件的互动性，它既是一个实用资源，也是一个学习资源。

Twilio 的知识库面向开发者，特别是 SaaS（软件即服务）应用的开发者。他们的产品套件和系统专为那些有兴趣将通信基础设施外包以帮助其实现近乎无限扩展潜力的公司而设计。

因此，Twilio 的产品文档技术性很强，并且始终处于持续完善中。这个知识库本身基本上就是一个产品，目标最终用户是开发者——尽管他们可能不是主要客户。

Twilio 将其开发者用户视为人，而非机器人。

主页

Twilio 的文档采用了一种略显不寻常的格式，它使用了一个大型的主图区域，然后列出了主要部分。您一进入知识库，他们就在推广订阅 Twilio，这进一步表明他们将文档用于营销目的。

此刻的重点是将用户引导至正确的部分，并且按产品而非文档类型来组织。与 Stripe 不同，Twilio 没有为其产品使用内部名称，而是使用了描述性的名称。

这种设计极简但高效。Twilio 文档的复杂性只有在您点击某个类别后才会显现。

开发者倡导

一旦您深入了解 Twilio 公司的知识库，您会发现 Twilio 的文档极其详尽。

文档的详尽性是开发者的一个核心关切点，83% 的开发者表示文档是他们了解新技术的主要方式（Stack Overflow 2018 年开发者调查报告）。

而开发者倡导是 Twilio 品牌的核心组成部分。如果开发者对 Twilio 的文档充满热情，这将提升整体品牌并建立信任。开发者会向他们的朋友推荐使用 Twilio。

因此，对于直接面向开发者的 平台即服务（PaaS） 和 SaaS 公司来说，社区建设是核心优先事项。

而这正是文档能派上大用场的地方。尽管 Twilio 的核心受众可能习惯于阅读厚重的文档，但其内容的组织方式首先是为了不显得令人望而生畏。这并不意味着它缺乏深度。

交互式 API 调用是 Twilio 的一个关键功能，只需点击一个按钮，就可以用多种编程语言执行它们。

您可以在不同的编程语言之间切换，以开始使用他们的可编程短信产品。界面经过精心设计，视觉上吸引人，鼓励用户尝试。

尤其是在开发者文档中，文档始终是产品营销的一种形式。

使用场景

然而，对于非开发者而言，由于它是一项API服务，可能一开始很难理解Twilio平台是做什么的。它通常与其他公司的技术栈集成，所以你可能在不知不觉中多次使用过Twilio的服务。

Twilio巧妙地利用了文档与营销之间极其微妙的界限，来吸引其所有客户，无论其工作岗位如何。

它在主网站上提供了方便的使用场景来展示Twilio的功能。这类内容为一项初看可能相当抽象的服务提供了一些背景信息。

这一切都归结于思考你的受众，他们可能被划分为不同的群体。

虽然开发者阅读示例使用场景也可能受益，但首席技术官、初创公司创始人、首席执行官和产品经理也将从客户案例研究中获得至关重要的理解。

Twilio要求其客户进行如此巨大的投资，客户将把其技术架构的整个部分外包给一个未知的团队。可靠性和透明度是Twilio文档的关键，也是该公司在其行业取得巨大成功的部分原因。

这反映了Twilio文档是如何实用且注重实践的。重点是提供有效的代码示例和实时展示服务的API调用。

Twilio甚至在使用场景中链接到其文档，将其内容连接起来，提供一个整体的营销和文档体验。

视觉设计与布局

视觉设计在开发者门户中尤为重要，因为文档能让用户直观感受到使用Twilio平台会是一种怎样的体验。

Twilio设计其知识库系统的理念借鉴了Stripe文档的精神。其核心在于通过现代、简洁的界面实现清晰度，内容密集但不显杂乱。

您可以根据自身品牌的色彩和设计，自定义您的文档设计与布局。

以蓝色为主色调的深色方案有助于营造平静的感觉——这是大多数人在处理API时所需要的。这不仅是Twilio品牌的一部分，也传达出一种庄重和重要性，而这正是通信基础设施所期望的特质。

它的设计高效且独具特色。Twilio的视觉品牌形象具有很高的辨识度。

代码交互性是设计中的一个重要元素，因为Twilio开发人员可以从内部知识库到任何面向客户的软件中直接使用API进行实验。他们可以立即开始运行并轻松测试他们的软件。

品牌声调

与其视觉品牌不同，Twilio在其知识库中将其个人品牌的语气和声调保持在最低限度。

其在线知识库中包含的信息非常技术性，因此，它没有在Twilio品牌之间展现出任何个性。

对于高度技术性的文档来说，这是典型的，Twilio的品牌声调是中性的、直截了当的。在开发文档中没有文案发挥的余地。

直接性在技术文档中非常重要。你不希望公司的议程妨碍开发人员开始使用或排查你的技术问题。

信息架构/导航

一旦你从主页进入文档，导航就是另一回事了。你不是被一系列产品淹没，而是被引导在不同的文档类型之间穿梭。

Twilio在其顶部知识库导航中将其文档分为五个类别，这些类别与主站点的页脚相对应：

• 快速入门
• 教程

💛🧡🧡客户评价：对于新用户来说，Baklib 可能有点难学，但这是值得投入时间的，他们提供大量培训机会和资源。他们的公共知识库对用户也非常有用，而且在我们审查 Baklib 与其他提供商时，它让我们很好地了解了该工具的实际功能。

• 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 来说却至关重要。

在其专注于 API 文档的博客 Docs by Design 上，学术和技术作家 Bob Watson 谈到了优秀文档的重要性。Bob 谈到了将文档视为一个拥有独特客户群的产品。

Twilio Quest 是他们自己设计的游戏，旨在引导潜在客户进入 Twilio 平台。这是将其文档游戏化的一种独特而有趣的方式。

Twilio 还有资源专门用于举办自己以客户/开发者为中心的会议，称为 Signal：

这表明他们通过培育社区，对其客户和用户群投入了多少。

还在寻找一流的文档门户？Baklib可能是正确的选择。

错误信息也是文档的重要组成部分，但通常不会将其包含在知识库中。Twilio则有所不同。

Twilio在其文档中包含了来自其API的常见错误信息字符串，以帮助用户理解平台出了什么问题。

例如：

Twilio发布了一个完整的错误和警告目录，包括引发错误的可能原因——甚至更好的是——可能的解决方案。这有助于他们保持实际错误信息的简洁，同时为需要的人提供更多信息。

用户体验

卓越用户体验的第一原则被定义为：

"一个卓越用户体验的首要要求是满足客户的确切需求，无需繁琐或困扰。" (Nielsen Norman Group)

总体而言，Twilio的用户体验非常出色。NN集团进一步指出，必须融合多个学科才能创造出这种类型的用户体验，包括市场营销、工程和设计。这正是Twilio所做的。

Twilio没有将其文档视为属于某个团队的孤岛，而是组织了整个公司的力量来支持文档。这为其带来了卓越的用户体验回报。

在这种情况下，客户的需求首先是理解 Twilio 平台，其次是（但更重要的是）成功入驻 Twilio。

将这些最佳实践应用到您的知识库中，确保您的文档对客户而言始终保持新鲜和清晰。

遵循 Twilio 的榜样，为您的特定受众使用最佳知识库格式。

即使您不发布 API 文档，您仍然可以定制您的知识库以取悦您的用户。

以下是我们从 Twilio 文档中学到的顶级技巧总结：

• 敢于与众不同 – 考虑开发一个游戏来引导您的客户入驻，或者使您的代码示例具有互动性
• 迎合您的用户 – 如果您的受众不是支付费用的人，那也没关系
• 保持您的写作风格直接且切中要害 – 不要用文案技巧惹恼您的开发者用户
• 揭示您的导航 – 让您的用户更好地了解文档中的整体信息架构