Este é Como Construir a Melhor Documentação do Usuário

as Chances são de que se os seus produtos são mais complexos do que um rolo de toalhas de papel, você cria algum tipo de documentação do usuário para ajudar as pessoas a aprender como usá-los. um manual de produtos bem elaborado e de fácil utilização ou um guia de utilizador pode significar a diferença entre uma experiência fantástica do cliente e uma experiência terrível.

e, a documentação do Usuário não é apenas para os novos usuários.,

clientes experientes também podem se referir a manuais de usuário ou guias de produtos para atualizar suas memórias sobre uma característica que eles não têm usado muitas vezes ou para resolver um problema específico que eles podem ter.

para este post, vamos focar principalmente nas melhores práticas para a criação de documentação do Usuário para produtos não-físicos, como software, mas a maioria, se não quase todas estas dicas também se aplicam ao Domínio do produto físico.

Aqui está o que você vai aprender:

• O que é a documentação do Usuário e por que é importante?como a documentação do utilizador final faz parte da experiência do cliente.,como a boa documentação do utilizador pode ajudar a aliviar a carga da sua equipa de Apoio 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 utilizador.os quatro passos para a criação de documentação que deleita os seus clientes e mantém o teste do tempo.

o que é a documentação do utilizador?

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

Estes são os materiais didáticos que ir com o seu produto para ajudar alguém a aprender a usá-lo corretamente ou — no caso de produtos físicos — até mesmo colocá-lo juntos.,se alguma vez montou uma peça de mobiliário do Ikea, utilizou a documentação do utilizador final.

mas, a documentação do utilizador assume muitas formas. jogos de vídeo vêm com manuais para dizer quais botões pressionar para atirar nos bandidos. A documentação do Software mostra-lhe o que a sua compra pode fazer e como fazê-lo.,

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

Cortadores de relva e lançadores de neve têm guias de produtos para lhe mostrar como ligar os motores e onde encher o combustível.

P > pular para baixo como fazer a documentação do utilizador

porque é que a documentação do utilizador é importante?sabe que o seu produto é óptimo. Também queres que os teus clientes saibam. A documentação do Usuário ajuda a garantir que seus clientes ou usuários realmente aprendem como tirar o máximo proveito de seu produto., se é como salvar um documento, iniciar um motor, usar uma ferramenta específica ou informações de segurança importantes, a sua documentação do utilizador final é uma parte importante da sua relação com os seus clientes.

📚 Leitura recomendada: 9 dicas para documentação impressionante do utilizador (com exemplos)

pode deleitar os seus clientes

documentação do Utilizador é fácil, certo? Quero dizer, escreve umas coisas sobre como usar o Teu produto e podes ir!não é assim tão simples.é mais do que material de “como”. Faz parte da experiência do cliente., E isso significa que também é material de marketing. eu próprio, como consumidor, experimentei guias de utilizador fantásticos e horríveis. Aposto que a maioria de vocês teve experiências semelhantes.

Um grande manual do usuário ou o guia de produtos mostra aos seus clientes que você não quer apenas se eles compram o seu produto, mas se eles têm realmente uma grande experiência fato de usá-lo. e os clientes que sentem que você se preocupa com eles além de sua carteira 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 documentação impressionante do Usuário é uma parte essencial dessa experiência pós-compra.

como a documentação do utilizador suporta a sua equipa de apoio

as pessoas contactam a sua equipa de apoio quando algo não está a funcionar, mas também ligam quando simplesmente não conseguem descobrir alguma coisa. Ter uma boa documentação de usuário ajuda sua equipe de apoio de duas maneiras principais.

1., Dá-lhes um guia de referência fácil

grande documentação do utilizador não tem apenas de ser para os clientes. Sua equipe de suporte a produtos pode usar documentação para ajudar a apoiar melhor seus clientes quando eles ligam. Quando você inclui peças essenciais, como uma tabela de conteúdo ou índice, eles podem rapidamente encontrar a informação de que precisam. E, se é um documento eletrônico pesquisável, é ainda melhor! Vamos saber mais sobre isso mais tarde no artigo.2. Reduz as chamadas

como referido acima, as pessoas costumam chamar o suporte quando não conseguem descobrir alguma coisa., Mas, se os clientes podem descobrir eles mesmos eles são muito menos propensos a precisar de Ajuda. Na verdade, mais de 70 por cento das pessoas preferem usar o site de uma empresa para ajudar, em vez de usar um telefone ou e-mail.

agora, mesmo a melhor documentação não eliminará todas estas chamadas, mas a criação de guias de usuário e manuais que são abrangentes, fáceis de entender, claros e concisos irá fazer um longo caminho para reduzir o volume global de chamadas, e-mails, chats, etc.

quais são os elementos essenciais da grande documentação do utilizador?,

