9 dicas para uma documentação incrível do usuário (com exemplos)

A documentação do usuário é uma parte importante do produto geral entregue ao seu cliente. Ajuda os usuários finais a serem mais bem-sucedidos com seu produto ou serviço.

No passado, a documentação do usuário era fornecida por meio de um arquivo de ajuda local da máquina do usuário ou de um manual ou livreto físico. Isso significava que não poderia ser atualizado ou alterado facilmente e que os provedores de software obtiveram muito poucos dados sobre como seu conteúdo era usado.

Hoje em dia, a documentação do usuário é quase sempre oferecida on-line, o que ajudou os redatores técnicos a serem mais criativos na forma como auxiliam os usuários. Eles podem coletar dados, experimentar diferentes técnicas de aprendizado, iterar mais rapidamente e produzir uma experiência de conteúdo mais rica para os usuários.

É aí que entra este post do blog! eu

n esta postagem, exploraremos o que você pode fazer para melhorar a documentação do usuário e analisaremos alguns exemplos de excelente conteúdo de suporte ao usuário.

Comece com um plano

Como a maioria das coisas na vida, é melhor começar com um plano, e criar a documentação do usuário não é diferente. É por isso que você deve se certificar (e possivelmente àqueles que solicitam a documentação) muitas perguntas antes de começar.

1. Considere seu público

Para quem você está fazendo isso? O usuário final? Um administrador de sistema? Esse conteúdo só será revisado internamente ou será visto externamente também? Para quem você está criando a documentação do usuário ajuda a enquadrar as informações que você compartilha.

2. Avalie e mantenha seu objetivo final em mente

O principal objetivo de qualquer documentação é ensinar algo ao seu público. Depois de determinar quem consumirá sua documentação, você decidirá o que deseja que eles obtenham dela.

Qual é a ação que você gostaria que seu público realizasse depois de analisar a documentação? Ao manter a resposta a essa pergunta em mente, você poderá fornecer a quantidade certa de conteúdo para a tarefa em questão.

3. Certifique-se de que a documentação do usuário seja facilmente encontrada

A documentação oculta do usuário é quase tão inútil quanto a documentação ruim do usuário. É importante certificar-se de que a documentação do usuário que você cria seja facilmente localizável para aqueles que precisam dela.

Isso não significa apenas garantir que ele esteja visível, mas também significa que os usuários podem navegar em sua documentação técnica e encontrar rapidamente respostas para suas perguntas.

Quanto mais rápido seu público encontrar essas respostas, mais feliz ele ficará. Isso também economizará seu tempo de responder a perguntas importantes, mas comuns, sobre seu produto.

Escrita concisa e forte

Uma escrita forte é essencial para uma ótima documentação do usuário. Mas a escrita afeta mais do que a leitura ou o som da documentação do usuário. Também pode influenciar a facilidade de navegação na documentação do usuário.

4. Escreva títulos e legendas descritivas

Certifique-se de que seus títulos sejam úteis e, mais importante, específicos. Escrever títulos ou subtítulos formulados para responder a uma pergunta costuma ser o melhor. Enquadrar os títulos dessa forma torna mais fácil para os usuários finais encontrarem o que estão procurando e também ajuda a escrever artigos que atendam diretamente às necessidades dos usuários.

O Unbounce faz um trabalho fantástico ao escrever títulos e legendas eficazes em toda a documentação do usuário. Isso torna sua documentação fácil de navegar. Cada artigo específico tem seu próprio índice, o que torna muito fácil encontrar a resposta para uma pergunta específica.

5. Facilite a navegação

Fornecer informações de maneira fácil de verificar ajuda os usuários a economizar tempo. Como seres humanos, apreciamos qualquer economia de tempo que possamos obter. Além disso, os usuários podem não saber exatamente o que estão procurando. É quando o conteúdo fácil de navegar é mais benéfico.

A IBM faz um bom trabalho ao tornar seu conteúdo de ajuda fácil de navegar, organizando um índice limpo e fornecendo tópicos relacionados.

6. Torne-o facilmente pesquisável

O Google nos ensinou que encontrar as respostas para nossas perguntas é tão simples quanto digitá-las em uma caixa de pesquisa. Sua documentação de ajuda deve refletir essa expectativa. Se o seu conteúdo de ajuda não for pesquisável, provavelmente não será muito útil.

A base de conhecimento aprofundada da Hubspot facilita o autoatendimento para seus clientes.

Use recursos visuais para melhorar a compreensão

A boa documentação do usuário é altamente visual. Embora a escrita e o texto fortes sejam essenciais para uma documentação incrível do usuário, as pessoas aprendem melhor quando os recursos visuais também estão presentes.

7. Use capturas de tela anotadas

Capturas de tela anotadas são recursos visuais poderosos para usar na documentação do usuário. Eles removem a adivinhação para os usuários, mostrando exatamente quais etapas eles precisam seguir.

Com programas como o TechSmith Snagit, é fácil adicionar textos explicativos, setas e muito mais às capturas de tela. Por exemplo, você notará que estou usando capturas de tela anotadas que fiz com o Snagit ao longo desta postagem do blog.

Se você está se sentindo inspirado, você pode até experimentar a Ferramenta de Passo do Snagit, que permite identificar partes de uma imagem colocando textos explicativos ordenados enquanto você aponta e clica. Cada vez que você clica para adicionar outra etapa, o número avança automaticamente.

Uma empresa que está fazendo um trabalho maravilhoso ao utilizar o poder das capturas de tela em sua documentação é a Asana. Ao longo de sua incrível documentação do usuário, eles usam capturas de tela anotadas para orientar claramente os clientes.

8. Aproveite o vídeo para mostrar, não contar

O vídeo funciona bem para demonstrar um processo. Muita documentação de usuário incrível combina o poder do vídeo com instruções de texto. Por exemplo, é uma boa prática usar um vídeo curto para percorrer rapidamente um processo.

Em seguida, juntamente com o vídeo, você pode fornecer um guia passo a passo em texto para os usuários consultarem enquanto experimentam o processo por conta própria. Dessa forma, eles não precisam assistir ao vídeo repetidamente se precisarem apenas de um lembrete rápido.

Em nossos tutoriais de produtos TechSmith, usamos um vídeo principal para fornecer uma visão geral completa do recurso ou tópico que estamos discutindo. Em seguida, abaixo do vídeo, fornecemos trechos acompanhados de capturas de tela ou GIFs animados para reiterar os pontos principais do vídeo.

9. Mostre exemplos e resultados finais

Os usuários precisam saber como é a conclusão bem-sucedida de cada tarefa. Fornecer aos usuários uma captura de tela de um exemplo de resultado final é uma boa maneira de demonstrar o resultado ideal para seu público.

A excelente documentação do usuário torna mais fácil para os usuários finais encontrar respostas para suas perguntas, o que cria usuários felizes e satisfeitos.

Uma parte fundamental da criação de documentação de usuário incrível é fornecer informações claras e facilmente digitalizáveis. Visuais como capturas de tela, vídeos ou GIFs animados são ótimas maneiras de se comunicar de maneira mais eficiente e eficaz com seus usuários.