Por que a documentação da API é ouro no marketing de conteúdo

Este vai para todos os meus profissionais de marketing B2B SaaS que têm o luxo de tentar vender para engenheiros e desenvolvedores.

Não é um trabalho fácil. Não é tão simples como publicar um anúncio inteligente ou fazer um webinar interessante. Não é tão simples como produzir um ebook e colocar alguns posts no LinkedIn.

É um pouco mais complicado... Mas não precisa parecer impossível.

Muitos produtos SaaS começaram a criar ecossistemas de desenvolvedores e APIs para oferecer dados e inspirar soluções personalizadas que geram receita e crescimento adicionais para os negócios.

Quando você observa o sucesso do AppExchange Ecosystem da Salesforce e o próspero Shopify Developer Ecosystem – é muito óbvio que essa abordagem pode oferecer uma receita incrível tanto para os parceiros quanto para a marca. Em 2021, os parceiros desenvolvedores da Shopify ganharam mais de US$ 230 milhões e um estudo da IDC (International Data Corporation) prevê que a Salesforce contribuirá com US$ 1,2 trilhão para economias locais em todo o mundo. Nada mal hein? Veja esse crescimento da Shopify…

Isso não acontece por acaso.

Isso acontece investindo em sua comunidade e investindo em conteúdo que irá apoiá-los.

O canal ShopifyDevs no YouTube é um exemplo claro de como é um investimento em sua comunidade. O canal está repleto de vídeos divertidos, envolventes e lindamente projetados que falam sobre tudo, desde etapas táticas para alavancar a API até vídeos estratégicos de alto nível.

A quantidade de conteúdo carregado neste canal e a qualidade das edições demonstram que este não é um investimento pequeno da Shopify. É algo que eles estão levando a sério e a comunidade respondeu assistindo e assinando de maneira massiva.

Se você está neste espaço, não preciso falar com você sobre as oportunidades que existem na criação de soluções para engenheiros. É uma estratégia poderosa e os números que Shopify e Salesforce estão fazendo em seu ecossistema são ótimos exemplos disso.

Como profissionais de marketing, muitas vezes ignoramos o fato de que essa é uma área em que também devemos atuar.

Não devemos apenas deixar que nossas equipes de produto saiam e desenvolvam a documentação da API. Não devemos apenas deixar que o CTO encontre tempo para criar um grande conjunto de documentação.

Devemos pensar em como podemos apoiar nossa própria equipe de engenharia para criar documentação e conteúdo que realmente agreguem valor à vida de nossos clientes.

Uma das melhores maneiras de fazer isso é adotando e investindo em ótima documentação.

A excelente documentação da API é massivamente subestimada como uma estratégia de marketing de conteúdo em B2B SaaS.

Uma boa documentação pode:

• Direcione links completos de autoridade de domínio
• Estabeleça confiança com seus clientes
• Reter seus clientes a longo prazo
• Ajude a elevar o produto
• Inspire a cobertura da mídia
• Ganhe backlinks de qualidade

E muito mais... Aqui está um resumo de alguns dos hubs de documentação mais populares e os benefícios de marketing de conteúdo que eles estão oferecendo às suas marcas:

Mas você tem que saber o que está fazendo. Aqui estão seis técnicas simples a serem lembradas ao criar sua documentação de SaaS. Espero que você possa usar isso para garantir que a documentação que está criando não seja apenas usada, mas também encontrada por meio da pesquisa e da caixa de entrada de seus clientes quando alguém enviar um e-mail para eles dizendo "confira isso".

Vamos lá…

Mantenha sua documentação limpa

Você não precisa reinventar a roda aqui.

Empresas como Shopify, Stripe, WorkOS e Gitlab nos mostraram como é uma ótima documentação. O formato não precisa ser muito complicado.

Mantenha simples.

Coloque a navegação à esquerda e coloque o conteúdo/código à direita. O lado superior direito oferece às pessoas a capacidade de fazer login, se inscrever ou descobrir informações sobre o que há de novo nos documentos. Certifique-se de que haja uma barra de pesquisa disponível assim que as pessoas acessarem seus documentos de API e se você tiver orçamento para tornar as coisas mais interativas – incorpore um vídeo de introdução em sua página inicial.

Facilite a navegação

