为什么 API 文档是内容营销的黄金

这个适用于我所有的 B2B SaaS 营销人员，他们有幸尝试向工程师和开发人员推销产品。

这不是一件容易的工作。 这不像发布一个聪明的广告或举办一个有趣的网络研讨会那么简单。 这不像制作一本电子书并在 LinkedIn 上发布一些帖子那么简单。

这有点复杂......但它不必感觉不可能。

许多 SaaS 产品已开始创建开发人员生态系统和 API，以提供数据并激发定制解决方案，从而为业务带来额外收入和增长。

当您看到 Salesforce 的 AppExchange 生态系统和蓬勃发展的 Shopify 开发者生态系统的成功时，很明显这种方法可以为合作伙伴和品牌双方带来惊人的收入。 2021 年，Shopify 的开发者合作伙伴收入超过 2.3 亿美元，IDC（国际数据公司）的一项研究预测，Salesforce 将为全球当地经济贡献 1.2 万亿美元。 还不错吧？ 看看 Shopify 的这种增长......

这不是偶然发生的。

它通过投资于您的社区并投资于支持他们的内容来实现。

ShopifyDevs YouTube 频道是您社区投资的一个明显例子。 该频道充满了有趣、引人入胜且设计精美的视频，这些视频讨论了从战术步骤到利用 API 到高级战略视频的所有内容。

该频道上传的内容数量和编辑质量表明，这对 Shopify 来说是一笔不小的投资。 这是他们正在认真对待的事情，社区已经通过大规模观看和订阅来回应。

如果您在这个领域，我不必与您谈论为工程师创建解决方案的机会。 这是一个强大的策略，Shopify 和 Salesforce 在其生态系统中所做的数据就是很好的例子。

作为营销人员，我们经常忽略一个事实，即这是我们也应该参与的领域。

我们不应该只让我们的产品团队出去开发 API 文档。 我们不应该只让 CTO 抽出时间来创建一组出色的文档。

我们应该考虑如何支持我们自己的工程团队创建文档和内容，从而真正为客户的生活增加价值。

做到这一点的最佳方法之一是接受并投资于优秀的文档。

作为 B2B SaaS 中的内容营销策略，优秀的 API 文档被严重低估了。

优秀的文档可以：

• 驱动域权限彻底链接
• 与您的客户建立信任
• 长期留住您的客户
• 帮助提升产品
• 激发媒体报道
• 获得高质量的反向链接

还有更多……以下是一些最受欢迎的文档中心的快照，以及它们为品牌提供的内容营销优势：

但是你必须知道你在做什么。 在创建 SaaS 文档时，请牢记以下六种简单技术。 我希望您可以使用它来确保您创建的文档不仅被使用，而且当有人通过电子邮件将其发送给他们说“检查一下”时，还可以通过搜索和您客户的收件箱找到。

让我们开始吧……

保持文档清洁

你不需要在这里重新发明轮子。

Shopify、Stripe、WorkOS 和 Gitlab 等公司向我们展示了出色的文档是什么样的。 格式不需要过于复杂。

把事情简单化。

将导航放在左侧，将内容/代码放在右侧。 右上角为人们提供登录、注册或查找有关文档中新内容的信息的能力。 确保在人们登陆您的 API 文档时有一个可用的搜索栏，并且如果您有预算让事情更具交互性 - 在您的主页上加入一个介绍视频。

轻松导航

对于试图在其网站上建立文档部分的营销人员，我最大的建议是将文档主页视为登录页面。 您的文档中心首页的目标是 (i) 将他们引导到最常见的路径或结果，以及 (ii) 让他们了解他们将在公司文档中找到的内容。

他们会找到快速入门指南吗？ 他们会找到定义吗？ 有什么地方可以让他们获得更多的 1-1 支持吗？ 尝试通过创建直观且易于理解的体验来回答主页中的所有这些问题。 记住：

这不是您赢得戛纳之旅的地方。

这是您赢得晋升的地方。

我看到 WorkOS 的人们实现的另一个有趣的方法是按用例导航的能力。 Stripe 通过在 API 页面之前有一个 Docs 页面来很好地做到这一点。 您可以选择是要查找业务运营文档还是金融服务文档……

另一个做得很好的产品是 Twilio：

如果您拥有一组强大的产品，那么您的用户可以轻松地按用例导航到文档。 使用分析和产品数据来确定文档的优先级，并表明您了解客户的痛点。

以卓越的方式构建您的 URL

想看数字魔术吗？ 访问 Stripe 的文档，查看 URL 并滚动...

当您滚动 URL 时，从 docs/ api到 /api/authentication 到 /api/metadata 以及它们拥有的所有其他扩展名都会发生变化。 这是一件美丽的事情。 为什么？

因为这些 URL 中的每一个都是可链接的，并将人们带到这个特定的部分。 这是理想的用户体验（无限滚动），同时仍然为 Stripe 提供了通过其域在 Google 中对这些单独部分进行索引的能力。 这是 SEO 梦寐以求的东西……

您不仅可以在不进入新页面的情况下使用内容 – 您还可以使用 URL 共享特定部分。 如今，Stripe 拥有超过 45,000 个链接到其文档的引用域。 使每个关键部分成为可链接 URL 的策略是确保作家、工程师和开发人员在适当时链接到它的好方法。

不要试图在您的文档中“推销”

营销与文档有着爱恨交织的关系。

主要是因为营销人员喜欢想方设法为事物增添趣味，并将他们的“品牌精髓”添加到所有事物中。 文档没有必要。 剪掉绒毛，不要试图推销你的产品或各种功能。 坚持人们想要的：代码和方向。

不要让人们“假设他们的错误”

这是一个相当战术性的建议，但开发人员想找出为什么事情不起作用。

创建文档来展示为什么您的产品会出现错误以及尝试在您的平台上构建时出现错误。 当涉及到技术文档时，它是最常搜索的内容之一，但我已经看到它被许多 API 文档遗漏了。 列出人们可能遇到的错误，并链接到有关如何防止这些错误的文档。

关于创建出色的文档，我的最后一条建议是……

首先为人类写作，其次为机器人写作

这可能是文档中最重要的部分。

在开始考虑 Google 将如何查看您的内容之前，您需要在文档方面优先考虑开发人员体验。 您用于文档的可索引性、URL 结构和标题重要吗？ 毫无疑问。

但是，在您解决实际问题并在文档中提供清晰性之后，捕获搜索量的能力是锦上添花。 首先为人创造。 优化二。

希望你有一个美好的一周，并发现这很有帮助。 我坚信，对于以工程师/开发人员为中心的公司来说，文档是营销组合中最重要和被低估的元素之一。 如果您在这些领域工作并希望在创建有助于您的工程社区爱您的内容方面获得支持，请联系我们！

我总是闲聊如何使用内容来塑造文化。