Warum API-Dokumentation Gold für Content-Marketing ist

Dieses hier geht an alle meine B2B-SaaS-Vermarkter, die den Luxus haben, an Ingenieure und Entwickler zu verkaufen.

Es ist kein einfacher Job. Es ist nicht so einfach, eine clevere Anzeige zu schalten oder ein interessantes Webinar zu veranstalten. Es ist nicht so einfach, ein E-Book zu erstellen und ein paar Beiträge auf LinkedIn zu veröffentlichen.

Es ist etwas komplizierter … Aber es muss sich nicht unmöglich anfühlen.

Viele SaaS-Produkte haben damit begonnen, Entwickler-Ökosysteme und APIs zu erstellen, um Daten anzubieten und kundenspezifische Lösungen zu inspirieren, die zusätzliche Einnahmen und Wachstum für das Unternehmen fördern.

Wenn Sie sich den Erfolg des AppExchange-Ökosystems von Salesforce und des florierenden Shopify-Entwicklerökosystems ansehen, ist es sehr offensichtlich, dass dieser Ansatz sowohl für Partner als auch für die Marke erstaunliche Einnahmen bieten kann. Im Jahr 2021 verdienten die Entwicklungspartner von Shopify mehr als 230 Millionen US-Dollar, und eine IDC-Studie (International Data Corporation) prognostiziert, dass Salesforce 1,2 Billionen US-Dollar zur lokalen Wirtschaft auf der ganzen Welt beitragen wird. Nicht schlecht oder? Sehen Sie sich dieses Wachstum von Shopify an…

Das passiert nicht zufällig.

Dies geschieht, indem Sie in Ihre Community investieren und in Inhalte investieren, die sie unterstützen.

Der YouTube-Kanal von ShopifyDevs ist ein klares Beispiel dafür, wie eine Investition in Ihre Community aussieht. Der Kanal ist gefüllt mit lustigen, ansprechenden und wunderschön gestalteten Videos, die alles Mögliche behandeln, von taktischen Schritten zur Nutzung der API bis hin zu strategischen Videos auf hohem Niveau.

Die Menge der auf diesem Kanal hochgeladenen Inhalte und die Qualität der Bearbeitungen zeigen, dass dies keine geringe Investition von Shopify ist. Es ist etwas, das sie ernst nehmen, und die Community hat darauf reagiert, indem sie massiv zugesehen und abonniert hat.

Wenn Sie in diesem Bereich tätig sind, muss ich nicht mit Ihnen über die Möglichkeiten sprechen, die bei der Entwicklung von Lösungen für Ingenieure bestehen. Es ist eine starke Strategie und die Zahlen, die Shopify und Salesforce in ihrem Ökosystem machen, sind großartige Beispiele dafür.

Als Vermarkter übersehen wir oft die Tatsache, dass dies ein Bereich ist, in dem wir uns ebenfalls engagieren sollten.

Wir sollten es nicht einfach unseren Produktteams überlassen, loszugehen und API-Dokumentation zu entwickeln. Wir sollten es nicht einfach dem CTO überlassen, Zeit zu finden, um eine großartige Dokumentation zu erstellen.

Wir sollten darüber nachdenken, wie wir unser eigenes Engineering-Team dabei unterstützen können, Dokumentationen und Inhalte zu erstellen, die das Leben unserer Kunden tatsächlich bereichern.

Eine der besten Möglichkeiten, dies zu tun, besteht darin, großartige Dokumentationen anzunehmen und in sie zu investieren.

Großartige API-Dokumentation wird als Content-Marketing-Strategie im B2B-SaaS massiv unterschätzt.

Gute Dokumentation kann:

• Fördern Sie gründliche Links der Domain-Autorität
• Schaffen Sie Vertrauen bei Ihren Kunden
• Binden Sie Ihre Kunden langfristig
• Helfen Sie mit, das Produkt zu verbessern
• Inspirieren Sie die Medienberichterstattung
• Verdienen Sie hochwertige Backlinks

Und noch viel mehr … Hier ist eine Momentaufnahme einiger der beliebtesten Dokumentations-Hubs und der Content-Marketing-Vorteile, die sie ihren Marken bieten:

Aber man muss wissen, was man tut. Hier sind sechs einfache Techniken, die Sie beim Erstellen Ihrer SaaS-Dokumentation beachten sollten. Ich hoffe, dass Sie dies verwenden können, um sicherzustellen, dass die von Ihnen erstellte Dokumentation nicht nur verwendet, sondern auch über die Suche und den Posteingang Ihrer Kunden gefunden wird, wenn jemand sie per E-Mail mit der Aufschrift „Check this out“ sendet.

Lasst uns anfangen…

Halten Sie Ihre Dokumentation sauber

Hier müssen Sie das Rad nicht neu erfinden.

Unternehmen wie Shopify, Stripe, WorkOS und Gitlab haben uns gezeigt, wie eine großartige Dokumentation aussieht. Das Format muss nicht übermäßig kompliziert sein.

Halte es einfach.

Platzieren Sie die Navigation links und den Inhalt/Code rechts. Die obere rechte Seite bietet Benutzern die Möglichkeit, sich anzumelden, sich anzumelden oder sich über Neuigkeiten in den Dokumenten zu informieren. Stellen Sie sicher, dass eine Suchleiste verfügbar ist, sobald Leute auf Ihren API-Dokumenten landen, und wenn Sie das Budget haben, um die Dinge interaktiver zu gestalten – binden Sie ein Einführungsvideo auf Ihrer Homepage ein.

Erleichtern Sie die Navigation