apesar de cada produto ser único e exigir diferentes elementos para criar docs de usuário verdadeiramente grande, existem algumas melhores práticas de documentação do usuário final a seguir, não importa o que aconteça.,

Grande do usuário documentação deve incluir:

• linguagem Simples
• Simplicidade
• efeitos Visuais
• Um foco sobre o problema
• Uma hierarquia lógica de fluxo e
• Uma tabela de conteúdo
• Pesquisável de conteúdo
• conteúdo Acessível
• Bom design
• Comentários de usuários reais
• Links para recursos adicionais

uma linguagem Simples

Nada vai frustrar um cliente mais do que ler algo que não pode compreender. Ninguém se quer sentir burro., Fazer com que o seu cliente se sinta assim certamente não é maneira de promover uma grande experiência.Use linguagem simples e simples sempre que possível para ajudar seus clientes a entender até mesmo os conceitos mais complexos.

lembre-se, escreva para o utilizador, não para o programador.

ele soa como um sem-brainer, mas escrever em linguagem simples sobre um produto ou serviço que você sabe front-to-back é muito mais difícil do que você pode pensar. Você conhece todos os tipos de jargão, acrônimos, e outras informações “insider” que os clientes provavelmente não. é natural para você usá-lo., mas é aí que podes ter sérios problemas.

não assuma que o seu cliente saiba alguma coisa sobre o seu produto. Não assuma que eles sabem todas as palavras-chave técnicas e/ou industriais que você provavelmente usa todos os dias dentro do seu escritório. Escreve para eles.

não escreva como se fossem crianças, mas entenda que eles podem precisar de ajuda extra para realmente colocá-los ao corrente. Escreva a documentação de uma forma fácil de ler.

simplicidade

mantenha – o o mais simples possível para atingir o seu objectivo. Isto aplica-se tanto ao conteúdo do documento como à sua concepção., Blocos longos de texto e páginas apertados com conteúdo escrito e gráfico podem fazer com que os guias de usuário ou manuais se sintam intimidantes e hostis. os clientes que se sentem intimidados pelos seus materiais de Utilizador são muito mais propensos a pedir ajuda à sua equipa de apoio do que a tentar resolver as suas questões sozinhos. E é muito menos provável que tenham uma boa experiência com os clientes.

visuais, visuais, visuais

a melhor documentação do Usuário ilustra perfeitamente o adágio, “show, don’t tell.,”

conteúdo Visual, incluindo imagens, imagens anotadas, gráficos e vídeos, rapidamente mostra a alguém como o seu produto funciona. Eles não têm que ler sobre, eles podem vê-lo!pesquisas recentes de TechSmith mostram que as pessoas realmente absorvem informações visuais mais rapidamente e executam tarefas melhor quando as instruções são fornecidas com conteúdo visual ou vídeo.,

conteúdo Visual também ajuda a quebrar longos blocos de texto e pode ajudar a eliminar um monte de texto que pode fazer muitos guias do usuário e manuais sentir cansativo e desagradável.

formas populares de incluir conteúdo visual na documentação do Usuário incluem screenshots, gravações de tela, vídeos de tutoriais, e muito mais.já ouviu falar de gráficos simplificados?, Às vezes chamado de interface de usuário simplificada (ou SUI), gráficos simplificados tomam imagens de uma interface de usuário ou outros gráficos e — assim como o nome sugere — simplifica-os. Esta versão mais básica destaca a informação mais essencial enquanto reduz o texto e gráficos que não são importantes para formas mais simples.,

Então, algo parecido com isso:

Agora este aspecto:

Se eu fosse tentar mostrar a alguém como selecionar a Ligar o Dispositivo Móvel item de menu, a segunda imagem remove toda a desordem e permite que o cliente os olhos para se concentrar onde eles precisam ser.

é provável que já tenha encontrado gráficos simplificados e nem sequer tenha percebido.,

Como esta G Suite Centro de Aprendizagem:

Existem um monte de ferramentas para fora lá, mas se você está procurando um poderoso e fácil de maneiras para criar imagens e gravações de tela, Eu altamente recomendo o download de uma versão experimental gratuita do Snagit.

foco no problema a ser resolvido

cada produto resolve um problema., Mas muitas vezes, estamos tão apaixonados por nossos recursos de produto fresco, tudo que queremos fazer é destacar o que ele pode fazer em vez de por que nossos clientes precisam dele.certifique-se de mostrar aos utilizadores como executar tarefas com o seu produto.

naturalmente, isto envolverá características do produto, mas fazê — lo no contexto de ajudar o utilizador a chegar à razão pela qual comprou o 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 características específicas, mas eles fazem isso no contexto de por que alguém pode usar esse recurso. É sobre o porquê, não apenas o como.

Aqui está um grande exemplo …

hierarquia Lógica de fluxo e

