Como construir a melhor documentação do usuário

É provável que, se seus produtos forem mais complexos do que um rolo de papel-toalha, você crie algum tipo de documentação do usuário para ajudar as pessoas a aprender como usá-los.

Um manual de produto ou guia do usuário bem elaborado e fácil de usar pode significar a diferença entre uma experiência fantástica do cliente e uma terrível.

Além disso, a documentação do usuário não é apenas para novos usuários.

Clientes experientes também podem consultar os manuais do usuário ou guias de produtos para atualizar suas memórias sobre um recurso que não usaram com frequência ou para resolver um problema específico que tenham.

Para esta postagem, focaremos principalmente nas práticas recomendadas para criar documentação do usuário para produtos não físicos, como software, mas a maioria (se não todas) dessas dicas também se aplica ao domínio do hardware.

Aqui está o que você vai aprender:

• O que é documentação do usuário e por que é importante.
• Como a documentação do usuário final faz parte da experiência do cliente.
• Como uma boa documentação do usuário pode ajudar a aliviar a carga de sua equipe de suporte ao cliente.
• Por que o conteúdo visual é o ingrediente secreto para a melhor documentação.
• Os elementos essenciais que garantem a melhor documentação do usuário.
• As quatro etapas para criar uma documentação que encante seus clientes e resista ao teste do tempo.

O que é documentação do usuário?

A documentação do usuário (também chamada de manuais do usuário final, guias do usuário final, manuais de instruções etc.) é o conteúdo que você fornece aos usuários finais para ajudá-los a ter mais sucesso com seu produto ou serviço.

Esses são os materiais de instrução que acompanham seu produto para ajudar alguém a aprender a usá-lo corretamente ou – no caso de produtos físicos – até mesmo montá-lo.

Se você já montou um móvel da IKEA, você usou a documentação do usuário final.

No entanto, a documentação do usuário assume muitas formas.

Os videogames vêm com manuais para dizer quais botões apertar para atirar nos bandidos. A documentação do software mostra o que sua compra pode fazer e como fazê-lo.

Os formulários fiscais vêm com guias sobre como preenchê-los corretamente.

Os cortadores de grama e os sopradores de neve têm guias de produtos para mostrar como dar partida nos motores e onde reabastecer o combustível.

Pular para como fazer a documentação do usuário

Por que a documentação do usuário é importante?

Você sabe que seu produto é ótimo. Você quer que seus clientes saibam disso também. A documentação do usuário ajuda a garantir que seus clientes ou usuários realmente aprendam como tirar o máximo proveito do seu produto.

Seja como salvar um documento, dar partida em um motor, usar uma ferramenta específica ou até mesmo informações importantes de segurança, a documentação do usuário final é uma parte importante do relacionamento com seus clientes.

A documentação do usuário pode encantar seus clientes

A documentação do usuário é fácil, certo? Quero dizer, basta escrever algumas coisas sobre como usar seu produto, e você está pronto para ir!

Não é tão simples assim.

É mais do que apenas um material “como fazer”. Faz parte da experiência do cliente. E isso significa que também é material de marketing.

Como consumidor, experimentei guias de usuário ótimos e horríveis. Aposto que a maioria de vocês teve experiências semelhantes.

Um ótimo manual do usuário ou guia do produto mostra a seus clientes que você não se importa apenas se eles compram seu produto, mas se eles têm uma experiência realmente ótima ao usá-lo.

Os clientes que sentem que você se importa com eles além da carteira deles continuarão voltando para você.

Se você quiser que eles gritem para o mundo sobre o quanto eles amam seus produtos e serviços, fornecer uma documentação incrível do usuário é uma parte essencial dessa experiência pós-compra.

Como a documentação do usuário oferece suporte à sua equipe de suporte

As pessoas costumam entrar em contato com sua equipe de suporte quando algo não está funcionando, mas também podem ligar quando simplesmente não conseguem descobrir algo. Ter uma ótima documentação do usuário ajuda sua equipe de suporte de duas maneiras principais.

1. Fornece um guia de referência fácil

