Melhores exemplos de documentação do usuário

A documentação do usuário é sem dúvida uma das partes mais importantes do desenvolvimento do seu produto. Para que os usuários realmente entendam como seu produto funciona, eles sempre precisarão de um ponto de referência.

E quando se trata de produtos ou serviços digitais – as documentações do usuário, às vezes conhecidas como bases de conhecimento, são uma das melhores maneiras de explicar todos os aspectos do seu produto.

A Econsultancy descobriu que mais de 50% dos clientes preferem usar uma base de conhecimento digital e mais de 70% dos clientes preferem usar a documentação online em vez de ligar para o suporte. Essas estatísticas por si só reafirmam a importância dos manuais e documentação do usuário.

Benefícios da documentação do usuário

Vejamos por que a documentação do usuário é importante, mas também por que ela é benéfica para seus negócios a longo prazo.

• Satisfação do cliente. O último lugar que um cliente quer estar é no telefone com sua equipe de suporte depois de não ter entendido seu produto. Uma documentação de fácil acesso pode orientar seus clientes através dos recursos mais básicos aos mais complexos em tempo real.
• Apoiar a produtividade da equipe. Ter um ponto de referência consistente pode remover uma enorme quantidade de tensão de sua equipe de suporte. Perguntas que podem levar 15 minutos para serem resolvidas podem ser resolvidas orientando os clientes na direção certa em seu manual do usuário.
• Experiência do cliente. Na maioria das vezes, os clientes se lembrarão das experiências ruins mais do que das boas. Dessa forma, garantir que os clientes tirem o máximo proveito do seu produto por meio da documentação online é uma maneira de evitar que eles fiquem confusos ou insatisfeitos com seu serviço.
  E se você voltar a olhar para os produtos que está usando diariamente, verá que 99% deles já possuem um manual do usuário. Na verdade, criar você mesmo uma base de conhecimento é relativamente fácil.

Como usuário do WordPress, você pode usar temas de documentação específicos para criar uma base de conhecimento do WordPress em alguns minutos. E se você não usa o WordPress, há muitas plataformas de sistema de base de conhecimento que você pode usar fora dele.

Crie uma Base de Conhecimento - A Maneira Fácil!

Construa uma base de conhecimento e ajude seus clientes a se ajudarem.

Obter o tema

Para este artigo especificamente, vamos nos concentrar em exemplos de ótimos manuais do usuário e documentações online. Observar o que outras marcas estão fazendo com sucesso pode ajudá-lo a entender como estruturar seu próprio manual do usuário.

Você está pronto para começar? Vamos dar uma olhada.

#1: folga

O Slack é uma das ferramentas de comunicação instantânea mais populares do mundo. A plataforma ajuda milhões de empresas a realizar importantes discussões relacionadas ao trabalho em tempo real.

E, embora simples no que diz respeito à comunicação, o Slack oferece uma infinidade de recursos e ferramentas que aumentam a produtividade dos negócios. Escusado será dizer que seria impossível entender como usar o Slack de forma eficiente sem a documentação da Central de Ajuda.

A primeira coisa que os usuários verão ao visitar a Central de Ajuda do Slack é um grande formulário de pesquisa, com palavras-chave sugeridas para perguntas comuns que os usuários têm. Isso permite que os usuários comecem imediatamente a procurar respostas para perguntas urgentes.

Em muitos casos, um formulário de pesquisa por si só é suficiente para ajudar a resolver uma grande parte das dúvidas que seus clientes possam ter. Mas, é sempre bom dar um passo adiante e fornecer trampolins. Por exemplo, adicionando links a páginas nas quais os usuários estão mais interessados.

Esta seção da página inicial da Central de Ajuda do Slack leva os usuários a 6 direções diferentes, cada uma projetada para abordar um caso de uso específico para o próprio produto. Além de aprender o básico do Slack, os clientes também podem acessar páginas que explicam recursos mais avançados, incluindo dicas e truques interessantes que podem não ser aparentes à primeira vista.

