Pourquoi la documentation API est l'or du marketing de contenu

Publié: 2022-01-20

Celui-ci s'adresse à tous mes spécialistes du marketing B2B SaaS qui ont le luxe d'essayer de vendre aux ingénieurs et aux développeurs.

Ce n'est pas un travail facile. Ce n'est pas aussi simple que de publier une annonce intelligente ou d'organiser un webinaire intéressant. Ce n'est pas aussi simple que de produire un ebook et de publier quelques messages sur LinkedIn.

C'est un peu plus compliqué… Mais cela ne doit pas sembler impossible.

De nombreux produits SaaS ont commencé à créer des écosystèmes de développeurs et des API pour offrir des données et inspirer des solutions personnalisées qui génèrent des revenus et une croissance supplémentaires pour l'entreprise.

Lorsque vous regardez le succès de l'écosystème AppExchange de Salesforce et du florissant écosystème de développeurs Shopify, il est très évident que cette approche peut offrir des revenus incroyables à la fois aux partenaires et à la marque. En 2021, les partenaires développeurs de Shopify ont gagné plus de 230 millions de dollars et une étude IDC (International Data Corporation) prédit que Salesforce contribuera 1,2 billion de dollars aux économies locales du monde entier. Pas mal hein ? Regardez cette croissance de Shopify…

Les partenaires actifs de l'écosystème référant de nouveaux marchands à Shopify se sont accélérés au fil des ans

Cela n'arrive pas par accident.

Cela se produit en investissant dans votre communauté et en investissant dans du contenu qui les soutiendra.

La chaîne YouTube ShopifyDevs est un exemple clair de ce à quoi ressemble un investissement dans votre communauté. La chaîne est remplie de vidéos amusantes, attrayantes et magnifiquement conçues qui parlent de tout, des étapes tactiques pour tirer parti de l'API aux vidéos stratégiques de haut niveau.

La quantité de contenu téléchargé sur cette chaîne et la qualité des modifications démontrent qu'il ne s'agit pas d'un petit investissement de Shopify. C'est quelque chose qu'ils prennent au sérieux et la communauté a réagi en regardant et en s'abonnant massivement.

La chaîne YouTube ShopifyDevs compte 31 000 abonnés et plus de 1,8 million de vues

Si vous êtes dans cet espace, je n'ai pas à vous parler des opportunités qui existent dans la création de solutions pour les ingénieurs. C'est une stratégie puissante et les chiffres que Shopify et Salesforce font dans leur écosystème en sont d'excellents exemples.

En tant que spécialistes du marketing, nous oublions souvent qu'il s'agit d'un domaine dans lequel nous devrions également jouer.

Nous ne devrions pas simplement laisser à nos équipes produit le soin de développer la documentation de l'API. Nous ne devrions pas simplement laisser au CTO le soin de trouver le temps de créer un excellent ensemble de documentation.

Nous devrions réfléchir à la manière dont nous pouvons aider notre propre équipe d'ingénieurs à créer une documentation et un contenu qui ajouteront réellement de la valeur à la vie de nos clients.

L'une des meilleures façons d'y parvenir est d'adopter et d'investir dans une excellente documentation.

Une excellente documentation API est massivement sous-estimée en tant que stratégie de marketing de contenu dans le SaaS B2B.

Une excellente documentation peut :

  • Générez des liens approfondis avec l'autorité de domaine
  • Établissez la confiance avec vos clients
  • Fidélisez vos clients sur le long terme
  • Aide à élever le produit
  • Inspirez la couverture médiatique
  • Gagnez des backlinks de qualité

Et bien plus encore… Voici un aperçu de certains des hubs de documentation les plus populaires et des avantages du marketing de contenu qu'ils offrent à leurs marques :

Tableau des pôles documentaires et

Mais vous devez savoir ce que vous faites. Voici six techniques simples à garder à l'esprit lors de la création de votre documentation SaaS. J'espère que vous pourrez l'utiliser pour vous assurer que la documentation que vous créez est non seulement utilisée, mais également trouvée par le biais de la recherche et de la boîte de réception de vos clients lorsque quelqu'un leur envoie un e-mail en disant "vérifiez ceci".

Allons-y…

Gardez votre documentation propre

Vous n'avez pas besoin de réinventer la roue ici.

Des entreprises comme Shopify, Stripe, WorkOS et Gitlab nous ont montré à quoi ressemble une excellente documentation. Le format n'a pas besoin d'être trop compliqué.

Rester simple.

exemples d'excellente documentation qui embrasse la simplicité (Shopify, Stripe, WorkOS, GitLab)

Placez la navigation à gauche et mettez le contenu/code à droite. Le côté supérieur droit offre aux utilisateurs la possibilité de se connecter, de s'inscrire ou de trouver des informations sur les nouveautés de la documentation. Assurez-vous qu'une barre de recherche est disponible dès que les gens arrivent sur vos documents API et si vous avez le budget pour rendre les choses plus interactives, intégrez une vidéo d'introduction sur votre page d'accueil.

Facilitez la navigation