A excelente documentação do usuário não precisa ser apenas para os clientes. Sua equipe de suporte ao produto pode usar a documentação para ajudar melhor seus clientes quando eles pedirem ajuda. Quando você inclui peças essenciais, como um índice ou índice, eles podem encontrar rapidamente as informações de que precisam. E, se for um documento eletrônico pesquisável, melhor ainda! Aprenderemos mais sobre isso mais adiante no artigo.

2. Reduz as chamadas

Como observado acima, as pessoas geralmente ligam para o suporte quando não conseguem descobrir algo. Mas, se os clientes puderem descobrir por si mesmos, é muito menos provável que precisem de ajuda. Na verdade, mais de 70 por cento das pessoas preferem usar o site de uma empresa para obter ajuda em vez de obter assistência por telefone ou e-mail.

Mesmo a melhor documentação não eliminará todas essas chamadas, mas a criação de guias e manuais do usuário claros, abrangentes e concisos ajudará bastante a reduzir o volume geral de solicitações de suporte.

Quais são os elementos essenciais de uma ótima documentação do usuário?

Embora cada produto seja único e exija elementos diferentes para criar documentos de usuário realmente excelentes, existem algumas práticas recomendadas de documentação do usuário final a serem seguidas, não importa o que aconteça.

Uma ótima documentação do usuário deve incluir:

• Linguagem simples
• Simplicidade
• Visuais
• Um foco no problema
• Uma hierarquia lógica e fluxo
• Um índice
• Conteúdo pesquisável
• Conteúdo acessível
• Bom design
• Feedback de usuários reais
• Links para outros recursos

Linguagem simples

Nada vai frustrar mais um cliente do que ler algo que ele não consegue entender. Ninguém quer se sentir burro, e a linguagem que faz seu cliente se sentir assim certamente não é uma maneira de promover uma ótima experiência.

Use linguagem simples e clara sempre que possível para ajudar seus clientes a entender até os conceitos mais complexos.

Lembre-se, escreva para o usuário, não para o desenvolvedor.

Parece um acéfalo, mas escrever em linguagem simples sobre um produto ou serviço que você conhece é mais difícil do que você imagina. Você conhece todos os tipos de jargão, siglas e outras informações privilegiadas que os clientes provavelmente não conhecem. É natural para você usá-lo.

Mas é aí que você pode ter sérios problemas.

Não presuma que seu cliente sabe alguma coisa sobre seu produto. Não assuma que eles conhecem todos os chavões técnicos e/ou da indústria que você provavelmente usa todos os dias em seu escritório.

Não escreva como se eles fossem crianças, mas entenda que eles podem precisar de ajuda extra para realmente se atualizarem. Escreva a documentação de uma maneira fácil de ler.

Simplicidade

Mantenha a documentação o mais simples possível para atingir seu objetivo. Isso se aplica tanto ao conteúdo do documento quanto ao seu design. Longos blocos de texto e páginas compactadas com conteúdo escrito e gráfico podem fazer com que os guias do usuário ou manuais pareçam intimidantes e hostis.

Os clientes que são intimidados por seus materiais de usuário são muito mais propensos a ligar para sua equipe de suporte para obter ajuda do que tentar resolver suas dúvidas por conta própria. Além disso, eles são muito menos propensos a ter uma boa experiência do cliente.

Visuais

A melhor documentação do usuário ilustra perfeitamente a frase “mostre, não conte”.

O conteúdo visual, incluindo imagens, capturas de tela anotadas, gráficos e vídeos, mostra rapidamente a alguém como seu produto funciona. Eles não precisam ler sobre isso: eles podem ver!

Uma pesquisa recente da TechSmith mostra que as pessoas realmente absorvem informações visuais mais rapidamente e realizam tarefas melhor quando as instruções são fornecidas com conteúdo visual ou em vídeo.

O conteúdo visual também ajuda a dividir longos blocos de texto e pode ajudar a eliminar muito do texto que faz com que muitos guias de usuário ou manuais pareçam intimidantes e desagradáveis.

Formas populares de incluir conteúdo visual na documentação do usuário incluem capturas de tela, gravações de tela, vídeos tutoriais e muito mais.

