Como criar um Guia do Utilizador em 2021

Avatar of Author
Tal F
on May 04, 2021 · · filed under Documentação do produto Gestão de produtos Portais de documentação Actualizações de produtos Melhores Práticas
Guia simples passo a passo

Por isso, decidiu finalmente escrever um novo guia do utilizador sobre o seu fantástico produto.

O que se vem a perceber em 2021, é que a criação de um guia do utilizador é ainda, na sua maioria, um processo manual. Obtém-se a próxima melhor aplicação para criar o seu guia do utilizador e começar a reunir o conteúdo.

Então como se começa, porque se começa, porque se precisa mesmo de um guia do utilizador (duh...)? Tentarei responder a algumas das perguntas comuns sobre a criação de guias de utilizador, bem como guiá-lo para o ajudar a criar o seu primeiro guia de utilizador em Docsie, mas pode literalmente usar qualquer outra ferramenta...

Razões e benefícios para criar um guia do utilizador

Há muitas razões para criar guias do utilizador. Os guias do utilizador são extremamente úteis e desempenham um papel crucial no mundo dos consumidores, electrónica, programas de software e todas as facetas de produtos tangíveis ou intangíveis. Os guias do utilizador fornecem aos seus utilizadores instruções simples, passo a passo, sobre como utilizar e/ou montar os produtos.

Os seus clientes precisam de ser instruídos sobre os produtos que está a vender, serviços que está a fornecer ou métodos e procedimentos que devem seguir. Eles oferecem um processo passo-a-passo no qual os seus clientes podem aprender a utilizar, e educar-se sobre as diferentes características e funções do seu produto.

A criação de guias de utilizador adequados limita a responsabilidade legal dos produtos:

Os guias do utilizador também limitam as responsabilidades de utilização incorrecta dos seus produtos. Um guia do utilizador é muito útil para produtos que possam causar potenciais lesões ou mesmo a morte como resultado de não utilização ou montagem adequadas do produto. Por exemplo: dispositivos de alta tensão, aparelhos geradores de incêndio e até lasers requerem manuais extensos para proteger o cliente de utilização indevida.

Criar bons guias do utilizador poupa tempo:

Manuais de utilizador de boa qualidade partilham instruções sobre como utilizar os seus produtos que podem poupar muito tempo à sua equipa técnica, explicando coisas ou equipas de vendas a fazer demonstrações. Muitos produtos de software complicados requerem bons guias técnicos do utilizador para ajudar os seus clientes a aprender a utilizar os seus produtos com o maior potencial. Os softwares são normalmente bombardeados por muitas características e ter a quantidade certa de guias do utilizador para abastecer o cliente com informações úteis pode ajudar a longo prazo a reter clientes e poupar tempo a explicar como vários aspectos do software e produtos complicados devem ser utilizados.

Educar os seus clientes sobre os usos dos seus produtos:

A educação dos clientes sobre produtos técnicos é muito importante. Sem guias de utilizador adequados, os seus clientes podem ser confundidos por uma barragem de características ocultas e não saberem como utilizar todo o potencial do produto técnico. Os guias de utilizador permitem um processo fácil no qual os seus clientes podem aprender a envolver-se nos vários aspectos técnicos do seu produto e sentir-se à vontade para ter um guia de utilizador à mão quando precisarem de se aprofundar nos seus produtos. Tirará-lhes o stress de tentarem perceber as coisas sem uma orientação escrita formal. Também para produtos perigosos, os guias do utilizador podem fornecer avisos contra a utilização indevida de produtos de uma forma perigosa.

O que faz um grande guia do utilizador

Assim, para começar a fazer um guia do utilizador, é necessário compreender que problema está a tentar ajudar a resolver para um cliente específico. Fazer um guia do utilizador para tudo sobre tudo transforma-o numa confusão incompreensível que ninguém irá compreender, incluindo o seu público alvo. Se olhar para alguns dos melhores exemplos de guias do utilizador online, escritos por empresas super-estrelas como Stripe ou Slack. Notará um padrão particular.

Cada guia do utilizador centra-se na resolução de um problema particular.

Então, o que deve fazer cada guia? Deve concentrar-se em acções simples que o seu utilizador possa realizar enquanto segue este guia. Não há necessidade de complicação. Pelo contrário, se se concentrar em abordar acções simples comuns que ajudem os seus utilizadores a resolver problemas simples comuns com o seu produto, chegará a ter um conjunto de guias de utilizador surpreendentes que os seus clientes irão adorar.