Meu maior conselho para os profissionais de marketing que tentam criar uma seção de documentação de seu site seria tratar a página inicial da documentação como uma página de destino. O objetivo da primeira página do seu hub de documentação é (i) direcioná-los para o caminho ou resultado mais comum e (ii) educá-los sobre o que encontrarão na documentação de uma empresa.

Eles encontrarão guias de início rápido? Encontrarão definições? Existe algum lugar que eles possam ir para mais suporte 1-1? Tente responder a todas essas perguntas na página inicial criando uma experiência intuitiva e fácil de seguir. Lembrar:

Não é aqui que você ganha sua viagem a Cannes.

É aqui que você ganha sua promoção.

Outra abordagem interessante que vi implementada pelo pessoal do WorkOS foi a capacidade de navegar por caso de uso. O Stripe faz isso bem ao ter uma página de Documentos antes de uma página de API. Você pode selecionar se está procurando Documentos de Operações de Negócios ou Documentos de Serviços Financeiros…

Outro produto que faz isso muito bem é o Twilio:

Se você tiver um conjunto robusto de produtos, facilite a navegação dos usuários para a documentação por casos de uso. Use análises e dados de produtos para informar a priorização da documentação e mostrar que você entende os pontos problemáticos de seus clientes.

Estruture seus URLs com excelência

Quer ver a magia digital? Visite a documentação do Stripe, veja a URL e role…

À medida que você rola o URL muda de docs/ api para /api/authentication para /api/metadata e assim todas as outras extensões que eles têm. É uma coisa de beleza. Por quê?

Porque cada um desses URLs é vinculável e direciona as pessoas para essa seção específica. É a experiência ideal do usuário (rolagem infinita), enquanto ainda oferece ao Stripe a capacidade de indexar essas seções individuais no Google por meio de seu domínio. É a coisa de que os sonhos de um SEO são feitos…

Além de poder consumir o conteúdo sem ir para uma nova página, você pode compartilhar seções específicas usando a URL. Hoje, o Stripe tem mais de 45.000 domínios de referência com links para sua documentação. A estratégia de tornar cada seção-chave um URL vinculável é uma ótima maneira de garantir que escritores, engenheiros e desenvolvedores vinculem a ela quando apropriado.

Não tente 'comercializar' em sua documentação

O marketing tem uma relação de amor e ódio com a documentação.

Principalmente porque os profissionais de marketing ADORAM tentar encontrar maneiras de apimentar as coisas e adicionar sua 'essência da marca' em tudo. Não é necessário com documentação. Corte o cotão e não tente vender seu produto ou vários recursos. Atenha-se ao que as pessoas querem: código e direção.

Não deixe as pessoas 'assumirem seus erros'

Este é um conselho bastante tático, mas os desenvolvedores querem descobrir POR QUE as coisas não funcionam.

Crie documentação que mostre POR QUE há erros em seu produto e ao tentar construir em sua plataforma. É uma das coisas mais pesquisadas quando se trata de documentos técnicos, mas eu o vi deixado de fora de muitos documentos de API. Faça uma lista dos erros que as pessoas podem encontrar e link para a documentação sobre como esses erros podem ser evitados.

Meu último conselho quando se trata de criar uma ótima documentação é este…

Escreva para humanos primeiro, bots depois

Esta pode ser a parte mais importante da documentação.

Você precisa priorizar a experiência do desenvolvedor quando se trata de documentação antes mesmo de começar a pensar em como o Google visualizará seu conteúdo. A indexabilidade, estrutura de URL e títulos que você usa para sua documentação são importantes? Sem dúvida.

Mas a capacidade de capturar o volume de pesquisa é a cereja do bolo DEPOIS de resolver problemas reais e oferecer clareza em seus documentos. Crie primeiro para as pessoas. Otimize em segundo lugar.

Espero que você tenha uma semana incrível e tenha achado isso útil. Estou convencido de que a documentação é um dos elementos mais importantes e subestimados do mix de marketing para empresas com foco em engenheiros/desenvolvedores. Se você trabalha nesses espaços e deseja suporte na criação de conteúdo que ajudará sua comunidade de engenharia a amá-lo, entre em contato!

Estou sempre disposto a conversar sobre como o conteúdo pode ser usado para moldar a cultura.