Boa documentação precisa de uma hierarquia de títulos e subtítulos que permite ao usuário saber o que cada seção vai mostrar-lhes., E essa hierarquia deve seguir um fluxo lógico que ajuda o usuário a aprender a usar seu produto da forma mais útil.

por exemplo, você provavelmente não quer começar a sua documentação mostrando aos seus clientes como usar as funções mais avançadas sem primeiro mostrar-lhes o básico de como o seu produto funciona. Comece com o material fácil primeiro e, em seguida, como seus usuários construir o seu conhecimento, mostrar-lhes as características avançadas.,

tabela de conteúdos

uma tabela de conteúdos fornece aos seus clientes uma forma simples, eficiente e familiar de encontrar rapidamente uma solução para a sua questão ou problema. É bem no início do documento para que eles não tenham que vasculhar páginas de texto para encontrar o que eles estão procurando. Deve incluir todas as principais rubricas e sub-rubricas acima descritas.

Tornar pesquisáveis

houve um tempo quando a maioria da documentação do usuário foi impresso., Agora, em uma era onde quase todos têm 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 vamos entrar em mais detalhes abaixo. como uma tabela de conteúdo, o conteúdo pesquisável dá aos usuários um acesso mais fácil ao seu conteúdo e os ajuda a encontrar soluções por conta própria.

acessibilidade

criar conteúdo acessível., Isto significa garantir que a documentação electrónica adere aos padrões de acessibilidade para pessoas que possam ser cegas ou com deficiência visual, surdas ou com deficiência auditiva, ou que possam ter deficiências cognitivas.

lembre-se, muitos dos seus clientes precisam disto para compreender e aceder plenamente à sua documentação de utilizador. Não os deixes para trás!

bom design

dê aos seus utilizadores um documento que eles querem ver e eles serão mais propensos a usá-lo.materiais de Design com os seus clientes em mente. Torná-lo utilizável e amigável., Evite longos parágrafos de texto ou páginas que são embalados muito cheio de conteúdo. Permitir que o espaço branco para ajudar a quebrar a monotonia e fazer a perspectiva de aprender um novo produto menos assustador.

incluir gráficos e imagens tanto quanto possível para mostrar em vez de dizer aos seus clientes como usar o seu produto. Para documentação eletrônica, use vídeo e gifs.

Use fontes consistentes e cores complementares em vários documentos. Se a sua organização tem um guia de estilo (que eu recomendo vivamente que você deve), Certifique-se de que a sua documentação adere a ele.,

modelos Snagit torna incrivelmente fácil criar documentação profissional de usuário a partir de uma série de screenshots ou outras imagens. Basta reunir as imagens que você precisa, escolher criar e Imagem a partir de modelo e você está no seu caminho.

Snagit vem com um monte de modelos livres, profissionalmente projetados, e com recursos TechSmith para Snagit, você tem acesso a uma tonelada mais!

Feedback de usuários reais e/ou testadores beta

você não pode criar uma documentação de usuário verdadeiramente grande até que você tenha ouvido as pessoas fora de sua organização que realmente usam os produtos.,

aprenda seus pontos de dor e tente abordá-los o melhor que puder. Descubra o que eles dizem que precisam saber para melhor usar seus produtos. Embora algumas coisas possam ser óbvias, garanto-te que aprenderás coisas que nem sequer consideraste.

Links para outra documentação

certifique-se de que os seus clientes têm acesso a mais dos recursos da sua organização sobre como ser bem sucedido com os seus produtos. Para a documentação eletrônica do Usuário, isso pode ser tão simples quanto fornecer links para tutoriais, FAQs, Fóruns de usuários, e muito mais.,

mas mesmo a documentação impressa pode incluir coisas como endereços de site e números de telefone para mais suporte.bónus! Adicionar o Passo-a-passo as instruções

Passo-a-passo ajuda a evitar longos blocos de texto e fornecer uma forma mais clara para mostrar um processo do que tentar explicá-lo através do texto. Eles são mais fáceis de seguir, mais fáceis de entender, e oferecem uma experiência muito mais fácil de usar do que simplesmente dizer a alguém como completar uma tarefa.,

e lembre-se, incluindo o conteúdo visual nas suas instruções passo a passo torna-os ainda melhores.

Snagit fornece uma ferramenta passo-a-passo super-fácil de usar que o ajuda a criar uma grande documentação passo-a-passo. Além disso, a ferramenta Combinar imagens permite-lhe combinar imagens individuais e outras imagens em uma única imagem para uma edição mais fácil e marcar.

Como criar uma grande documentação do usuário

Passo 1: Plano

Cada grande conjunto de documentos do usuário começa com um plano., Aqui estão algumas dicas sobre como chegar aonde você está indo.

saber por onde começar

