APIドキュメントがコンテンツマーケティングのゴールドである理由

公開: 2022-01-20

これは、エンジニアや開発者に売り込もうとする贅沢を持っている私のB2BSaaSマーケター全員に当てはまります。

それは簡単な仕事ではありません。 巧妙な広告を出したり、興味深いウェビナーを開催したりするほど簡単ではありません。 電子書籍を作成してLinkedInに投稿するほど簡単ではありません。

もう少し複雑です…でも、不可能だと感じる必要はありません。

多くのSaaS製品は、データを提供し、ビジネスの追加の収益と成長を促進するカスタムソリューションを刺激するために、開発者のエコシステムとAPIを作成し始めています。

SalesforceのAppExchangeエコシステムと繁栄しているShopify開発者エコシステムの成功を見ると、このアプローチがパートナーとブランドの両方に驚くべき収益をもたらすことができることは非常に明白です。 2021年、Shopifyの開発者パートナーは2億3000万ドル以上を稼ぎ、IDC(International Data Corporation)の調査では、Salesforceが世界中の地域経済に1.2兆ドルを貢献すると予測しています。 悪くないね? Shopifyからのこの成長を見てください…

新しいマーチャントをShopifyに紹介するアクティブなエコシステムパートナーは、何年にもわたって加速しています

これは偶然ではありません。

それはあなたのコミュニティに投資し、彼らをサポートするコンテンツに投資することによって起こります。

ShopifyDevs YouTubeチャンネルは、コミュニティへの投資がどのように見えるかを示す明確な例です。 このチャンネルは、APIを活用するための戦術的な手順から、高レベルの戦略的な動画まで、すべてを語る、楽しく魅力的で美しくデザインされた動画でいっぱいです。

このチャンネルにアップロードされたコンテンツの量と編集の質は、これがShopifyによる少額の投資ではないことを示しています。 それは彼らが真剣に受け止めていることであり、コミュニティは大規模な方法で見たり購読したりすることで対応してきました。

ShopifyDevs YouTubeチャンネルのチャンネル登録者数は31,000人、再生回数は180万回を超えています

あなたがこの分野にいるのなら、エンジニア向けのソリューションを作成する際に存在する機会について話す必要はありません。 これは強力な戦略であり、ShopifyとSalesforceがエコシステムで行っている数字はその良い例です。

マーケターとして、私たちはこれが私たちもプレイすべき分野であるという事実を見落としがちです。

APIドキュメントを作成するのは、製品チームだけに任せるべきではありません。 優れたドキュメントセットを作成する時間を見つけるために、CTOに任せるべきではありません。

お客様の生活に実際に付加価値をもたらすドキュメントやコンテンツを作成するために、自社のエンジニアリングチームをどのようにサポートできるかを検討する必要があります。

そのための最良の方法の1つは、優れたドキュメントを採用して投資することです。

優れたAPIドキュメントは、B2BSaaSのコンテンツマーケティング戦略として大幅に過小評価されています。

優れたドキュメントは次のことができます。

  • リンクを介してドメイン権限を駆動する
  • 顧客との信頼を確立する
  • 顧客を長期的に維持する
  • 製品の向上に役立ちます
  • メディア報道を刺激する
  • 質の高い被リンクを獲得する

そしてもっとたくさん…これは彼らが彼らのブランドを提供している最も人気のあるドキュメンテーションハブとコンテンツマーケティングの利点のいくつかのスナップショットです:

ドキュメントハブの表と

しかし、あなたは自分が何をしているのかを知る必要があります。 SaaSドキュメントを作成するときに覚えておくべき6つの簡単なテクニックを次に示します。 これを使用して、作成しているドキュメントが使用されるだけでなく、誰かが「これをチェックしてください」とメールで送信したときに、検索や顧客の受信トレイからも確実に使用できるようになることを願っています。

さあ、始めましょう…

ドキュメントをクリーンに保つ

ここで車輪の再発明をする必要はありません。

Shopify、Stripe、WorkOS、Gitlabなどの企業は、優れたドキュメントがどのように見えるかを示しています。 フォーマットは過度に複雑である必要はありません。

複雑にしないでおく。

シンプルさを取り入れた優れたドキュメントの例(Shopify、Stripe、WorkOS、GitLab)

ナビゲーションを左側に配置し、コンテンツ/コードを右側に配置します。 右上には、ログイン、サインアップ、またはドキュメントの新機能に関する情報を見つける機能があります。 人々がAPIドキュメントにアクセスしたらすぐに検索バーを利用できるようにし、物事をよりインタラクティブにする予算がある場合は、ホームページに紹介ビデオを組み込んでください。

ナビゲートしやすくする

