Guia Simples Passo a Passo¶

Então finalmente decidiste escrever um novo manual de utilizador sobre o teu produto incrível.

O que se percebe em 2021 é que criar um manual de utilizador continua a ser maioritariamente um processo manual. Escolhes a melhor aplicação disponível para criar o teu manual e começas a organizar o conteúdo.

Mas como começar, porque começar, porque precisas sequer de um manual de utilizador (óbvio...)? Vou tentar responder a algumas questões comuns sobre a criação de manuais, bem como orientar-te na criação do teu primeiro manual no Docsie, embora possas usar qualquer outra ferramenta...

Razões e Benefícios para criar um manual de utilizador¶

Existem muitas razões para criar manuais de utilizador. Estes são extremamente úteis e desempenham um papel crucial no mundo dos consumidores, eletrónica, programas de software e em todos os aspetos de produtos tangíveis ou intangíveis. Os manuais fornecem aos utilizadores instruções simples e passo a passo sobre como usar e/ou montar os produtos.

Os teus clientes precisam de conhecer os produtos que vendes, os serviços que prestas ou os métodos e procedimentos que devem seguir. Os manuais oferecem um processo detalhado no qual os clientes podem aprender a usar e conhecer as diferentes funcionalidades do teu produto.

Criar manuais adequados limita a responsabilidade legal dos produtos:¶

Os manuais também limitam a responsabilidade pelo uso incorreto dos produtos. Um manual é muito útil para produtos que podem causar potenciais ferimentos ou até morte como resultado do uso ou montagem inadequados. Por exemplo: dispositivos de alta tensão, aparelhos que geram fogo e até lasers requerem manuais extensos para proteger o cliente contra uso indevido.

Criar bons manuais poupa tempo:¶

Manuais de boa qualidade partilham instruções sobre como usar os produtos, o que pode poupar muito tempo à tua equipa técnica a explicar coisas ou às equipas de vendas a fazer demonstrações. Muitos produtos de software complexos necessitam de bons manuais técnicos para ajudar os clientes a aprenderem a usar os produtos com o maior potencial. Os softwares normalmente estão repletos de funcionalidades e ter a quantidade certa de manuais para fornecer informações úteis pode ajudar a longo prazo a reter clientes e poupar tempo em explicações sobre os vários aspetos do software e produtos complexos.

Educar os clientes sobre as utilizações dos produtos:¶

Educar os clientes sobre produtos técnicos é muito importante. Sem manuais adequados, os clientes podem ficar confusos com uma série de funcionalidades escondidas e não saber como aproveitar todo o potencial do produto técnico. Os manuais permitem um processo fácil no qual os clientes podem aprender a lidar com os vários aspetos técnicos do produto e sentirem-se confortáveis por terem um guia à mão quando precisam de aprofundar conhecimentos. Isto alivia o stress de tentarem descobrir as coisas sem orientação formal escrita. Além disso, para produtos perigosos, os manuais podem fornecer avisos contra o uso indevido de forma perigosa.

O que faz um excelente manual de utilizador¶

Para começar a criar um manual, precisas de entender qual problema estás a tentar resolver para um cliente específico. Fazer um manual sobre tudo transforma-o numa confusão incompreensível que ninguém entenderá, incluindo o público-alvo. Se observares alguns dos melhores exemplos de manuais online, escritos por empresas de topo como Stripe ou Slack, notarás um padrão particular.

Cada manual concentra-se em resolver um problema específico.

O que deve fazer cada manual? Deve focar-se em ações simples que o utilizador pode realizar seguindo este guia. Não há necessidade de complicações. Pelo contrário, se te concentrares em abordar ações simples e comuns que ajudam os utilizadores a resolver problemas comuns com o teu produto, acabarás por ter um conjunto de manuais excelentes que os teus clientes vão adorar.

Vamos analisar de perto alguns manuais para entender a estrutura de um excelente manual, para que possamos usar como referência ao escrever o nosso próprio manual.

O que constitui um excelente manual?¶

Vamos analisar o guia "Managing Book" acima e identificar alguns pontos de

Organizar os teus manuais¶

Usar o Docsie para criar manuais de utilizador

O Docsie tem várias ferramentas e funcionalidades que te permitem criar manuais excelentes. Primeiro, vamos ver como o Docsie funciona. O Docsie funciona sob o conceito de livros, prateleiras e coleções.

As coleções são usadas para isolar vários livros que queres mostrar a diferentes tipos de clientes. Por exemplo, esta coleção é usada apenas para mostrar a Utilizadores Empresariais. Isto significa que selecionámos apenas 3 livros de todos os livros criados para mostrar a estes clientes específicos.

Isto é útil quando tens vários tipos diferentes de clientes que usam diferentes níveis dos teus produtos. Isto é feito facilmente no Docsie clicando nos três pontos ao lado de "All" e pressionando adicionar.

Uma vez na barra de ferramentas de Coleção do Docsie, podes criar o nome da tua coleção e também escolher quais manuais queres nesta coleção específica. Isto é importante porque diferentes clientes podem precisar de conhecer diferentes manuais dos teus produtos, e esta ferramenta permite-te mostrar apenas os manuais específicos que eles precisam de ver.

Agora vamos começar a escrever o teu primeiro manual com o Docsie, isto é feito com o "Book" do Docsie.

Pensa num livro como o teu manual de utilizador. Dentro do teu livro aberto, verás o Editor, um lugar para criar 'Artigos' e Cabeçalhos.

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

O editor é simples de usar, permite-te adicionar vídeos, imagens e código com o nosso processo simples de arrastar e largar. Também te permite estilizar o conteúdo como achares adequado.

Os artigos são muito fáceis de criar; basta digitar o título. Neste caso, o tipo é "O que é o Docsie", mas podes digitar o que quiseres para o título do teu Manual.

Para criar subsecções nos teus manuais que aparecerão como 1.1, 1.2, etc., só precisas de selecionar a localização do teu texto e definir o texto como 'Header'. Isto é feito clicando no H na barra do editor.

O Docsie também te permite criar várias versões e idiomas dos teus manuais. Isto é muito útil para localização e para falar sobre várias alterações dos manuais do teu produto.

Depois de preparares os teus manuais, escrevê-los, estilizá-los com fotos que ajudam a explicar os vários aspetos dos teus produtos e funcionalidades, o próximo passo é a publicação.

Resumindo, eis as Dicas e Truques para Criar um Manual de Utilizador¶

A maioria dos produtos de software e técnicos são muito complexos e multifacetados. Para resolver este problema na criação de um manual para produtos complexos, é boa ideia dividir a informação e as instruções em partes menores. Essencialmente, criar vários pequenos manuais e compilá-los numa configuração de manual completo.

Os teus clientes não estão familiarizados com o teu produto e/ou serviço. Quanto mais técnico for o teu produto, mais descritivos devem ser os teus manuais na fase de criação. Palavras e fraseologia vagas não serão tuas aliadas neste processo. Sê o mais específico possível para que o cliente possa compreender até os aspetos mais básicos do teu produto.

Uma imagem vale mais que mil palavras. Isto é verdade, especialmente para manuais de utilizador. Este passo é muito negligenciado pela maioria das empresas, mas ter as fotos certas ou capturas de ecrã das funcionalidades do teu produto enquanto as explicas nos manuais é muito importante. Assim, o teu cliente pode entender a que aspetos do produto te estás a referir.

Os teus manuais são projetados para ajudar os clientes a entender as várias utilizações dos teus produtos. Explica as coisas da forma mais simples possível para que possam compreender facilmente as várias funcionalidades e aspetos.