Mein größter Ratschlag für Vermarkter, die versuchen, einen Dokumentationsbereich ihrer Website zu erstellen, wäre, die Dokumentations-Startseite wie eine Zielseite zu behandeln. Das Ziel für die Titelseite Ihres Dokumentationszentrums ist es, (i) sie auf den häufigsten Weg oder das häufigste Ergebnis zu lenken und (ii) sie darüber aufzuklären, was sie in der Dokumentation eines Unternehmens finden.

Werden sie Schnellstartanleitungen finden? Werden sie Definitionen finden? Gibt es einen Ort, an dem sie mehr 1-1-Unterstützung erhalten können? Versuchen Sie, all diese Fragen auf der Homepage zu beantworten, indem Sie eine Erfahrung schaffen, die intuitiv und leicht zu verfolgen ist. Denken Sie daran:

Hier gewinnen Sie Ihre Reise nach Cannes nicht.

Hier gewinnen Sie Ihre Beförderung.

Ein weiterer interessanter Ansatz, den ich von den Leuten bei WorkOS gesehen habe, war die Möglichkeit, nach Anwendungsfall zu navigieren. Stripe tut dies gut, indem es eine Docs-Seite vor einer API-Seite hat. Sie können auswählen, ob Sie nach Business Ops Docs oder Financial Services Docs suchen…

Ein weiteres Produkt, das dies wirklich gut macht, ist Twilio:

Wenn Sie über eine solide Produktpalette verfügen, erleichtern Sie Ihren Benutzern die Navigation zur Dokumentation nach Anwendungsfällen. Verwenden Sie Analyse- und Produktdaten, um die Priorisierung der Dokumentation zu informieren und zu zeigen, dass Sie die Schmerzpunkte Ihrer Kunden verstehen.

Strukturieren Sie Ihre URLs mit Exzellenz

Möchten Sie digitale Magie sehen? Besuchen Sie die Stripe-Dokumentation, sehen Sie sich die URL an und scrollen Sie…

Beim Scrollen ändert sich die URL von docs/ api zu /api/authentication zu /api/metadata und damit zu jeder anderen Erweiterung, die sie haben. Es ist eine Sache der Schönheit. Wieso den?

Weil jede dieser URLs verlinkbar ist und die Leute zu diesem bestimmten Abschnitt führt. Es ist die ideale Benutzererfahrung (unendliches Scrollen) und bietet Stripe dennoch die Möglichkeit, diese einzelnen Abschnitte in Google über ihre Domain zu indizieren. Es ist das, woraus die Träume eines SEOs gemacht sind…

Sie können den Inhalt nicht nur konsumieren, ohne auf eine neue Seite zu wechseln – Sie können bestimmte Abschnitte über die URL teilen. Heute hat Stripe mehr als 45.000 verweisende Domains, die auf seine Dokumentation verlinken. Die Strategie, jeden Schlüsselabschnitt zu einer verlinkbaren URL zu machen, ist eine großartige Möglichkeit, um sicherzustellen, dass Autoren, Ingenieure und Entwickler bei Bedarf darauf verlinken.

Versuchen Sie nicht, in Ihrer Dokumentation zu „vermarkten“.

Marketing hat eine Hassliebe zur Dokumentation.

Hauptsächlich, weil Vermarkter es LIEBEN, Wege zu finden, Dinge aufzupeppen und ihre „Markenessenz“ in alles einzufügen. Es ist nicht notwendig, mit Dokumentation. Lassen Sie den Flaum weg und versuchen Sie nicht, Ihr Produkt oder verschiedene Funktionen zu verkaufen. Halten Sie sich an das, was die Leute wollen: Code und Richtung.

Lassen Sie nicht zu, dass die Leute "ihre Fehler annehmen"

Dies ist ein ziemlich taktischer Ratschlag, aber Entwickler wollen herausfinden, WARUM Dinge nicht funktionieren.

Erstellen Sie eine Dokumentation, die zeigt, WARUM es Fehler in Ihrem Produkt gibt und wenn Sie versuchen, auf Ihrer Plattform aufzubauen. Es ist eines der am häufigsten gesuchten Dinge, wenn es um technische Dokumente geht, aber ich habe gesehen, dass es in vielen API-Dokumenten ausgelassen wurde. Erstellen Sie eine Liste der Fehler, die auftreten können, und verlinken Sie auf die Dokumentation, wie diese Fehler verhindert werden können.

Mein letzter Rat, wenn es darum geht, großartige Dokumentationen zu erstellen, lautet:

Schreiben Sie zuerst für Menschen, dann für Bots

Dies könnte der wichtigste Teil der Dokumentation sein.

Sie müssen die Entwicklererfahrung bei der Dokumentation priorisieren, bevor Sie überhaupt darüber nachdenken, wie Google Ihre Inhalte anzeigen wird. Sind Indexierbarkeit, URL-Struktur und Überschriften, die Sie für Ihre Dokumentation verwenden, wichtig? Ohne Zweifel.

Aber die Möglichkeit, das Suchvolumen zu erfassen, ist das i-Tüpfelchen, NACHDEM Sie echte Probleme gelöst und Klarheit in Ihren Dokumenten geschaffen haben. Erstellen Sie zuerst für Menschen. Zweitens optimieren.

Ich hoffe, Sie haben eine tolle Woche und fanden dies hilfreich. Ich bin davon überzeugt, dass die Dokumentation eines der wichtigsten und unterschätztesten Elemente des Marketing-Mix für ingenieur-/entwicklerorientierte Unternehmen ist. Wenn Sie in diesen Bereichen arbeiten und Unterstützung bei der Erstellung von Inhalten benötigen, die Ihrer Engineering-Community helfen, Sie zu lieben – kontaktieren Sie uns!

Ich bin immer bereit, darüber zu plaudern, wie Inhalte genutzt werden können, um Kultur zu formen.