Você já ouviu falar em gráficos simplificados? Às vezes chamado de interface de usuário simplificada (ou SUI), os gráficos simplificados capturam imagens de uma interface de usuário ou outro gráfico e – assim como o nome sugere – os simplifica. Esta versão mais básica destaca as informações mais essenciais enquanto reduz textos e gráficos que não são importantes para formas mais simples.

Então, algo parecido com isso:

Agora fica assim:

Se eu estivesse tentando mostrar a alguém como selecionar o item de menu Conectar dispositivo móvel, a segunda imagem remove toda a confusão e permite que os olhos do cliente se concentrem onde eles precisam estar.

Provavelmente, você já encontrou gráficos simplificados e nem percebeu, como este do G Suite Learning Center:

Existem muitas ferramentas por aí, mas se você está procurando maneiras poderosas e fáceis de criar capturas de tela e gravações de tela, recomendo fazer o download de uma avaliação gratuita do Snagit.

Foco no problema a ser resolvido

Cada produto resolve um problema. Mas, muitas vezes, estamos tão apaixonados por nossos recursos interessantes de produtos que tudo o que queremos fazer é destacar o que eles podem fazer e não por que nossos clientes precisam deles.

Certifique-se de mostrar aos usuários como realizar tarefas com seu produto.

Naturalmente, isso envolverá recursos do produto, mas destaque-os no contexto de ajudar o usuário a entender o motivo pelo qual comprou seu produto em primeiro lugar – para resolver um problema específico.

Por exemplo, nossos tutoriais Camtasia e Snagit (sim, vídeos tutoriais podem ser uma forma de documentação) destacam recursos específicos, mas fazem isso no contexto de por que alguém pode usar esse recurso específico. É sobre o porquê, não apenas o como.

Aqui está um ótimo exemplo…

Hierarquia lógica e fluxo

Uma boa documentação precisa de uma hierarquia de títulos e subtítulos que permita ao usuário saber o que cada seção irá mostrar. E essa hierarquia deve seguir um fluxo lógico que ajude o usuário a aprender a usar seu produto da maneira mais útil.

Por exemplo, você provavelmente não quer começar sua documentação mostrando aos clientes como usar as funções mais avançadas sem primeiro mostrar a eles o básico de como seu produto funciona. Comece com as coisas fáceis primeiro e, à medida que seus usuários constroem seus conhecimentos, mostre a eles os recursos avançados.

Índice

Um índice fornece aos seus clientes uma maneira simples, eficiente e familiar de encontrar rapidamente uma solução para sua pergunta ou problema. Está logo no início do documento, para que eles não precisem vasculhar páginas de texto para encontrar o que estão procurando. Deve incluir todos os principais títulos e subtítulos descritos acima.

Torne-o pesquisável

Houve um tempo em que a maior parte da documentação do usuário era impressa. Agora, em uma era em que quase todo mundo tem acesso a um smartphone, faz mais sentido criar documentação eletrônica. Isso não significa que você não pode criar versões impressas também, mas uma versão eletrônica oferece uma série de vantagens que discutiremos com mais detalhes abaixo.

Como um índice, o conteúdo pesquisável oferece aos usuários acesso mais fácil ao seu conteúdo e os ajuda a encontrar soluções por conta própria.

Acessibilidade

Crie conteúdo acessível. Isso significa garantir que a documentação eletrônica cumpra os padrões de acessibilidade para pessoas cegas ou deficientes visuais, surdas ou com deficiência auditiva, ou que tenham deficiências cognitivas.

Lembre-se de que muitos de seus clientes precisam disso para entender e acessar totalmente a documentação do usuário. Não os deixe para trás!

Bom design

Dê a seus usuários um documento que eles querem ver e eles estarão mais propensos a usá-lo.

Projete materiais com seus clientes em mente. Torná-lo útil e amigável. Evite longos parágrafos de texto ou páginas cheias de conteúdo. Permita que o espaço em branco ajude a quebrar a monotonia e torne a perspectiva de aprender um novo produto menos assustadora.

