API知识库 > 理念洞察 > 将您的API文档网站变成摇钱树
将您的API文档网站变成摇钱树

将您的API文档网站变成摇钱树

在进入另一个忙碌的新年之前,许多科技组织借此机会审查他们的数字资产和知识产品。评估 API 文档对于确保其保持相关性和时效性尤为重要。

但是你知道吗,保持API文档的良好状态也可以帮助您赚取更多收入。您可以通过鼓励潜在用户投资您的API并鼓励现有客户更深入地研究您的API提供的功能,让您的文档为您服务。

本博文概述了您应该通过API文档获利的目标用户。它还探讨了潜在用户和现有用户进一步使用这一宝贵资产所需的不同方法,从而为增加收入铺平道路。

谁是您的付费客户?

任何提高 API 货币化的尝试都需要首先明确谁将为服务付费。有时,高管负责采购决策。然而,大多数时候,技术团队有权自行做出采购决策,或者至少能够向公司高管或产品团队推荐购买什么。

您可能已经拥有吸引产品团队的营销材料,但是您有资源来吸引技术决策者吗?当开发人员评估 API 时,他们会尝试弄清楚开发人员体验是好还是坏,还是介于两者之间。对开发人员体验的调查涉及提出关键问题,例如:

  • API 是否有简单的自助注册流程和免费试用?
  • 提供商的网站或 Stack Overflow 或 GitHub 等外部网站上是否有社区支持?
  • 询问有关 API 的技术问题并获得有用的答案有多容易?
  • API 文档的清晰程度和全面程度如何?
  • API 文档是否易于浏览并且资源之间有清晰的索引和链接?
  • 是否支持我使用的语言和框架(例如 SDK、代码示例和“入门”指南)?

您通常不会看到营销材料解决此类问题!开发者体验只是技术决策者在评估 API 时考虑的因素之一。他们还需要确保 API 满足他们的项目要求并且相对容易实现。

易于使用的 API 对于有购买力的技术团队成员来说是一个巨大的卖点,这就是为什么 API 文档可以推动购买决策。

良好的文档将新用户连接到您的 API 产品

首先,API 文档不是营销材料。开发人员通常讨厌公然的营销宣传,并且不信任“简单”和“即时”等词语。当开发人员认为您的 API 文档只不过是营销内容时,他们可能会寻找提供实质性文档的竞争对手。

开发人员可以快速浏览推荐和案例研究,直接了解 API 的工作原理。为了找到答案,他们会首先阅读文档。如果不了解表明该产品是否适合他们的技术细节,任何开发人员或开发团队都不会开始在 API 上花钱。

也就是说,您仍然可以应用大量标准营销原则,从面向外部的 API 文档中获得最大的盈利潜力。

始终如一

开发人员非常重视一致性,尤其是 API 及其文档方面的一致性。使用AI确保文档一致,自动生成API文档并提供修复现有文档漏洞的建议。 

考虑使用目录结构创建可重用的模块化文档,以便 API 团队可以将图像、代码示例和过程等项目保存在一个位置。然后,团队可以将这些项目直接链接到文档 Markdown 文件,使它们易于查找、更新和重用。如果开发人员始终在您的文档中找到他们需要的内容,他们将在您的 API 上取得更大的成功。

使文档易于访问

使用您的 API 产品的开发人员数量越多,您从中赚取收入的机会就越多。您的潜在用户应该能够访问并快速掌握您的外部 API 文档。

首先确保 API 文档不含行话,并包含图表、概念解释和术语表等资源,以便用户更好地理解 API。

此外,一些潜在的 API 用户可能有残疾,因此请使用可访问的组件(例如屏幕阅读器的标签和替代文本)创建文档。如果您的 API 文档遵循ADA可访问性要求,这些用户将遇到更少的访问障碍。

超越用户期望

提供简单的文档可能对内部 API 用户来说效果很好,但外部 API 用户需要更多才能上瘾!确保您的文档全面,具有高级功能,例如:

  • 用例:使用这些用例来解释 API 在不同行业或环境中可以做什么。
  • 沙箱:为开发人员提供一个 API 沙箱,以便他们可以测试 API。
  • 特定语言的代码示例:提供代码示例以帮助 开发人员快速上手和运行。
  • SDK:在开始使用 API 时,身份验证往往会给开发人员带来挑战。提供有助于简化身份验证的 SDK
  • 交互式文档:让潜在用户无需离开浏览器即可了解 API 的功能。

