Como criar um manual do usuário: do zero ao herói (guia completo)

Não sabe como criar um manual do usuário para ajudar seus clientes a obter mais valor de seu produto?

Um manual do usuário é um conteúdo que ajuda seus clientes (ou funcionários) a usar seu produto ou serviço de maneira eficaz. Você também pode vê-lo chamado de guia do usuário, manual de instruções, manual do produto e assim por diante.

Além de ajudar seus clientes a usar seu produto com eficiência, criar um manual do usuário de alta qualidade também pode ajudá-lo a reduzir as solicitações de suporte e atendimento ao cliente, porque os usuários podem resolver seus problemas sem entrar em contato com o suporte.

Neste guia detalhado, você aprenderá como criar um manual do usuário que ajude seus clientes a alcançar o sucesso.

Para que isso aconteça, aqui está tudo o que vamos cobrir:

• Diferentes tipos de manuais do usuário
• Onde publicar seu manual do usuário
• Como criar um manual do usuário

Vamos cavar!

Diferentes tipos de manuais do usuário

Existem diferentes tipos de manuais do usuário, incluindo conteúdo voltado para o cliente e interno.

Antes de começar, é importante entender que tipo de manual você deseja criar, pois isso afetará a forma como você abordará o conteúdo.

Aqui está um breve resumo dos diferentes tipos de manuais do usuário:

• Manual do usuário – um manual do usuário clássico ensina aos usuários como usar um produto.
• Manual de treinamento – um manual de treinamento ensina aos usuários como realizar uma determinada tarefa ou concluir um determinado trabalho.
• Manual de operação – um manual de operação é normalmente um manual interno que documenta as operações da sua empresa.
• Manual de serviço – um manual de serviço se concentra em ensinar aos usuários como manter adequadamente um produto em diferentes pontos do ciclo de vida do produto.
• Procedimentos Operacionais Padrão (SOPs) – SOPs são manuais internos que ensinam os membros da organização a concluir corretamente certos processos “da maneira certa”.

Para as instruções abaixo, estamos principalmente preocupados em criar um manual do usuário voltado para o público. No entanto, os princípios básicos abaixo se aplicam a qualquer tipo de manual do usuário.

Onde publicar seu manual do usuário

Onde você publica seu manual do usuário dependerá do tipo de manual do usuário que você está criando.

Para manuais do usuário voltados para o cliente, você quase sempre desejará publicá-los em seu site. Dessa forma, os usuários podem acessar o manual de qualquer lugar.

Além disso, publicar o conteúdo do manual do usuário na Web também permite que você crie uma experiência mais amigável do que com um manual do usuário físico, como adicionar índices clicáveis ​​e sugestões de pesquisa em tempo real.

No entanto, para produtos físicos, você também pode querer incluir um manual do usuário físico como um complemento para seu manual baseado na web.

Para manuais de usuário internos, você normalmente desejará ocultá-los da exibição pública.

Uma maneira de fazer isso é disponibilizá-los apenas na intranet da empresa. No entanto, com tantas pessoas trabalhando em casa, isso pode ser difícil de fazer, a menos que sua empresa tenha sua própria configuração de VPN.

Em vez disso, você pode considerar proteger o conteúdo com senha, exigindo que o funcionário faça login em uma conta de usuário ou apenas adicionando uma senha para acessar a página.

Para manuais do usuário físicos, você pode usar uma ferramenta de gerenciamento de conhecimento dedicada para ajudá-lo a publicar manuais mais complexos. Ou, para manuais de usuário mais simples, você pode simplesmente escrever no Google Docs e publicar a partir daí – nossa coleção de ferramentas de redação técnica tem algumas ferramentas úteis para facilitar sua vida.

Para publicar seu manual do usuário online, você pode usar a maioria das documentações ou softwares de base de conhecimento. Se você deseja uma ferramenta que possa lidar com manuais de usuário voltados ao público e internos, considere o plug-in Heroic Knowledge Base de código aberto para WordPress. Falaremos sobre isso com mais profundidade no tutorial.

Aqui está um exemplo de um manual do usuário online da Heroic Knowledge Base (e sobre a Heroic Knowledge Base):

Falando no tutorial…

Como criar um manual do usuário em seis etapas

Agora que você tem algumas informações básicas, vamos ver como criar um manual do usuário, começando do zero e indo até um manual do usuário finalizado.

1. Crie sua(s) Persona(s) de usuário

Antes de começar a criar qualquer conteúdo, você deseja entender para quem é o conteúdo, o que pode ser feito criando personas de usuário.

