Por qué la documentación API es el oro del marketing de contenidos

Publicado: 2022-01-20

Este va dirigido a todos mis vendedores de B2B SaaS que tienen el lujo de tratar de vender a ingenieros y desarrolladores.

No es un trabajo fácil. No es tan simple como publicar un anuncio inteligente o realizar un seminario web interesante. No es tan simple como producir un libro electrónico y publicar algunas publicaciones en LinkedIn.

Es un poco más complicado... Pero no tiene por qué parecer imposible.

Muchos productos SaaS han comenzado a crear ecosistemas de desarrolladores y API para ofrecer datos e inspirar soluciones personalizadas que generen ingresos adicionales y crecimiento para el negocio.

Cuando observa el éxito del ecosistema de AppExchange de Salesforce y el próspero ecosistema de desarrolladores de Shopify, es muy obvio que este enfoque puede ofrecer ingresos increíbles tanto para los socios como para la marca. En 2021, los socios desarrolladores de Shopify ganaron más de 230 millones de dólares y un estudio de IDC (International Data Corporation) predice que Salesforce contribuirá con 1,2 billones de dólares a las economías locales de todo el mundo. No está mal, ¿eh? Mira este crecimiento de Shopify...

Los socios activos del ecosistema que refieren a nuevos comerciantes a Shopify se han acelerado a lo largo de los años.

Esto no sucede por accidente.

Sucede invirtiendo en su comunidad e invirtiendo en contenido que los apoye.

El canal de YouTube de ShopifyDevs es un claro ejemplo de cómo es una inversión en tu comunidad. El canal está lleno de videos divertidos, atractivos y bellamente diseñados que hablan de todo, desde pasos tácticos para aprovechar la API hasta videos estratégicos de alto nivel.

La cantidad de contenido subido en este canal y la calidad de las ediciones demuestra que esta no es una pequeña inversión por parte de Shopify. Es algo que se están tomando en serio y la comunidad ha respondido observando y suscribiéndose de forma masiva.

El canal de YouTube de ShopifyDevs tiene 31 000 suscriptores y más de 1,8 millones de visitas

Si estás en este espacio, no tengo que hablarte sobre las oportunidades que existen en la creación de soluciones para ingenieros. Es una estrategia poderosa y los números que Shopify y Salesforce están haciendo en su ecosistema son excelentes ejemplos de ello.

Como especialistas en marketing, a menudo pasamos por alto el hecho de que esta es un área en la que también deberíamos estar jugando.

No deberíamos dejar que nuestros equipos de productos salgan y desarrollen la documentación de la API. No deberíamos dejar que el CTO encuentre tiempo para crear un gran conjunto de documentación.

Deberíamos pensar en cómo podemos apoyar a nuestro propio equipo de ingeniería para crear documentación y contenido que realmente agregue valor a la vida de nuestros clientes.

Una de las mejores maneras de hacerlo es adoptando e invirtiendo en una excelente documentación.

La excelente documentación de API se subestima enormemente como una estrategia de marketing de contenido en B2B SaaS.

Una gran documentación puede:

  • Impulse los enlaces exhaustivos de la autoridad del dominio
  • Establece confianza con tus clientes
  • Retenga a sus clientes a largo plazo
  • Ayuda a elevar el producto
  • Inspirar la cobertura de los medios
  • Gana backlinks de calidad

Y mucho más... Aquí hay una instantánea de algunos de los centros de documentación más populares y los beneficios de marketing de contenido que brindan a sus marcas:

Tabla de centros de documentación y

Pero tienes que saber lo que estás haciendo. Aquí hay seis técnicas simples para tener en cuenta al crear su documentación de SaaS. Espero que pueda usar esto para asegurarse de que la documentación que está creando no solo se use, sino que también se encuentre a través de la búsqueda y la bandeja de entrada de sus clientes cuando alguien se la envíe por correo electrónico y les diga "mire esto".

Hagámoslo…

Mantenga su documentación limpia

No es necesario reinventar la rueda aquí.

Empresas como Shopify, Stripe, WorkOS y Gitlab nos han mostrado cómo es una excelente documentación. El formato no necesita ser demasiado complicado.

Mantenlo simple.

ejemplos de excelente documentación que adopta la simplicidad (Shopify, Stripe, WorkOS, GitLab)

Coloque la navegación a la izquierda y coloque el contenido/código a la derecha. El lado superior derecho ofrece a las personas la posibilidad de iniciar sesión, registrarse o buscar información sobre las novedades en los documentos. Asegúrese de que haya una barra de búsqueda disponible tan pronto como las personas lleguen a sus documentos API y, si tiene el presupuesto para hacer que las cosas sean más interactivas, incorpore un video de introducción en su página de inicio.