Em outras palavras, você pode usar sua base de conhecimento ou manual do usuário para ajudar os usuários a entender seu produto em profundidade.

Por último, mas não menos importante, seja minucioso em sua abordagem. Uma ótima página de documentação cobre tudo, desde os recursos básicos até os mais avançados. Embora o Slack use uma interface de usuário intuitiva, a Central de Ajuda abrange todos os aspectos do uso do produto em sua capacidade máxima.

#2: Conheça tudo

KnowAll é o principal tema de base de conhecimento baseado em WordPress do mundo criado por você. Marcas como Pagely, Apptentive, OptimizePress e muitas outras estão usando o KnowAll para fornecer a seus clientes guias úteis e respostas a perguntas críticas.

Faz sentido que usemos a Central de Ajuda do KnowAll como base para uma visão geral completa desse tema.

Como outras páginas de documentação on-line, o KnowAll também adota o formulário de pesquisa introdutório que é impossível perder. É o pão com manteiga de qualquer tipo de manual do usuário.

Uma pequena adição interessante aqui é que o KnowAll usa pesquisa em tempo real:

Os resultados da pesquisa são obtidos em tempo real e exibidos como parte do próprio formulário de pesquisa. Isso economiza alguns cliques para os clientes, pois eles podem encontrar imediatamente páginas de ajuda relacionadas à palavra-chave de interesse.

As próprias páginas de ajuda são estruturadas de forma semelhante às postagens do blog. Permitindo que você explique tópicos específicos em grande detalhe, com o uso de todos os elementos tradicionais de edição de conteúdo com os quais você já está familiarizado.

Neste exemplo, há 3 fatores importantes da interface do usuário a serem levados em consideração:

1. Breadcrumbs – uma maneira eficaz de informar aos clientes em que parte da página eles estão, mas também de permitir que os clientes voltem rapidamente para uma categoria de suporte específica, se desejarem.
2. Conteúdo – as páginas de ajuda detalhadas devem ter um widget de Índice para que os clientes possam pular para a seção em que estão mais interessados.
3. Suporte – por último, um meio para os clientes entrarem em contato com sua equipe de suporte se a página de ajuda for insuficiente.

Esses fatores garantem que os clientes sempre possam obter o suporte de que precisam, mesmo que algo não seja totalmente compreendido.

E, finalmente, há a questão do suporte móvel. Cada vez mais clientes navegam na web a partir de seus dispositivos móveis ou portáteis, o que significa que ter um site responsivo é fundamental para o seu sucesso.

O design responsivo integrado do KnowAll garante que sua base de conhecimento pareça estelar tanto em desktops quanto em dispositivos móveis.

#3: Google

O Google é o site mais popular do mundo. Seja na Pesquisa, Gmail ou Android – bilhões de pessoas acessam os serviços do Google todos os dias. A empresa possui centenas de produtos e ferramentas e, na maioria dos casos, cada produto possui sua própria página de documentação ou manual do usuário.

As perguntas e comentários mais comuns são tratados por meio do portal de Ajuda do Google. Lá você encontrará respostas no estilo da base de conhecimento e fóruns da comunidade para enviar comentários ou perguntas.

E para uma marca do tamanho do Google – faz muito sentido manter um fórum online onde os usuários possam ajudar uns aos outros com questões peculiares. Ele oferece aos clientes a chance de explicar problemas que podem não ser cobertos por sua documentação, mas também de se envolver em discussões sobre recursos em potencial que os clientes gostariam de ver adicionados no futuro.

Uma das abordagens que o Google adota é um recurso “Upvote”. Isso permite que todos os seus clientes participem de problemas ou comentários que sejam mais importantes para eles.

Da mesma forma que você aloca prioridade a determinados tíquetes de suporte com seu software de suporte técnico.

Além disso, os clientes podem assinar novas respostas ou deixar um comentário próprio.

A longo prazo, isso ajudará a identificar problemas exclusivos, mas também ajudará você a criar um diretório muito maior de perguntas de suporte respondidas.

#4: DigitalOcean