Você provavelmente já tem uma boa ideia de quem são seus clientes, mas é útil anotá-los para realmente concentrar seus esforços.

Por que isso é importante?

Bem, aqui está um exemplo:

Há uma grande diferença entre criar conteúdo técnico para engenheiros mecânicos e criar conteúdo técnico para usuários não técnicos.

Para a maioria dos produtos, as diferenças não serão tão gritantes. Mas ainda é importante entender as personas de seus clientes para garantir que seu manual do usuário faça sentido para as pessoas que realmente o usarão.

2. Identificar o(s) problema(s) chave e meta(s)

Depois de entender quem são seus clientes, a próxima etapa é entender o que eles estão tentando alcançar com o manual do usuário que você criará.

Isto é, qual é o objetivo final (ou objetivos finais) das pessoas que lerão este manual?

Entender isso é importante porque o objetivo do seu manual deve ser ajudar seus usuários a atingir esse objetivo da maneira mais eficiente possível.

Em alguns casos, esse objetivo final pode ser algo específico. Por exemplo, se você tiver uma ferramenta de gerenciamento de mídia social, pode ser “agendar uma postagem nas mídias sociais”.

Em outros, pode ser um objetivo mais abstrato, como “melhorar nossos processos de gerenciamento de projetos”.

Para produtos maiores, pode haver várias coisas que o usuário está tentando alcançar, o que nos leva à próxima seção.

3. Crie uma estrutura lógica e hierarquia

Agora que você entende quem são seus clientes e o que eles desejam alcançar, você pode começar a mapear a estrutura do seu manual do usuário.

Você deseja criar uma estrutura que levará seus usuários do “zero” para atingir o(s) objetivo(s) final(is) que você listou na seção anterior.

Aqui estão algumas dicas para ajudá-lo a fazer isso:

1. Pense em como ajudar os clientes a começar a obter valor de seu produto o mais rápido possível.
2. Tire seu próprio conhecimento pessoal disso. Você obviamente sabe muito sobre seu produto, mas seus clientes não terão esse nível de conhecimento prévio.
3. Certifique-se de cobrir quaisquer problemas comuns ou detalhes confusos que seus clientes possam encontrar ao tentar usar seu produto. Isso deve ser tratado logicamente nos momentos em que os clientes têm maior probabilidade de ter problemas.

4. Escreva o conteúdo do seu manual do usuário

Depois de mapear seu conteúdo, você está pronto para começar a escrever.

Dependendo do tamanho do seu produto/organização, você pode escrever tudo sozinho. Ou talvez seja necessário colaborar com outros membros da equipe para escrever o conteúdo.

Aqui estão algumas práticas recomendadas gerais do manual do usuário a serem consideradas ao escrever seu manual do usuário:

• Use um modelo para garantir uma formatação consistente . Criar um modelo formatado não apenas acelera seu trabalho, mas também garante que cada artigo de seu manual seja consistente com os outros.
• Inclua recursos visuais (imagens e vídeos) para ajudar os usuários . Uma imagem ou GIF bem anotado pode ser mais útil do que instruções de texto independentes, não importa o quão detalhado e completo seja o texto.
• Use linguagem simples e evite jargões . Ou, quando o jargão for completamente inevitável, certifique-se de explicá-lo.
• Mantenha-o curto e direto ao ponto . Seu objetivo com um manual do usuário deve ser cobrir totalmente o tópico, mas com o mínimo de palavras possível. Não deixe de fora informações importantes, mas corte impiedosamente qualquer conteúdo desnecessário.
• Use marcadores e listas para obter instruções quando possível . O uso de uma lista numerada ou com marcadores pode facilitar o acompanhamento do guia pelos usuários. Ou, se precisar de mais detalhes do que uma lista permite, você pode criar um subtítulo para cada etapa.
• Use a voz ativa . A voz passiva pode ser especialmente confusa para as instruções em um manual do usuário. É a diferença entre “O produto pode ser ligado apertando o botão vermelho” e “Você pode ligar o produto apertando o botão vermelho”. O último exemplo (voz ativa) é mais claro e facilita a inserção do leitor nas instruções.

Por fim, é sempre uma boa ideia testar as instruções do manual do usuário como se fosse um usuário iniciante.

Ou seja, depois de escrever um artigo, volte e siga essas instruções passo a passo para garantir que não perdeu nada.

5. Publique seu manual do usuário

Depois de ter seu conteúdo, a última etapa para entrar no ar é publicar seu manual do usuário para torná-lo facilmente disponível para seus clientes.