Haz que sea fácil de navegar

Mi mayor consejo para los especialistas en marketing que intentan crear una sección de documentación en su sitio sería tratar la página de inicio de documentación como una página de destino. El objetivo de la página principal de su centro de documentación es (i) dirigirlos a la ruta o resultado más común y (ii) educarlos sobre lo que encontrarán en la documentación de una empresa.

¿Encontrarán guías de inicio rápido? ¿Encontrarán definiciones? ¿Hay algún lugar al que puedan ir para obtener más apoyo 1-1? Intente responder a todas estas preguntas en la página de inicio creando una experiencia que sea intuitiva y fácil de seguir. Recuerda:

Aquí no es donde ganas tu viaje a Cannes.

Aquí es donde ganas tu promoción.

Otro enfoque interesante que vi implementado por la gente de WorkOS fue la capacidad de navegar por caso de uso. Stripe lo hace bien al tener una página de Documentos antes de una página de API. Puede seleccionar si está buscando Documentos de Operaciones Comerciales o Documentos de Servicios Financieros...

La API de Stripe es navegable por caso de uso: operaciones comerciales o servicios financieros

Otro producto que hace esto muy bien es Twilio:

La API de Twilio es navegable por seis casos de uso diferentes

Si tiene un conjunto sólido de productos, facilite a sus usuarios navegar a la documentación por casos de uso. Utilice análisis y datos de productos para informar la priorización de la documentación y demuestre que comprende los puntos débiles de sus clientes.

Estructure sus URL con excelencia

¿Quieres ver magia digital? Visite la documentación de Stripe, observe la URL y desplácese...

GIF que muestra que la URL de la API de Stripe cambia a medida que se desplaza hacia abajo en la página

A medida que se desplaza, la URL cambia de docs/ api a /api/authentication a /api/metadata y, por lo tanto, a cualquier otra extensión que tengan. Es una cosa de belleza. ¿Por qué?

Porque cada una de estas URL se puede vincular y lleva a las personas a esta sección específica. Es la experiencia de usuario ideal (desplazamiento infinito) al mismo tiempo que ofrece a Stripe la capacidad de indexar estas secciones individuales en Google a través de su dominio. Es de lo que están hechos los sueños de un SEO...

No solo puede consumir el contenido sin tener que ir a una página nueva, sino que también puede compartir secciones específicas mediante la URL. Hoy, Stripe tiene más de 45,000 dominios de referencia que se vinculan a su documentación. La estrategia de hacer que cada sección clave sea una URL enlazable es una excelente manera de garantizar que los escritores, ingenieros y desarrolladores se vinculen a ella cuando corresponda.

No intente 'comercializar' en su documentación

El marketing tiene una relación de amor-odio con la documentación.

Principalmente porque a los especialistas en marketing les ENCANTA tratar de encontrar formas de darle vida a las cosas y agregar su 'esencia de marca' a todo. No es necesario con documentación. Corta la pelusa y no intentes vender tu producto o varias características. Cíñete a lo que la gente quiere: código y dirección.

No deje que la gente 'asuma sus errores'

Este es un consejo bastante táctico, pero los desarrolladores quieren saber POR QUÉ las cosas no funcionan.

Cree documentación que muestre POR QUÉ hay errores en su producto y cuando intenta construir en su plataforma. Es una de las cosas que se busca con más frecuencia cuando se trata de documentos técnicos, pero he visto que se ha dejado fuera de muchos documentos de API. Haga una lista de los errores con los que se pueden encontrar las personas y enlace a la documentación sobre cómo se pueden prevenir estos errores.

Mi último consejo cuando se trata de crear una gran documentación es este...

Escriba para los humanos primero, para los bots en segundo lugar

Esta podría ser la parte más importante de la documentación.

Debe priorizar la experiencia del desarrollador cuando se trata de documentación antes incluso de comenzar a pensar en cómo Google verá su contenido. ¿Son importantes la indexabilidad, la estructura de URL y los títulos que utiliza para su documentación? No hay duda.

Pero la capacidad de capturar el volumen de búsqueda es la guinda del pastel DESPUÉS de resolver problemas reales y ofrecer claridad en sus documentos. Crear para la gente primero. Optimizar segundo.

Espero que tengas una semana increíble y hayas encontrado esto útil. Estoy convencido de que la documentación es uno de los elementos más importantes y subestimados de la combinación de marketing para las empresas centradas en ingenieros/desarrolladores. Si está trabajando en estos espacios y desea ayuda para crear contenido que ayude a su comunidad de ingenieros a amarlo, ¡póngase en contacto!

Siempre estoy dispuesto a conversar sobre cómo se puede usar el contenido para dar forma a la cultura.