將您的API文檔網站變成搖錢樹

作者:冪簡科技 · 2024-04-29 · 閱讀時間:10分鐘

在進入另一個忙碌的新年之前,許多科技組織借此機會審查他們的數字資產和知識產品。評估 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