Como Criar um Manual do Usuário

Os manuais do usuário são guias escritos – que podem ser disponibilizados impressos ou digitalmente – que fornecem instruções sobre como fazer algo ou utilizar algum produto. Apesar do termo "guia de usuário" ser associado aos manuais de softwares, os manuais do usuário também acompanham computadores e outros dispositivos eletrônicos como televisões, rádios, telefones e mp3 players, além de utensílios domésticos e equipamentos de jardinagem. Um bom manual educa os usuários quanto às funções do produto ao mesmo tempo em que os ensina a utilizá-las de modo eficiente, tendo tudo explicado de modo simples. A seguir você encontrará coisas a se considerar ao se criar um manual do usuário, do conteúdo ao layout.

Parte 1

Parte 1 de 3:

Criando a documentação de usuário adequada

Baixe em PDF

1
Defina quem será o usuário. Para escrever um bom manual, você precisa desenvolver o perfil do usuário alvo, seja formalmente – ao criar um perfil escrito – ou informalmente – ao separar um tempo para identificar as características dos prováveis usuários do produto. Esse perfil é útil quando você faz parte de uma equipe escrevendo a documentação do usuário, além de ajudá-lo a levar o produto do conceito à forma final. Ao formar um perfil de usuário, pense em:
- Onde os usuários utilizarão o guia, seja em casa, no escritório, em um ambiente de trabalho isolado ou no carro. Isso pode determinar não apenas o conteúdo, mas o estilo do manual.
- Como os usuários utilizarão o guia. Caso o manual deva ser consultado sem muita frequência ou servir apenas como forma de pesquisa, ele deve assumir a forma de um documento de referência. Caso ele seja algo que os usuários consultarão frequentemente desde o início, a seção de referências deve ser acompanhada por uma seção "Começando" e por instruções das funções mais comuns do produto.
- Na experiência que os usuários já possuem com o produto e outros semelhantes. Caso seu produto seja novo ou muito diferente dos concorrentes similares, é necessário explicar as diferenças e incluir instruções sobre como começar o uso. Caso o produto lide com algo que os usuários normalmente enfrentam problemas, como alguns softwares de computador, você precisará disponibilizar informações adequadas e detalhá-las de modo compreensível.
2
Escreva as necessidades do usuário de modo que ele possa compreendê-lo. A menos que o usuário possua um conhecimento técnico, é melhor evitar a linguagem técnica, sempre optando por explicações simples e claras. O texto deve ser organizado de modo a imitar o pensamento dos usuários; listar as opções agrupadas por função faz mais sentido do que listá-las de acordo com a frequência de uso, por exemplo.
- Muitas vezes não há como fugir dos termos técnicos, como ao escrever um manual para um software criador de gráficos que inclua gráficos Fibonacci em conjunto com outros gráficos mais comuns. Nesse caso, é útil definir os termos e disponibilizar algum tipo de background, como uma explicação do que são os gráficos Fibonacci e quais seus usos em analises financeiras.
3
Explique o problema que o usuário está tentando solucionar e apresente a solução. Oferecer uma opção como solução ao problema geral é algo que funciona na divulgação do produto, mas após a compra o usuário precisará aprender a colocar o produto em uso. Identifique problemas específicos que a pessoa enfrentará, explique-os no manual e conclua com as instruções para solucioná-los.
- Caso o problema seja complexo, divida-o em partes menores. Liste as instruções e as soluções em sequência. Dividir as informações desse modo é um método conhecido como "fragmentação".
Publicidade

Parte 2

Parte 2 de 3:

Compreendendo os componentes de um manual do usuário

Baixe em PDF