通过为开发人员提供远超基本文档的内容,让他们感到受欢迎。当您的文档超出预期时,消息就会传开。

了解您的客户

开发人员需要的不仅仅是“我们迫不及待地想看看您构建的内容!”信息。通过提供量身定制的指导并通过与其特定业务垂直领域或技术堆栈相关的文档来激励他们,从而做得更好。

提供指南来帮助您了解开发人员的需求,并提供教程来帮助他们解决问题。同样,文档的内容应该向潜在客户表明您了解他们的需求并且您的 API 可以满足他们。您的 API 文档应该面向开发人员和技术产品团队,而不是销售或财务团队。

现在您已经了解了一些可以应用于文档的营销原则,那么您应该警惕哪些营销策略呢?

  • 关注功能,而不是销售结果:开发人员通常对“将销售收入增加 20%”或“将 CI/CD 发布周期缩短一半”等说法持怀疑态度。他们更有可能被代码示例和技术演示等有形的方面所说服。
  • 鼓励开发人员做出自己的决定:开发人员在与您的技术支持或销售团队交谈之前,会尝试自行了解您的 API 产品是否适合他们。因此,提供吸引黑客思维的自助文档,使他们能够轻松独立地解决问题。
  • 避免激进的 CTA:最好的文档可以让开发人员看到正在运行的代码,使他们能够轻松构建免费的演示应用程序或简单的集成。如果你用过度的销售技巧来推销潜在客户,他们可能会犹豫并离开。

通过将这些营销原则应用到您的文档中,新 API 用户的增长很快就会随之而来。但是,鼓励现有用户使用您的 API 做更多事情可以更大幅度地提高您的利润。

高级文档激发开发人员更深入地研究

寻找新客户的成本远高于留住现有客户的成本。鼓励后者增加支出也更具有经济意义。为此,您的文档在开发人员最初与您的 API 集成后是否为他们提供支持? 

像“入门”指南这样的资源对于新的 API 使用者来说是无价的,但对于已经使用它的人来说却不是。因此,请考虑如何扩展您的文档,以鼓励那些已经使用您的 API 的人进行更多投资。

询问现有客户的想法

提高 API 收入的一种方法是询问现有客户的反馈。他们对您的 API 有何看法?他们还希望在您的 API 文档中看到什么(其他)内容?投资客户关系是了解用户群重视什么以及愿意支付更多费用的好方法。

与客户进行清晰的沟通还有助于改善他们对您公司的体验,提高品牌忠诚度和用户增长。

解释技术价值和成本

你需要问自己,你希望已经使用你的 API 产品的开发者为什么付费?开发人员将为他们认为有价值的东西付费,其中可能包括:

  • 更高的 API 速率限制
  • 高级 API 功能
  • 专业数据
  • 自定义端点
  • 高级支持

解释每项服务或功能的技术价值,开发引导现有用户进行这些投资的文档。对成本保持诚实和透明。没有人喜欢受到意外费用的打击,因此不要因为意外费用而疏远现有用户。

向开发人员展示您的 API 的潜力

您不应该假设开发人员了解 API 的全部功能以及如何部署它。即使用户了解他们当前正在使用您的 API 做什么,这也可能只是其潜力的一小部分。 

将用例添加到您的文档中,为开发人员提供实用指南,展示如何从基本实现扩展到更复杂的实现。添加案例研究链接,以展示其他客户使用您的 API 进行操作的真实示例。向开发人员展示他们可以使用您的 API 实现什么并激励他们这样做。

如果您希望开发人员在您的 API 上投入大量资金,您必须向他们展示前进的道路,而您的文档就是地图!

彻底记录新的 API 功能

鼓励开发人员与 API 进行更深入集成的另一种方法是在文档中详细说明可用的新功能。您可以通过向文档中添加演示和 API 浏览器来实现此目的。 

示例应用程序向开发人员展示了新发布的功能如何工作以及如何快速启动和运行它们。始终确保开发人员通过各种通信方式(包括您的文档)了解您的API何时具有可用的新功能。

从您的 API 文档中获取更多价值

API 文档有可能为您的企业带来收入,无论是在引入新的 API 客户还是进一步吸引现有客户方面。当您对 API 文档进行小额但持续的投资时,您就创建了促进 API 货币化的新途径。 

原文链接:Turn Your Docs Site into a Moneymaker

#你可能也喜欢这些API文章!