muitas pessoas assumem que se você conhece o seu produto, você pode apenas começar a criar a 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 documentação, aqui estão algumas coisas a considerar:

• o que você deve incluir? O que deve deixar de fora? (Dica: aqui é onde o feedback do usuário pode ser realmente útil!)
• em que ordem devemos apresentar a informação?, Lembras-te dos esboços da escola? Usa-os!)
• que outros recursos estarão disponíveis? Como vamos fornecer acesso/links para esses?quem é responsável pela criação do documento? Quem é responsável pelo feedback sobre o documento? Quem tem a aprovação final?isto terá de ser traduzido ou localizado?

as respostas a essas perguntas moldam a forma como você cria a sua documentação. O planejamento garante um processo suave e um melhor documento de usuário.

Conheça o seu produto

certifique-se que conhece o seu produto.,

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

confie em seus especialistas em matéria de assunto para o conhecimento mais profundo, com certeza, mas você deve saber como usá-lo você mesmo antes de tentar ensinar alguém.

Escolha o seu formato

Além disso, um documento do formato final é igualmente importante. Será apenas Impressão? Será electrónico? Em caso afirmativo, onde viverá?,

não foi há muito tempo que quase toda a documentação do usuário foi impressa apenas. Mas, a menos que você tenha uma razão muito boa, eu recomendo pelo menos ter uma versão eletrônica disponível em seu site.

A maioria dos usuários tem acesso 24 horas a smartphones, computadores ou tablets, e eles estão acostumados a encontrar qualquer coisa que eles querem saber sempre que eles querem saber. Colocar recursos de usuário online dá-lhes acesso onde quer que estejam, o que significa que eles não têm que procurar através de gavetas ou armários de arquivos para encontrar um manual de usuário que eles não vêem há anos., além disso, é mais fácil tornar a documentação electrónica Acessível a pessoas com deficiência. Uma versão impressa só vai funcionar para a maioria das pessoas, mas você está preparado para criar uma versão em braille para usuários que podem ser cegos ou com problemas de visão? E os usuários que têm uma deficiência física onde é difícil para eles manipular objetos com suas mãos? existem ferramentas para facilitar o acesso à documentação electrónica, mas as versões impressas apenas fornecem um problema de acessibilidade muito mais difícil.,

Mais, a documentação eletrônica é muito mais fácil de atualizar, pois vive na web.

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

Passo 2: Crie o seu documento de utilizador

Uma vez que tenha respondido a todas as perguntas e tomado todas as decisões acima descritas, é altura de criar a sua documentação de utilizador. Eu não vou presumir dizer-lhe exatamente como criar a documentação para o seu produto específico, mas há algumas coisas-chave a ter em mente.

• Evite jargões e termos altamente técnicos, exceto quando absolutamente necessário (e, em seguida, certifique-se de defini-los).evite acrónimos a menos que explique o que significam.
• Use um estilo de escrita comummente reconhecido, como AP ou Chicago sempre que possível., Se a sua organização tem um guia de estilo da empresa, use isso.
• não assuma que o usuário sabe alguma coisa sobre o seu produto ou o que ele faz. Mostra – lhes o que precisam de saber para serem bem sucedidos.lembre-se de usar uma linguagem simples. Escreve para um nível do oitavo ano. Mesmo para os leitores avançados, a linguagem simples conduz a um processamento mais rápido e a uma melhor compreensão.
• O design deve ser agradável, não intimidante, e atrair o Usuário para dentro. Faça-os querer usar a sua documentação.,

Passo 3: testá-lo

um guia de Utilizador só é grande se ajudar os seus clientes a utilizar o seu produto da melhor forma possível. E não podes saber isso 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!

• melhores práticas: dar a um grupo de usuários reais ou testadores beta e ver como eles fazem. Incorporar o seu feedback no documento acabado.se você não tem feedback do usuário do teste beta, testá-lo internamente, de preferência com funcionários que estão menos familiarizados com o produto.,
• obtenha feedback dos desenvolvedores e engenheiros. Eles conhecem o produto melhor do que qualquer um e eles podem apontar coisas que você pode ter perdido.

Passo 4: Mantenha a sua documentação actualizada

quando o seu Produto mudar, terá de actualizar tudo. Tal como referido acima, isto dá à documentação electrónica uma enorme vantagem sobre a impressão. No entanto, mesmo documentos impressos-somente 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ê dá aos seus clientes realmente ajuda-os a usar o seu produto.,

resumo

Se não se lembrar de mais nada, tenha em mente que a grande documentação do utilizador deve ser criada, desenhada e apresentada de uma forma que seja mais útil para os seus utilizadores.

dar-lhes documentação que continua a deleitá-los e fornece o tipo de experiência do cliente que você gostaria de ter. torne a sua documentação acessível, útil e visual.

frequentemente fazer perguntas