1
Inclua a capa e as páginas de título. Você precisará de uma capa para qualquer manual que não seja um simples cartão de referência e uma página de título para qualquer manual que seja mais do que uma folha de papel dobrado.
- Caso o manual seja protegido por direitos autorais, o aviso deve ser inserido na capa e nas páginas de título.
- Caso haja termos e condições para utilizar o manual e o produto associado a ele, coloque-os na parte interna da capa.
Caso a documentação não esteja apenas o manual, referencie os documentos que possuam as versões atuais aqui. Você também inserirá a seção "Como utilizar esse guia", se houver uma, no prefácio.
4
Coloque instruções/procedimentos e materiais de referência no corpo do manual. Na maioria dos casos, esses itens devem possui seções próprias, mas é possível instruir o leitor a consultar um conteúdo específico de uma seção na outra. Desse modo, o usuário é capaz de encontrar a informação procurada mais rapidamente.
- Os procedimentos devem ser escritos com uma estrutura consistente dentro da seção de instruções do manual. Comece com uma visão geral da tarefa e então descreva o que o usuário deve fazer e qual o resultado que deve ser obtido. Os passos devem ser numerados e começar com verbos de ação, assim como os passos das seções deste artigo.
- Os materiais de referência podem incluir listas de opções, dicas para solução de problemas e perguntas frequentes. Os glossários e índices também podem ser adicionados no fim do manual, apesar da lista de termos frequentes normalmente aparecer no início. O índice pode ser omitido caso o manual tenha menos de 20 folhas.
5
Utilize imagens para apoio, caso necessário. As imagens podem ilustrar algumas ideias melhor do que os textos, principalmente ao descrever procedimentos complexos onde o usuário precisa de informações visuais para verificar se que está realizando os passos corretamente. As imagens podem ser produzidas com softwares de desenho, câmeras digitais e softwares de edição de imagem (que também podem ser utilizados nos casos de captura de tela).
- Após criar a imagem, salve-a em um formato comprimido e que seja aceito pelo software onde está diagramando o manual. Reduza também o tamanho físico dela para adequá-la ao tamanho das páginas, mas sem eliminar os detalhes necessários para o usuário. Caso seja necessário, você pode dividir a imagem em partes para mostrar as porções relevantes ao lado do texto.
- Caso esteja utilizando diversas imagens, padronize o tamanho delas, seja utilizando o mesmo comprimento e largura ou reduzindo-as proporcionalmente em relação ao tamanho original. Isso fará com que elas fiquem mais atraentes para o leitor. O mesmo vale para a criação de capturas de tela de um computador, onde é necessário padronizar o esquema de cores do sistema para que todas saiam parecidas.
- Apesar dos softwares de edição, como o Photoshop e o Paint Shop Pro, oferecerem funcionalidades de captura de tela decentes, um software dedicado, como o Snaglt, também possui opções de modificar, catalogar e inserir anotações nas capturas com facilidade.
Publicidade

Parte 3

Parte 3 de 3:

Projetando um manual legível

Baixe em PDF

