Guia definitivo da documentação do produto: tudo o que você precisa saber para criar ótimos documentos

Documentação do produto... pode não ser a parte mais atraente de administrar um negócio, mas é uma área-chave que você não deve ignorar se quiser que seu negócio seja bem-sucedido.

A criação de documentação de produto de alta qualidade pode ajudá-lo a tornar seus clientes mais bem-sucedidos, reduzir sua carga de suporte e, em geral, construir um negócio melhor.

Mas o que é necessário para criar a documentação do produto? E como você pode configurar sua própria documentação em seu site?

Essas são apenas algumas das perguntas que responderemos em nosso guia definitivo para a documentação do produto. Aqui está tudo o que abordaremos:

• Por que você deve se preocupar com sua estratégia de documentação do produto
• Alguns exemplos reais de documentação de alto nível
• O melhor software de documentação de produtos
• Oito dicas para criar uma documentação melhor

Você está pronto para melhorar a forma como sua empresa lida com a documentação? Vamos cavar!

Por que você deve se preocupar com sua estratégia de documentação do produto

Vamos começar analisando por que você não deve economizar em sua estratégia de documentação do produto.

Torna seus clientes mais bem-sucedidos

O maior benefício de criar a documentação do produto é que isso torna seus clientes mais bem-sucedidos. Ter clientes mais bem-sucedidos significa taxas de conversão mais altas, taxas de churn mais baixas e assim por diante.

Faz sentido – se um cliente não consegue descobrir como obter valor do seu produto, ele não permanecerá como cliente por muito tempo.

A documentação do produto é uma maneira útil de educar os clientes para que eles possam obter o máximo de valor possível. Quando eles obtêm mais valor do seu produto, é mais provável que continuem pagando, recomendem você a seus amigos/colegas e assim por diante.

Reduz sua carga de suporte

A documentação do produto também pode ser uma ótima maneira de reduzir a carga em seus canais de suporte humano.

Se a documentação do seu produto for de baixa qualidade ou inexistente, isso significa que seus clientes precisam entrar em contato com sua equipe de suporte humano sempre que houver um problema. Isso significa mais tempo gasto respondendo a solicitações de suporte.

Você precisará tirar um tempo do crescimento de seus negócios para lidar com essas respostas ou precisará contratar uma pessoa de suporte dedicada ( o que custa dinheiro ).

Com documentação de alta qualidade, os clientes poderão resolver muitos de seus próprios problemas, o que elimina a necessidade de procurar suporte. Você também pode estruturar seus processos de suporte para levar as pessoas a verificar sua documentação antes de fazer uma solicitação.

Pode ser uma boa ferramenta de marketing e vendas

Embora muitas pessoas pensem na documentação do produto no contexto de ajudar as pessoas que já decidiram fazer uma compra, uma boa documentação do produto também pode ajudá-lo a atrair e converter mais clientes em primeiro lugar.

Do ponto de vista do marketing, a documentação do produto é uma mina de ouro de palavras-chave de SEO de cauda longa para as quais você pode classificar sua documentação. Você pode se surpreender com o número de pessoas que acessam diretamente a documentação do seu produto do Google. Se você estruturar bem sua documentação, terá a chance de converter essas pessoas em clientes.

Sua documentação também pode ser uma ferramenta de vendas útil para pessoas que estão em dúvida sobre a compra do seu produto. A documentação do produto pode abordar possíveis dúvidas de pré-vendas que eles possam ter, convencê-los de que seu produto pode fazer o que eles precisam e dar a eles a confiança de que obterão ajuda quando precisarem.

Por exemplo, o Stripe é conhecido por ter algumas das melhores documentações de produtos. Se você for ao Twitter, verá muitas pessoas recomendando o Stripe por causa da qualidade da documentação do Stripe:

Torna seus funcionários mais eficazes

A documentação do produto não é apenas para os clientes, mas também pode ser um recurso importante para os membros de sua equipe aprenderem sobre seu produto e fazer referência quando necessário. Isso é especialmente verdadeiro para novos funcionários, que podem não ter uma ampla base de conhecimento sobre seu produto.

Quatro Grandes Exemplos de Documentação de Produto da Vida Real

Para lhe dar mais inspiração, vejamos alguns exemplos de documentação de produtos do mundo real de empresas bem-sucedidas.

1. Faixa

Mencionamos o Stripe anteriormente como um dos melhores exemplos de documentação de qualidade como ferramenta de marketing/vendas, então você sabe que a documentação do Stripe tinha que ser o número um em nossa lista.

2. Adyen

Adyen é uma plataforma de pagamentos para pagamentos de comércio eletrônico, dispositivos móveis e pontos de venda. Assim como o Stripe, isso significa que os desenvolvedores precisam integrá-lo em suas próprias plataformas, o que requer uma excelente documentação. A Adyen não decepciona – confira a documentação completa da Adyen aqui.