Mon plus grand conseil pour les spécialistes du marketing qui essaient de créer une section de documentation sur leur site serait de traiter la page d'accueil de la documentation comme une page de destination. L'objectif de la page d'accueil de votre centre de documentation est de (i) les diriger vers le chemin ou le résultat le plus courant et (ii) les éduquer sur ce qu'ils trouveront dans la documentation d'une entreprise.

Trouveront-ils des guides de démarrage rapide ? Trouveront-ils des définitions ? Y a-t-il un endroit où ils peuvent aller pour plus d'assistance 1-1 ? Essayez de répondre à toutes ces questions sur la page d'accueil en créant une expérience intuitive et facile à suivre. Rappelles toi:

Ce n'est pas là que vous gagnez votre voyage à Cannes.

C'est là que vous gagnez votre promotion.

Une autre approche intéressante que j'ai vue mise en œuvre par les gens de WorkOS était la possibilité de naviguer par cas d'utilisation. Stripe le fait bien en ayant une page Docs avant une page API. Vous pouvez choisir si vous recherchez des documents sur les opérations commerciales ou des documents sur les services financiers…

L'API de Stripe est navigable par cas d'utilisation : opérations commerciales ou services financiers

Un autre produit qui le fait très bien est Twilio :

L'API de Twilio est navigable par six cas d'utilisation différents

Si vous disposez d'un ensemble de produits robuste, facilitez la navigation de vos utilisateurs vers la documentation par cas d'utilisation. Utilisez les analyses et les données produit pour éclairer la hiérarchisation de la documentation et montrer que vous comprenez les points faibles de vos clients.

Structurez vos URL avec excellence

Vous voulez voir la magie numérique ? Visitez la documentation de Stripe, regardez l'URL et faites défiler…

GIF montrant que l'URL de l'API de Stripe change lorsque vous faites défiler la page

Au fur et à mesure que vous faites défiler l'URL, l'URL passe de docs/ api à /api/authentication à /api/metadata et ainsi à toutes les autres extensions dont ils disposent. C'est une chose de beauté. Pourquoi?

Parce que chacune de ces URL peut être liée et conduit les gens vers cette section spécifique. C'est l'expérience utilisateur idéale (défilement infini) tout en offrant à Stripe la possibilité d'indexer ces sections individuelles dans Google via leur domaine. C'est la chose dont les rêves d'un référenceur sont faits…

Non seulement vous pouvez consommer le contenu sans accéder à une nouvelle page, mais vous pouvez également partager des sections spécifiques à l'aide de l'URL. Aujourd'hui, Stripe compte plus de 45 000 domaines référents liés à leur documentation. La stratégie consistant à faire de chaque section clé une URL pouvant être liée est un excellent moyen de s'assurer que les rédacteurs, les ingénieurs et les développeurs s'y connectent le cas échéant.

N'essayez pas de "commercialiser" votre documentation

Le marketing entretient une relation amour-haine avec la documentation.

Principalement parce que les spécialistes du marketing ADORENT essayer de trouver des moyens de pimenter les choses et d'ajouter leur « essence de marque » à tout. Ce n'est pas nécessaire avec la documentation. Coupez les peluches et n'essayez pas de vendre votre produit ou diverses fonctionnalités. Tenez-vous en à ce que les gens veulent : code et direction.

Ne laissez pas les gens "assumer leurs erreurs"

C'est un conseil assez tactique, mais les développeurs veulent savoir POURQUOI les choses ne fonctionnent pas.

Créez une documentation qui montre POURQUOI il y a des erreurs dans votre produit et lorsque vous essayez de construire sur votre plate-forme. C'est l'une des choses les plus fréquemment recherchées en matière de documentation technique, mais je l'ai vue laissée de côté dans de nombreuses documentations d'API. Faites une liste des erreurs que les gens peuvent rencontrer et un lien vers la documentation expliquant comment ces erreurs peuvent être évitées.

Mon dernier conseil pour créer une excellente documentation est le suivant…

Écrire pour les humains d'abord, les bots ensuite

C'est peut-être la partie la plus importante de la documentation.

Vous devez donner la priorité à l'expérience du développeur en matière de documentation avant même de commencer à réfléchir à la façon dont Google affichera votre contenu. L'indexabilité, la structure des URL et les titres que vous utilisez pour votre documentation sont-ils importants ? Sans aucun doute.

Mais la capacité de capturer le volume de recherche est la cerise sur le gâteau APRÈS avoir résolu de vrais problèmes et apporté de la clarté dans vos documents. Créez d'abord pour les gens. Optimiser ensuite.

J'espère que vous avez passé une semaine incroyable et que vous avez trouvé cela utile. Je suis convaincu que la documentation est l'un des éléments les plus importants et sous-estimés du mix marketing pour les entreprises axées sur les ingénieurs/développeurs. Si vous travaillez dans ces espaces et que vous souhaitez obtenir de l'aide pour créer du contenu qui aidera votre communauté d'ingénieurs à vous aimer, contactez-nous !

Je suis toujours partant pour discuter de la façon dont le contenu peut être utilisé pour façonner la culture.