Como você fará isso dependerá do tipo de produto que você está oferecendo. Por exemplo, você pode querer incluir uma versão física de seu manual se estiver enviando produtos físicos.

No entanto, independentemente do tipo de produto que você está oferecendo, convém publicar seu manual do usuário on-line para que as pessoas possam encontrá-lo facilmente.

Para ajudá-lo a fazer isso, você pode usar um software de base de conhecimento/documentação.

Por exemplo, com o plug-in Heroic Knowledge Base WordPress, você pode publicar seu manual do usuário usando o software WordPress de código aberto.

Essa abordagem de código aberto oferece total propriedade e controle sobre sua plataforma, ao mesmo tempo em que fornece muitas ferramentas úteis para ajudar seus clientes a navegar pelo manual do usuário com mais eficiência:

• Organização de categorias – você pode facilmente organizar seu manual do usuário em categorias lógicas e ordenar essas categorias usando arrastar e soltar.
• Sugestões de pesquisa em tempo real – se os clientes quiserem ir direto para um tutorial específico, basta começar a digitar na pesquisa e ver as sugestões de pesquisa ao vivo com base em suas consultas.
• Índice automático – o plug-in gerará automaticamente um índice clicável para cada artigo do manual do usuário, o que ajuda os leitores a irem direto para a seção relevante para eles.
• Textos explicativos/formatação fáceis – você pode facilmente adicionar textos explicativos e outras formatações para chamar a atenção para elementos-chave em seus artigos.
• Widget de respostas instantâneas – além de criar uma página de manual do usuário dedicada em seu site, você também pode adicionar um widget de respostas instantâneas pesquisáveis ​​que permite aos visitantes navegar pelo conteúdo do manual do usuário de qualquer lugar do site.

Se você quiser ver ainda mais opções de software para ajudá-lo a publicar um manual do usuário, leia nossas postagens sobre o melhor software de base de conhecimento e as melhores ferramentas de documentação.

6. Atualize e revise seu manual do usuário conforme necessário

Criar um manual do usuário não é um esforço único. No futuro, você precisará dedicar tempo para revisar e atualizar seu conteúdo.

Há dois motivos principais pelos quais você pode precisar atualizar seu manual do usuário:

1. Você adicionou novos recursos ao seu produto ou alterou o funcionamento dos recursos/interfaces existentes.
2. Você deseja melhorar o conteúdo do manual do usuário para torná-lo mais útil.

A primeira situação é óbvia – se você alterar seu produto de alguma forma, precisará atualizar seu manual do usuário para levar em conta essas alterações.

No entanto, é importante levar em consideração a segunda situação. Por mais que tente, você provavelmente não obterá todos os artigos do manual do usuário perfeitos desde o primeiro dia.

Para ajudar melhor seus usuários, convém atualizar e revisar o conteúdo manual de baixo desempenho para torná-lo mais útil.

Se você publicar seu manual do usuário com uma ferramenta como a Heroic Knowledge Base, ele incluirá classificações de utilidade de artigo integradas para que você possa ver facilmente quais artigos precisam ser melhorados. Os usuários também podem deixar comentários de texto sobre o artigo, o que pode apontar para partes específicas do artigo que não estão ajudando tanto quanto poderiam:

Você também pode estar perdendo artigos para tópicos com os quais os usuários estão tendo problemas. Para ajudá-lo a encontrar esses tópicos ausentes, o Heroic Knowledge Base também inclui análises de pesquisa integradas para que você possa rastrear quais pesquisas não têm nenhum resultado de tópico ( bem como pesquisas gerais em geral ):

Crie seu manual do usuário hoje

Aprender a criar um manual do usuário é importante se você deseja preparar seus clientes para o sucesso.

Com as dicas e práticas recomendadas nesta postagem, você já deve ter o conhecimento necessário para começar a usar o manual do usuário.

Para uma maneira fácil de publicar seu manual do usuário online e ajudar seus clientes a navegar nele, você pode usar o WordPress e o plug-in Heroic Knowledge Base.

A Heroic Knowledge Base facilita a publicação de seus artigos e a organização conforme necessário. Além disso, seus clientes podem aproveitar recursos úteis, como sugestões de pesquisa ao vivo, índice automático e muito mais.

Comece hoje e você publicará seu manual do usuário rapidamente.

Se você está interessado em criar documentação para melhorar o conhecimento interno da sua empresa, também pode se interessar pelo nosso tutorial sobre como publicar um manual de treinamento para sua equipe.