3. Twilio

Se você não estiver familiarizado com o Twilio, é uma ferramenta que ajuda as empresas a criar comunicação em suas plataformas, por meio de mensagens de texto, e-mails, telefonemas e muito mais. Assim como com Stripe e Adyen, isso significa que as empresas precisarão integrar o Twilio em seus serviços existentes, o que requer documentação de alto nível. Você pode navegar pelos documentos do Twilio para ver um ótimo exemplo.

4. Folga

O Slack é outra ferramenta que possui documentação muito bem escrita e útil. Você pode navegar pela documentação completa do Slack aqui.

Para ver mais alguns exemplos, confira nosso post completo sobre os melhores exemplos de documentação do usuário.

Melhor Software de Documentação de Produto

Agora, vamos ver como você pode começar a oferecer uma melhor documentação do produto em seu site.

Falaremos sobre como escrever sua documentação na próxima seção. No entanto, antes de escrever sua documentação, você precisa de um local para armazenar esses artigos e torná-los acessíveis aos usuários.

Embora você possa adicionar esses artigos diretamente ao seu site, é uma ideia muito melhor usar um software de documentação de produto dedicado. Além de organizar seu conteúdo e torná-lo acessível aos visitantes, um bom software de documentação do produto incluirá outros recursos úteis, como…

• Funções de pesquisa Ajax para ajudar os visitantes a navegar na documentação.
• Análise de pesquisa para que você possa ver quais tópicos as pessoas estão procurando.
• Dados de utilidade para que você possa acompanhar a utilidade de cada artigo individual e melhorar quando necessário.

Aqui estão duas das melhores soluções…

Base de conhecimento heroica (KB heroica)

Heroic Knowledge Base é um plugin para o software WordPress gratuito e de código aberto que permite criar facilmente seu próprio hub de documentação de produto auto-hospedado.

Se você já usa o WordPress para o site da sua empresa, pode adicionar a Heroic Knowledge Base ao seu site para criar seu próprio hub de documentação. Ou, se não tiver, você pode criar uma instalação dedicada do WordPress para sua documentação. Neste último caso, você também pode estar interessado no tema de documentação do KnowAll WordPress .

A Heroic Knowledge Base permite adicionar toda a sua documentação usando o editor de conteúdo do WordPress, o que facilita a inclusão de conteúdo multimídia, se necessário. Você também terá acesso ao sistema de controle de versão de conteúdo integrado do WordPress, que permite rastrear alterações facilmente e comparar versões anteriores de sua documentação.

A Heroic Knowledge Base também adiciona vários recursos úteis, incluindo:

• Pesquisa instantânea do Ajax.
• Análise de pesquisa.
• Classificações de utilidade do artigo.
• Anexos de arquivo de artigo.

A Base de Conhecimento Heroica custa apenas US$ 129.

Ajuda do Adobe Robo

Se você está apenas publicando sua documentação na web, uma solução como Heroic Knowledge Base é tudo que você precisa. No entanto, para mais necessidades de documentação de nível empresarial, você pode ter situações em que precisa publicar sua documentação em várias plataformas, incluindo a Web, papel físico, aplicativos móveis, PDFs e assim por diante.

Nesse caso, você pode preferir uma ferramenta de criação de documentação multiplataforma, como Adobe RoboHelp. A partir de US$ 29,99 por mês para uso individual, é mais caro que o Heroic Knowledge Base. No entanto, se você precisar de criação multiplataforma, esse preço extra pode valer a pena.

Como otimizar a estrutura e o conteúdo da documentação do produto

Agora que você tem o software necessário para gerenciar sua documentação, vamos falar sobre como você pode escrever artigos de alta qualidade. Aqui estão oito dicas importantes para estruturar sua documentação e escrever melhores artigos de ajuda…

1. Entenda seu público

Para escrever uma ótima documentação de produto, você precisa entender o público para o qual está escrevendo (ou seja, seus clientes).

Para quem você está escrevendo afetará quais informações você inclui e como estrutura tudo. Por exemplo, se você estiver escrevendo para desenvolvedores, sua documentação deve ser radicalmente diferente de escrever para usuários casuais.

Você não quer presumir que seu público é especialista e passar por cima de detalhes importantes, mas pode assumir algum conhecimento básico, dependendo de quem eles são.

2. Entenda os diferentes tipos de documentação do produto

Existem diferentes tipos de documentação do produto e cada um requer uma abordagem diferente. Alguns dos tipos comuns são:

• Visões gerais – esses artigos fornecem uma visão geral de como uma área do seu produto funciona, como um guia de “Primeiros passos”.
• Tutoriais passo a passo – esses artigos mostram às pessoas como realizar uma tarefa específica.
• Referência – estes artigos explicam conceitos específicos em seu produto.
• Solução de problemas – esses artigos explicam como depurar/solucionar problemas comuns que os clientes podem encontrar.