Inclua gráficos e imagens o máximo possível para mostrar em vez de dizer a seus clientes como usar seu produto. Para documentação eletrônica, use vídeo e GIFs.

Use fontes consistentes e cores complementares em vários documentos. Se sua organização tiver um guia de estilo (que eu recomendo criar, caso ainda não exista), certifique-se de que sua documentação esteja de acordo com ele.

Os modelos Snagit tornam incrivelmente fácil criar documentação de usuário com aparência profissional a partir de uma série de capturas de tela ou outras imagens. Basta reunir as imagens que você precisa, escolher Criar e, em seguida, Imagem do modelo, e você está no caminho certo.

O Snagit vem com vários modelos gratuitos e projetados profissionalmente e, com o TechSmith Assets for Snagit, você tem acesso a muito mais!

Feedback de usuários reais e/ou testadores beta

Você não pode criar uma documentação de usuário realmente excelente até ouvir as pessoas de fora da sua organização que realmente usam os produtos.

Aprenda seus pontos de dor e tente abordá-los da melhor maneira possível. Descubra o que eles dizem que você precisa saber para usar melhor seus produtos. Embora algumas possam parecer óbvias, garanto que você aprenderá coisas que nunca considerou.

Links para outras documentações

Certifique-se de que seus clientes tenham acesso a mais recursos de sua organização sobre como ter sucesso com seus produtos. Para documentação eletrônica do usuário, isso pode ser tão simples quanto fornecer links para tutoriais, perguntas frequentes, fóruns de usuários e muito mais.

Mas mesmo a documentação impressa pode incluir coisas como endereços de sites e números de telefone para suporte adicional.

Bônus! Adicionar instruções passo a passo

Guias passo a passo ajudam a evitar longos blocos de texto e fornecem uma maneira muito mais clara de mostrar um processo do que tentar explicá-lo apenas por meio de texto. Eles são mais fáceis de seguir, mais fáceis de entender e oferecem uma experiência muito mais amigável do que simplesmente dizer a alguém como concluir uma tarefa.

E lembre-se, incluir conteúdo visual em suas instruções passo a passo as torna ainda melhores.

O Snagit fornece uma Step Tool fácil de usar que ajuda você a criar uma excelente documentação passo a passo. Além disso, a ferramenta Combine Images permite combinar capturas de tela individuais e outras imagens em uma única imagem para facilitar a edição e a marcação.

Como criar uma ótima documentação do usuário

Etapa 1: planejar

Todo grande conjunto de documentos do usuário começa com um plano. Aqui estão algumas dicas sobre como chegar onde você quer ir.

Saiba por onde começar

Muitas pessoas assumem que, se você conhece seu produto, pode começar a criar sua documentação. Mas há muito mais que vai para ele. Em vez disso, comece com um plano para garantir que você está realmente ajudando seus usuários.

Antes de fazer a documentação, aqui estão algumas coisas a serem consideradas:

• O que você deve incluir? O que você deve deixar de fora? (Dica: é aqui que o feedback do usuário pode ser REALMENTE útil!)
• Em que ordem devemos apresentar as informações? (Lembra-se dos esboços de redação da escola? Use-os!)
• Que outros recursos estarão disponíveis? Como forneceremos acesso/links para eles?
• Quem é responsável pela criação do documento? Quem é responsável pelo feedback sobre o documento? Quem tem a aprovação final?
• Isso precisará ser traduzido ou localizado?

As respostas a essas perguntas moldam como você cria sua documentação. O planejamento garante um processo tranquilo e um melhor documento do usuário.

Conheça seu produto

Certifique-se de conhecer o seu produto.

Isso não significa que você precisa ser o especialista absoluto em tudo, mas qualquer pessoa que crie um manual do usuário ou guia do usuário deve ter experiência prática com o produto.

Confie em seus especialistas no assunto para obter um conhecimento mais aprofundado, mas você deve saber como usá-lo antes de tentar ensinar outra pessoa.

Escolha seu formato

Além disso, o formato final de um documento é igualmente importante. Será somente impressão? Será eletrônico? Se sim, onde ele vai morar?