サイトのドキュメントセクションを作成しようとしているマーケターへの私の最大のアドバイスは、ドキュメントのホームページをランディングページのように扱うことです。 ドキュメントハブのフロントページの目標は、(i)最も一般的なパスまたは結果に誘導し、(ii)会社のドキュメントで何が見つかるかを教育することです。

彼らはクイックスタートガイドを見つけますか? 彼らは定義を見つけますか? 彼らがもっと1-1のサポートを求めることができる場所はありますか? 直感的でわかりやすいエクスペリエンスを作成することにより、ホームページでこれらすべての質問に答えるようにしてください。 覚えて:

これはあなたがカンヌへの旅行に勝つ場所ではありません。

これはあなたがあなたの昇進に勝つところです。

WorkOSの人々によって実装されているのを見たもう1つの興味深いアプローチは、ユースケースごとにナビゲートする機能でした。 Stripeは、APIページの前にドキュメントページを配置することでこれをうまく実現します。 BusinessOpsDocsまたはFinancialServicesDocsのどちらを探しているかを選択できます…

StripeのAPIは、ビジネスオペレーションまたは金融サービスのユースケースでナビゲートできます

これを本当にうまく行うもう1つの製品はTwilioです。

TwilioのAPIは、6つの異なるユースケースでナビゲートできます

堅牢な製品セットがある場合は、ユーザーがユースケースごとにドキュメントに簡単に移動できるようにします。 分析と製品データを使用して、ドキュメントの優先順位を通知し、顧客の問題点を理解していることを示します。

優れたURLを構築する

デジタルマジックを見たいですか? Stripeのドキュメントにアクセスし、URLを確認して、スクロールしてください…

ページを下にスクロールすると、StripeのAPIURLが変化することを示すGIF

スクロールすると、URLがdocs/ apiから/api/ authentication、/ api / metadataに変わり、他のすべての拡張子が変わります。 それは美しいものです。 なんで?

これらの各URLはリンク可能であり、人々をこの特定のセクションに誘導するためです。 これは理想的なユーザーエクスペリエンス(無限スクロール)でありながら、Stripeにドメインを介してGoogleのこれらの個々のセクションにインデックスを付ける機能を提供します。 それはSEOの夢が作られているものです…

新しいページに移動せずにコンテンツを利用できるだけでなく、URLを使用して特定のセクションを共有できます。 現在、Stripeには、ドキュメントにリンクしている45,000を超える参照ドメインがあります。 各主要セクションをリンク可能なURLにする戦略は、ライター、エンジニア、および開発者が適切なときにそれにリンクすることを保証するための優れた方法です。

ドキュメントで「市場」にしようとしないでください

マーケティングはドキュメンテーションと愛憎関係にあります。

主な理由は、マーケターが物事を盛り上げ、すべてに「ブランドエッセンス」を追加する方法を見つけようとするのが大好きだからです。 ドキュメントでは必要ありません。 綿毛を切り取り、製品やさまざまな機能を販売しようとしないでください。 人々が望むものに固執する:コードと方向性。

人々に「彼らの誤りを想定させないでください」

これはかなり戦術的なアドバイスですが、開発者は物事がうまくいかない理由を知りたいと思っています。

製品にエラーがある理由と、プラットフォームでビルドしようとしたときを示すドキュメントを作成します。 これは、技術ドキュメントに関して最も頻繁に検索されるものの1つですが、多くのAPIドキュメントから除外されているのを見てきました。 人々が遭遇する可能性のあるエラーのリストを作成し、これらのエラーを防止する方法に関するドキュメントにリンクします。

優れたドキュメントを作成する際の最後のアドバイスはこれです…

最初に人間のために書き、次にボット

これは、ドキュメントの最も重要な部分である可能性があります。

Googleがコンテンツをどのように表示するかを考える前に、ドキュメントに関しては開発者のエクスペリエンスを優先する必要があります。 ドキュメントに使用する索引付け可能性、URL構造、および見出しは重要ですか? 間違いない。

しかし、検索ボリュームをキャプチャする機能は、実際の問題を解決し、ドキュメントを明確にした後のアイシングです。 最初に人々のために作成します。 2番目に最適化します。

素晴らしい1週間を過ごし、これがお役に立てば幸いです。 ドキュメントは、エンジニア/開発者に焦点を当てた企業のマーケティングミックスの中で最も重要で過小評価されている要素の1つであると私は確信しています。 これらの分野で働いていて、エンジニアリングコミュニティがあなたを愛するのに役立つコンテンツの作成をサポートしたい場合は、連絡してください。

私は常に、コンテンツを使用して文化を形成する方法について話し合っています。