O tipo de documentação em que você está trabalhando deve afetar como você escreve e estrutura sua documentação, por isso é importante saber qual é o objetivo antes de se aprofundar.

3. Seja consistente em seu estilo e convenções de nomenclatura

Para facilitar o uso da documentação do produto pelos clientes, é importante manter o mesmo estilo e convenções de nomenclatura em toda a documentação. Isso tornará mais fácil para os clientes acompanharem sua documentação e evitará qualquer confusão em potencial.

Para ajudá-lo a fazer isso, pode ser útil criar um guia de estilo para formatação e terminologia básicas.

4. Use uma linguagem simples e seja conciso

Todas as coisas iguais, linguagem curta e simples é sempre melhor do que salada de palavras. Seu objetivo deve ser comunicar todas as informações necessárias com o menor número de palavras possível.

Você também deve evitar usar jargões ou termos complexos sempre que possível. Nem todos os seus clientes terão a mesma base de conhecimento e alguns podem nem ser falantes nativos do idioma de sua documentação, portanto, manter as coisas o mais simples possível garante que todos possam obter valor de sua documentação.

5. Organize a documentação em artigos lógicos de “tamanho da edição”

Para tornar mais fácil para as pessoas navegarem em sua documentação e encontrarem artigos para seus problemas específicos, você precisa dividir sua documentação em segmentos lógicos. Em geral, cada artigo deve se concentrar na solução de um problema específico.

É claro que pode haver vários subproblemas dentro desse problema principal, mas a ideia é que você não queira agrupar dois problemas completamente separados no mesmo artigo, porque isso dificultará as pessoas pesquisar esses tópicos e eles podem ficar confusos quando pousam no artigo.

Seus clientes não lerão sua documentação de maneira linear como se estivessem lendo um livro. Em vez disso, eles vão pular com base no problema que estão encontrando no momento. Dividir seus artigos em segmentos lógicos ajuda a explicar esse comportamento.

6. Incorporar Elementos Multimídia

Embora o texto escrito deva formar o núcleo da documentação do seu produto, não deve ser a única coisa. Também pode ser útil incluir conteúdo de imagem e vídeo onde fizer sentido.

Se incluir capturas de tela, você também pode adicionar anotações às imagens para esclarecer os principais detalhes.

7. Use títulos e adicione um índice

Nos artigos de documentação de produtos individuais, certifique-se de usar títulos para dividir seus artigos em segmentos lógicos em vez de apenas escrever uma longa parede de texto.

Para ajudar as pessoas a navegar pelo artigo, você também pode adicionar um índice que permite aos leitores pular rapidamente para uma seção específica.

Alguns softwares de documentação do produto podem ajudá-lo a adicionar automaticamente um índice. Por exemplo, o plugin Heroic Knowledge Base vem com um recurso integrado para gerar automaticamente um índice com base nos títulos de cada artigo.

8. Sempre melhore e atualize sua documentação

Finalmente, é importante lembrar que a criação da documentação do produto não é um evento único; é um processo contínuo.

Em um nível básico, seu produto provavelmente sofrerá alterações, por isso é importante atualizar sua documentação para levar em conta essas alterações e quaisquer novos recursos que você adicionou.

Mas, além disso, se você escolher um software de documentação de produtos, como o Heroic Knowledge Base, terá acesso a análises para ajudá-lo a entender como as pessoas estão usando sua documentação. Você pode usar essas análises para:

1. Acompanhe o que as pessoas estão procurando, o que pode ser um sinal de que você precisa criar documentação sobre esses tópicos, caso ainda não o tenha feito.
2. Veja quais artigos não estão ajudando os usuários tanto quanto você gostaria, o que pode ser um sinal de que você precisa fazer melhorias nesses artigos para melhorar sua utilidade.

Comece a criar uma incrível documentação de produto hoje mesmo!

Criar documentação de produto de alta qualidade é um investimento no sucesso a longo prazo do seu negócio. Ele te ajuda…

• Faça com que seus clientes tenham mais sucesso.
• Reduza a carga de sua equipe de suporte.
• Atraia e converta mais clientes em primeiro lugar.
• Melhore o conhecimento de seus funcionários sobre seu produto.

Neste post, compartilhamos alguns ótimos exemplos de documentação de produtos de empresas de sucesso, juntamente com algumas dicas sobre como escrever e estruturar sua documentação.

Se você estiver pronto para criar seu próprio hub de documentação do produto, poderá usar o plug-in Heroic Knowledge Base para criar sua própria solução auto-hospedada desenvolvida com WordPress. Clique para saber mais sobre a Base de Conhecimento Heroica.