Como criar um guia do usuário em 2023

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices
Guia simples passo a passo

Então, você finalmente decidiu escrever um novo guia do usuário sobre seu incrível produto.

O que se percebe em 2021 é que a criação de um guia do usuário ainda é, em grande parte, um processo manual. Você obtém o próximo melhor aplicativo para criar seu guia do usuário e começa a reunir o conteúdo.

Então, como você começa, por que começa, por que precisa de um guia do usuário (duh...)? Tentarei responder a algumas das perguntas comuns sobre a criação de guias do usuário, bem como orientá-lo na criação do seu primeiro guia do usuário no Docsie, mas você pode literalmente usar qualquer outra ferramenta...

Razões e benefícios para criar um guia do usuário

Há muitos motivos para criar guias do usuário. Os guias do usuário são extremamente úteis e desempenham um papel crucial no mundo dos consumidores, dos eletrônicos, dos programas de software e de todas as facetas de produtos tangíveis ou intangíveis. Os guias do usuário fornecem aos seus usuários instruções simples, passo a passo, sobre como usar e/ou montar os produtos.

Seus clientes precisam ser instruídos sobre os produtos que você está vendendo, os serviços que você está prestando ou os métodos e procedimentos que eles devem seguir. Eles oferecem um processo passo a passo no qual os clientes podem aprender a usar e se instruir sobre os diferentes recursos e funções do seu produto.

A criação de guias de usuário adequados limita a responsabilidade legal dos produtos:

Os guias do usuário também limitam a responsabilidade pelo uso incorreto dos seus produtos. Um guia do usuário é muito útil para produtos que podem causar possíveis lesões ou até mesmo a morte como resultado do uso ou da montagem inadequada do produto. Por exemplo: dispositivos de alta tensão, dispositivos geradores de fogo e até mesmo lasers exigem manuais extensos para proteger o cliente contra o uso inadequado.

Criar bons guias do usuário economiza tempo:

Manuais do usuário de boa qualidade compartilham instruções sobre como usar os seus produtos, o que pode economizar muito tempo da sua equipe técnica explicando coisas ou das equipes de vendas fazendo demonstrações. Muitos produtos de software complicados exigem bons guias técnicos do usuário para ajudar os clientes a aprender a usar seus produtos com o máximo potencial. Normalmente, os softwares são bombardeados por muitos recursos, e ter a quantidade certa de guias do usuário para abastecer o cliente com informações úteis pode ajudar, a longo prazo, a reter clientes e economizar tempo na explicação de como vários aspectos do software e de produtos complicados devem ser usados.

Educar seus clientes sobre o uso de seus produtos:

Educar os clientes sobre produtos técnicos é muito importante. Sem guias de usuário adequados, os clientes podem ficar confusos com uma enxurrada de recursos ocultos e não saber como usar todo o potencial do produto técnico. Os guias do usuário permitem um processo fácil no qual os clientes podem aprender a se envolver nos vários aspectos técnicos do seu produto e se sentir confortáveis por ter um guia do usuário à mão quando precisarem se aprofundar nos seus produtos. Isso os livrará do estresse de tentar entender as coisas sem uma orientação formal por escrito. Além disso, para produtos de uso perigoso, os guias do usuário podem fornecer avisos contra o uso indevido de produtos de forma perigosa.

O que torna um guia do usuário excelente

Portanto, para começar a criar um guia do usuário, é necessário entender qual problema você está tentando ajudar a resolver para um cliente específico. A criação de um guia do usuário para tudo sobre tudo transforma-o em uma bagunça incompreensível que ninguém entenderá, inclusive seu público-alvo. Se você observar alguns dos melhores exemplos de guias do usuário on-line, escritos por empresas superestrelas como Stripe ou Slack. Você perceberá um padrão específico.

Cada guia do usuário se concentra na solução de um problema específico.

Então, o que cada guia deve fazer? Ele deve se concentrar em ações simples que o usuário pode realizar ao seguir esse guia. Não há necessidade de complicação. Pelo contrário, se você se concentrar em abordar ações simples e comuns que ajudem os usuários a resolver problemas simples e comuns com o seu produto, você terá um conjunto de guias do usuário incríveis que seus clientes vão adorar.