1
Escolha fontes legíveis. Apesar dos computadores suportarem centenas de diferentes fontes, a meta de um manual do usuário é a facilidade de leitura. Escolher um número pequeno de fontes que combinem é a melhor opção para isso. As fontes podem ser facilmente divididas em dois tipos: com serifa e sem serifa.
- As fontes com serifa possuem pequenas linhas decorativas nas pontas dos traços que compõem as letras. Esse tipo de fonte funciona melhor para blocos grandes de texto em tamanhos entre 10 e 12 no corpo de um manual impresso. Exemplos incluem fontes como Times New Roman, Baskerville e Book Antiqua.
- As fontes sem serifa possuem apenas os traços que compõem as letras, sem decorações. Essas fontes podem ser utilizadas em blocos grandes de texto em tamanhos entre 8 e 10 em manuais digitais, pois a falta das serifa dificulta a leitura em tamanhos acima de 12. Essas fontes podem, entretanto, serem utilizadas em tamanhos grandes em títulos e cabeçalhos, além de serem ótimas para notas de rodapé e números em colunas e tabelas. Exemplos incluem fontes como Arial, Calibri e Century Gothic.
- Opte por fontes comuns, como Arial ou Times New Roman, para manuais, mas escolha opções mais decorativas para citações e títulos caso esteja escrevendo um manual para um jogo de fantasia ou ficção científica. No caso das citações, você também pode manter a fonte padrão do texto, mas colocá-la em itálico.
- Após definir as fontes que utilizará, crie uma página teste para verificar se elas combinam no papel. Mostre o teste para a pessoa que tem poder de definir a aparência do manual antes de prosseguir.
2
Pense bem no layout da página. Após escolher as fontes, é necessário escolher a diagramação de tudo que vai na página.
- No geral, você deve colocar o título ou o nome do capítulo no cabeçalho ou no rodapé, podendo colocar o título do manual na página da esquerda e o título do capítulo na página da direita. Insira também os números das páginas nessas regiões, seja na lateral direita (no cabeçalho ou rodapé) ou no centro (apenas no rodapé). Você pode diferenciar a primeira página de cada seção ou capítulo colocando o número da página no centro do rodapé, enquanto as páginas subsequentes são numeradas no canto externo do cabeçalho.
- Você pode inserir textos explicativos em caixas coloridas ou sombreadas para separá-los do resto do texto. Escolha uma cor ou nível de sombreamento que não se sobreponha ao texto.
- Crie margens razoáveis em todos os lados, dando espaço extra nas bordas que serão encadernadas.
3
Considere o tipo de encadernação. Caso o manual tenha mais de quatro páginas, elas precisarão ser presas de algum modo. Os documentos internos podem ser grampeados no canto superior esquerdo das páginas, mas os manuais enviados com os produtos normalmente são encadernados com um dos três métodos abaixo:
- O grampeamento lateral é apropriado para manuais compostos por folhas de 21 x 27.5-cm, 21 x 35-cm, ou 27.5 x 42.5-cm. Os materiais mais baratos de 48 páginas ou menos são grampeados assim.
- O grampeamento na lombada é mais comum para guias de referência de terceiros do que para os manuais enviados com produtos que não sejam automóveis, apesar dos manuais mais longos serem encadernados desse modo. (O Paint Shop Pro era vendido com um guia com grampeamento na lombada quando era produzido pela JASC Software.)
- A espiral é adequada para guias que devem ser utilizados ao ar livre, onde as outras encadernações poderiam ser frágeis demais. Alguns desses manuais possuem páginas plastificadas para evitar danos causados pela água ou pela terra.
4
Crie um modelo para o manual. Diversos softwares de processamento de texto e editoração possuem uma função para criar um modelo, de modo que você digite o texto e ele seja exibido automaticamente na fonte selecionada para a porção do manual com o qual está trabalhando. (Este artigo foi escrito inicialmente utilizando um modelo do Microsoft Word.) A maioria desses programas possuem modelos pré-definidos que podem ser ajustados às suas necessidades, portanto é desnecessário criar um modelo do zero.
- Esses softwares também permitem que você crie "estilos", pré-definindo fontes e tamanhos para cabeçalhos, rodapés, títulos e corpo de texto. É possível selecionar um dos estilos definidos (como "Cabeçalho 1", "Normal", "Citação") ou criar seu próprio estilo. Siga as convenções de nomes de estilos caso possua diversas classes por texto. (Por exemplo, o Word identifica os estilos para títulos como "Título 1", "Título 2", etc. para os diversos níveis de subtítulos.) Tente criar todos os estilos que utilizará com antecedência para que não precise parar e criá-los durante o processo de escrita.
Publicidade

Dicas

Utilize variáveis de texto onde for possível. É possível atribuir valores a elas, como o nome de um produto ou o título do capítulo, e inseri-las no documento ao invés de digitar o texto em si. Ao pré-visualizar ou imprimir o manual, o texto ocupará o lugar da variável. Caso o nome do produto mude, será mais fácil alterá-lo no manual modificando a variável do que procurando por ele e substituindo-o manualmente no documento.