A DigitalOcean é um dos principais provedores de hospedagem em nuvem para desenvolvedores. E, ao contrário das páginas de ajuda tradicionais, a DigitalOcean mantém seus recursos de documentação inteiramente por meio da página da Comunidade. Como o nome indica, a maior parte do apoio é fornecida pela própria comunidade.

Isso vem na forma de tutoriais escritos, perguntas nos fóruns e páginas de documentação independentes para produtos da DigitalOcean.

Uma abordagem de documentação orientada por uma comunidade pode trazer enormes benefícios para seus resultados. E aqui está o porquê.

1. Ele incentiva os clientes a se envolverem com seu produto ou serviço além de sua funcionalidade básica.
2. Você pode gerar conteúdo específico que é indexado e classificado pelos mecanismos de pesquisa. Como tal, fornecendo a você valiosos benefícios de SEO.
3. Uma comunidade ativa ajuda a promover uma reputação positiva aos olhos de novos clientes em potencial.

Compreensivelmente, os benefícios de uma abordagem baseada na comunidade dependem em grande parte do tipo de produto ou serviço que você oferece. Mas é algo para se pensar, considerando o quão bem-sucedido pode ser.

#5: Ahrefs

Como uma das principais ferramentas de SEO – Ahrefs – gerencia sua documentação de usuário para um produto aparentemente complexo? A resposta é, com simplicidade. A Central de Ajuda da Ahrefs vai direto ao ponto quando se trata de fornecer ajuda com as respostas que os clientes podem ter.

No entanto, uma coisa se destaca mais do que o resto.

Que são as próprias páginas de ajuda. A Ahrefs trata sua documentação como se fosse uma página de blog, com artigos detalhados e completos explicando cada recurso exclusivo de seu produto.

Como o produto em si é relativamente complexo com uma curva de aprendizado íngreme, escrever páginas de documentação no estilo de blog ajuda os clientes a entender melhor como usar o produto. Sem a necessidade de recorrer a manuais de terceiros.

Escusado será dizer que isso permite que você classifique suas próprias páginas de documentação nos mecanismos de pesquisa. As chances são de que os clientes procurem interações exclusivas com seu produto, e ter essas informações publicadas ajudará a aumentar a retenção de clientes.

Dicas para melhorar seu manual do usuário

Os exemplos que analisamos ao longo deste artigo devem ser suficientes para ajudá-lo a começar com novas ideias.

E para encerrar, vamos ver algumas maneiras pelas quais você pode aprimorar ainda mais seu manual do usuário e/ou páginas de documentação.

• Use recursos visuais. A aprendizagem visual é muito mais acessível do que em parágrafos longos. Os clientes devem sentir que podem encontrar uma resposta em questão de segundos, porque, caso contrário, você corre o risco de fazer o produto parecer mais complexo do que realmente é.
• SEO. Alguns produtos superam a si mesmos. Como resultado, os clientes migrarão para os mecanismos de pesquisa para encontrar respostas para perguntas e/ou interações exclusivas. Certifique-se de escrever suas páginas de documentação com a intenção de que elas também sejam encontradas por meio de mecanismos de pesquisa.
• KYC – Conheça seu cliente. Qual é a sua proeza técnica? Por que eles estão usando o seu produto? Compreender a persona por trás de seu cliente ideal o ajudará a se adaptar ao estilo de comunicação que você usa em suas páginas de documentação.

Monitorar as perguntas que os clientes fazem diretamente a você também ajudará a moldar sua documentação. Da mesma forma, fique atento às menções nas mídias sociais e sites de perguntas e respostas. Você nunca sabe como os clientes desejam usar seu produto até vê-lo por si mesmo.

Conclusão

O objetivo principal dos manuais e documentação do usuário é reduzir o tempo que leva para um cliente entender seu produto. E, como aprendemos neste artigo, existem inúmeras maneiras de abordá-lo.

Manuais do usuário claros, bem instruídos e organizados irão colocar seus clientes no caminho para usar seu produto em todo o seu potencial. Além disso, poupará muito tempo à sua equipe de suporte que pode ser gasto lidando com problemas críticos.