Portanto, vamos examinar atentamente alguns guias do usuário para entender o que é a estrutura de um guia do usuário incrível, para que possamos tomar isso como ponto de referência sobre como podemos escrever um guia do usuário incrível.

Então, o que é necessário em um ótimo guia do usuário?

Vamos dar uma olhada no guia do Managing Book acima e apresentar alguns pontos de

Organizando seus guias do usuário

**Usando o Docsie para criar guias do usuário

O Docsie tem várias ferramentas e recursos que lhe permitem criar guias de usuário incríveis. Em primeiro lugar, vamos dar uma olhada em como o Docsie funciona. O Docsie trabalha com a premissa de livros, prateleiras e coleções.

As coleções são usadas para isolar vários livros que você deseja mostrar para diferentes tipos de clientes. Por exemplo, essa coleção é usada para mostrar apenas usuários corporativos. Isso significa que selecionamos apenas 3 livros de todos os livros criados para mostrar esses clientes específicos.

Isso é útil quando você tem vários tipos diferentes de clientes que estão usando diferentes versões de seus produtos. Isso é feito sem problemas no Docsie, clicando nos três pontos ao lado de "All" (Todos) e pressionando add (adicionar).

Quando estiver na barra de ferramentas do Docsies Collection, você poderá criar o nome da sua coleção e também escolher os guias do usuário que deseja incluir nessa coleção específica. Isso é importante porque diferentes clientes podem precisar conhecer diferentes guias de usuário dos seus produtos e essa ferramenta permite que você mostre apenas os guias de usuário específicos que eles precisam ver.

Agora vamos começar a escrever seu primeiro guia do usuário com o Docsie, o que é feito com o Docsies "Book"

Pense em um livro como seu guia de usuário ou manual. No livro aberto, você verá o Editor, um local para criar "Artigos" e Cabeçalhos.

O editor na parte superior, a capacidade de criar várias versões e idiomas no canto superior esquerdo e, é claro, "Artigos e seções de subtítulos à esquerda".

O editor é simples de usar e permite que você adicione vídeos, imagens e códigos com nosso processo simples de arrastar e soltar. Além disso, ele permite que você estilize seu conteúdo como achar melhor.

Os artigos são muito fáceis de criar; basta digitar o título. Neste caso, o tipo é "What is Docsie" (O que é Docsie), mas você pode digitar o que quiser para o título do seu Guia do Usuário.

Para criar subseções nos guias do usuário, que aparecerão como 1.1,1.2...ext, basta selecionar o local do texto e definir o texto como "Cabeçalho", o que é feito clicando no H na guia do editor.

O Docsie também permite que você crie várias versões e idiomas dos seus guias do usuário. Isso é muito útil e prático para a localização e para falar sobre várias alterações nos guias do usuário do seu produto.

Depois de preparar os guias do usuário, redigi-los e estilizá-los com fotos que ajudaram a explicar os vários aspectos dos seus produtos e recursos, a próxima etapa é a publicação.

Para resumir, aqui estão as dicas e os truques para criar um guia do usuário

A maioria dos softwares e produtos técnicos é muito complexa e multifacetada. Para resolver esse problema na criação de um guia do usuário para produtos complexos, é uma boa ideia dividir as informações e instruções em partes menores. Essencialmente, criar vários pequenos guias do usuário e compilá-los em uma configuração de manual de guia do usuário

Seus clientes não estão familiarizados com seu produto e/ou serviço. Quanto mais técnico for o seu produto, mais descritivos deverão ser os guias do usuário na fase de criação. Palavras vagas e fraseologia não serão suas amigas nesse processo. Seja o mais específico possível para que seu cliente possa compreender até mesmo os aspectos mais complicados de seu produto.

Uma imagem vale mais do que mil palavras. Isso é verdade, especialmente para guias e manuais do usuário. Essa etapa é altamente negligenciada pela maioria das empresas, mas é muito importante ter as fotos ou instantâneos corretos dos recursos e aspectos do seu produto e explicá-los nos guias do usuário. Dessa forma, o cliente pode entender a que aspectos do produto você está se referindo.

Os guias do usuário foram criados para ajudar os clientes a entender os vários usos dos produtos. Explique as coisas da maneira mais simples possível para que eles possam entender facilmente seus vários recursos e aspectos.


Subscribe to the newsletter

Stay up to date with our latest news and products