Portanto, vamos analisar atentamente alguns guias de utilizador para compreender o que é uma estrutura de um guia de utilizador espantoso, para que possamos tomar isso como ponto de referência sobre como podemos nós próprios escrever um guia de utilizador espantoso.

Então o que vai para um grande guia do utilizador?

Vejamos o guia do Livro de Gestão acima e encontremos alguns pontos de

Organizando os seus guias de utilizador

Utilizar o Docsie para criar guias do utilizador*

Docsie tem várias ferramentas e características que lhe permitem fazer guias de utilizador fantásticos. Em primeiro lugar, vamos dar uma vista de olhos à forma como Docsie funciona. Docsie funciona sob a premissa de livros, prateleiras e colecções.

As colecções são utilizadas para isolar vários livros que se pretende mostrar a diferentes tipos de clientes. Por exemplo, esta colecção é utilizada para mostrar apenas utilizadores empresariais. Isto significa que seleccionámos apenas 3 livros de todos os livros criados para mostrar estes clientes específicos.

Isto é útil quando se tem vários tipos diferentes de clientes com os quais se estão a utilizar diferentes rasgos dos seus produtos. Isto é feito sem problemas no Docsie, clicando nos três pontos ao lado de "Todos" e pressionando adicionar.

Assim que estiver na barra de ferramentas Docsies Collection pode criar o nome da sua colecção e também escolher os guias de utilizador que pretende nesta colecção específica. A razão pela qual isto é importante é porque diferentes clientes podem precisar de conhecer diferentes guias de utilizador dos seus produtos e esta ferramenta permite-lhe mostrar apenas os guias de utilizador específicos que precisam de ver.

Agora vamos começar a escrever o seu primeiro guia do utilizador com Docsie, isto é feito com Docsies "Book".

Pense num livro como o seu guia ou manual do utilizador. Dentro do seu livro aberto verá o Editor, um lugar para criar 'Artigos' e Cabeçalhos.

O editor no topo, a capacidade de criar várias versões e línguas no canto superior esquerdo e, claro, "Artigos e secções de subtítulos à esquerda.

O editor é simples de usar, permite adicionar vídeos, imagens e código com o nosso processo simples de arrastar e largar. Também lhe permite estilizar o seu conteudo como achar melhor.

Os artigos são realmente fáceis de criar; basta escrever o seu título. Neste caso o tipo é "O que é Docsie" mas pode digitar o que desejar para o título do seu Guia do Utilizador.

Para criar subsecções nos seus guias de utilizador que aparecerão como 1.1,1.2...ext basta seleccionar a localização do seu texto e definir o texto como 'Cabeçalho', isto é feito clicando no H no separador do editor.

Docsie também lhe permite criar várias versões e línguas dos seus guias de utilizador. Isto é muito útil e útil para a localização e para falar sobre várias alterações dos seus guias de utilizador de produtos.

Depois de ter preparado os seus guias de utilização, escreva-os, estilize-os com fotografias que ajudem a explicar os vários aspectos dos seus produtos e características, o passo seguinte é a publicação.

Para resumir, aqui estão as Dicas e Truques para a Criação de um Guia do Utilizador

A maioria do software e dos produtos técnicos são muito complexos e multifacetados. Para abordar esta questão ao criar um guia do utilizador para produtos complexos, é uma boa ideia quebrar a informação e instrução em partes mais pequenas. Essencialmente, criar vários pequenos guias do utilizador e compilá-los num manual de configuração do guia do utilizador

Os seus clientes não estão familiarizados com o seu produto e/ou serviço. Quanto mais técnico for o seu produto, mais descritivos deverão ser os seus guias de utilização na fase de criação. Palavras e fraseologia vagas não serão o seu amigo neste processo. Seja o mais específico possível para que o seu cliente possa compreender até os aspectos mais correctores do seu produto.

Uma imagem vale mais de mil palavras. Isto é verdade, especialmente ou guias e manuais do utilizador. Este passo é altamente negligenciado pela maioria das empresas, mas ter as fotografias ou instantâneos certos das características e aspectos do seu produto enquanto os explica nos seus guias de utilização é muito importante. Desta forma, o seu cliente pode compreender a que aspectos do seu produto se está a referir.

Os seus guias de utilizador são concebidos para ajudar os seus clientes a compreender as várias utilizações dos seus produtos. Explique as coisas da forma mais simples possível, para que possam compreender facilmente as suas várias características e aspectos.


Subscribe to the newsletter

Stay up to date with our latest news and products