Não faz muito tempo que quase toda a documentação do usuário era apenas impressa. No entanto, a menos que você tenha um bom motivo, recomendo pelo menos ter uma versão eletrônica disponível em seu site.

A maioria dos usuários tem acesso 24 horas por dia a smartphones, computadores ou tablets, e estão acostumados a encontrar tudo o que desejam saber sempre que quiserem. Colocar os recursos do usuário online dá a eles acesso onde quer que estejam, o que significa que eles não precisam procurar em gavetas ou armários de arquivos para encontrar um manual do usuário que não veem há anos.

Além disso, é simplesmente mais fácil tornar a documentação eletrônica acessível para pessoas com deficiência. Uma versão somente impressa funcionará para a maioria das pessoas, mas você está preparado para criar uma versão em braille para usuários cegos ou deficientes visuais? E os usuários que têm uma deficiência física onde é difícil para eles manipular objetos com as mãos?

Existem ferramentas para tornar a documentação eletrônica mais fácil de ser acessada por todos, mas as versões somente impressas apresentam um problema de acessibilidade muito mais difícil.

Além disso, a documentação eletrônica é muito mais fácil de atualizar, pois está na web.

Devo transformar minha documentação em PDF?

Se você quiser oferecer uma versão em PDF para download de sua documentação, tudo bem. Mas certifique-se de que também esteja disponível em seu site em formato não PDF.

Etapa 2: criar seu documento de usuário

Depois de responder a todas as perguntas e tomar todas as decisões descritas acima, é hora de criar a documentação do usuário. Não vou dizer como EXATAMENTE criar a documentação para seu produto específico, mas há algumas coisas importantes a serem lembradas.

• Evite jargões e termos altamente técnicos, exceto quando absolutamente necessário (e, em seguida, certifique-se de defini-los).
• Evite siglas, a menos que você explique o que elas significam.
• Use um estilo de escrita comumente reconhecido, como AP ou Chicago, sempre que possível. Se sua organização tiver um guia de estilo da empresa, use-o.
• Não presuma que o usuário sabe alguma coisa sobre seu produto ou o que ele faz. MOSTRE a eles o que eles precisam saber para serem bem-sucedidos.
• Lembre-se de usar linguagem simples. Escreva para um nível de oitava série ou abaixo. Mesmo para leitores avançados, a linguagem simples leva a um processamento mais rápido e melhor compreensão.
• O design deve ser agradável, não intimidador e atrair o usuário. Faça-o QUERER usar sua documentação.

Passo 3: Teste

Um guia do usuário só é ótimo se ajudar seus clientes a usar seu produto da melhor maneira possível. E você não pode saber disso até que alguém o use. Antes de sua nova criação sair para o mundo em geral, você quer testá-la. Aqui estão algumas dicas!

• Prática recomendada: forneça a um grupo de usuários reais ou testadores beta e veja como eles se saem. Incorpore seus comentários no documento finalizado.
• Se você não tiver feedback do usuário do teste beta, teste-o internamente, de preferência com funcionários menos familiarizados com o produto.
• Obtenha feedback dos desenvolvedores e engenheiros. Eles conhecem o produto melhor do que ninguém e podem apontar coisas que você pode ter perdido.

Etapa 4: mantenha sua documentação atualizada

Quando seu produto for alterado, você precisará manter a documentação do usuário atualizada. Como observado acima, isso dá à documentação eletrônica uma enorme vantagem sobre a impressão. No entanto, mesmo documentos impressos podem ser atualizados e disponibilizados para download em seu site.

Lembre-se, seu conteúdo só é ótimo se for preciso. Certifique-se de que o que você oferece a seus clientes realmente os ajuda a usar seu produto.

Resumo

Se você não se lembrar de mais nada, lembre-se de que uma ótima documentação do usuário deve ser criada, projetada e apresentada da maneira mais útil para seus usuários .

Forneça a eles uma documentação que continue a encantá-los e forneça o tipo de experiência do cliente que você deseja ter.

Torne sua documentação acessível, útil e visual.

Faça perguntas frequentes