Como Fazer um Tutorial: 12 Passos (com Imagens)

Contente

Degraus
Pontas
Necessidades

Os manuais do usuário são documentos em papel ou eletrônicos (PDF ou XPS) com instruções sobre como fazer ou usar algo. Embora os manuais do usuário sejam frequentemente chamados de manuais de software, eles também são frequentemente incluídos em computadores e outros dispositivos eletrônicos, como televisores, aparelhos de som, sistemas telefônicos e MP3 players, bem como eletrodomésticos e equipamentos de jardim. Bons manuais do usuário informam os usuários sobre os recursos de um produto e como usá-los de forma eficaz, e são organizados para serem fáceis de ler e consultar. A seguir estão algumas coisas a serem consideradas ao criar conteúdo eficaz e projetar o layout de um guia do usuário.

Degraus

Parte 1 de 3: Criando documentação de usuário útil

Imagem intitulada Criar um manual do usuário Etapa 1

1. Defina o usuário. Para escrever um guia de usuário bem-sucedido, você deve desenvolver um perfil de seu usuário, seja formalmente criando um perfil escrito ou informalmente, dedicando tempo para fazer suposições razoáveis sobre as características de seu usuário. Esse perfil é útil quando você faz parte de uma equipe que escreve a documentação do usuário e também pode ser útil ao desenvolver o produto desde o conceito até a forma final. Coisas a considerar ao desenvolver um perfil de usuário incluem:

Onde o usuário usará o manual, como em casa, no escritório, em um canteiro de obras remoto ou no carro. Isso pode determinar não apenas o conteúdo, mas também o estilo do manual do usuário.
Como os usuários usarão o manual. Se o manual for raramente consultado ou se for apenas para fins informativos, deve assumir principalmente a forma de um documento de referência. Se for algo que os usuários irão consultar com frequência no início, a seção de referência deve ser acompanhada por um "Trabalhar"-seção e instruções sobre as tarefas mais comuns para as quais o produto será usado.
Quantos usuários têm experiência com o produto ou o que os outros gostam nele. Se o seu produto for novo ou muito diferente de produtos similares, você deve incluir uma explicação de como ele é diferente de outros produtos, bem como instruções sobre como começar. Se o produto tiver recursos com os quais outros usuários costumam ter dificuldades, como vários aplicativos de computador, você deve fornecer informações e detalhes apropriados de maneira compreensível.

Imagem intitulada Criar um manual do usuário Etapa 2

2. Ao escrever, concentre-se na necessidade do usuário, de forma que o usuário possa entender. A menos que o usuário tenha experiência técnica, provavelmente é melhor evitar linguagem altamente técnica e optar por uma explicação clara e simples. O texto também deve ser organizado de forma a imitar a mentalidade do usuário; fazer uma lista de recursos do produto agrupados por recurso geralmente faz mais sentido do que agrupar os recursos mais usados.

Às vezes, você não pode deixar de usar termos técnicos, como para um aplicativo de software de geração de gráficos com gráficos de Fibonacci e os gráficos de pizza e barras mais comuns. Nesse caso, é útil definir o termo e fornecer informações básicas, como uma explicação do que são os gráficos de Fibonacci e seu uso na análise financeira.

Imagem intitulada Criar um manual do usuário Etapa 3

3. Explique o problema que o usuário está tentando resolver e, em seguida, apresente a solução. Oferecer uma função como solução para um problema comum funciona muito bem com um produto comercial, mas uma vez que o usuário tem o produto, ele quer descobrir como usá-lo. Indique problemas específicos que o usuário possa encontrar, indique-os no manual do usuário e siga as instruções para resolvê-los.

Se o problema for complexo, divida-o em pequenos pedaços. Liste cada parte com instruções sobre como consertá-la ou como lidar com ela e lide com elas uma após a outra. A quebra de informações dessa maneira é chamada de `chunking`.

Parte 2 de 3: Partes de um manual do usuário

Imagem intitulada Criar um manual do usuário Etapa 4

1. Adicione as páginas de capa e título apropriadas a ele. Você precisará de uma capa para qualquer manual que seja mais do que um cartão de referência e uma página de título para um manual que contenha mais informações do que uma folha de papel dobrada (quatro ou mais páginas).

Se o manual estiver protegido por direitos autorais, coloque um aviso de direitos autorais na capa e na página de título.
Se houver condições associadas ao uso do manual e do produto correspondente, coloque-as no interior da capa frontal.

Imagem intitulada Criar um manual do usuário Etapa 5

2. Coloque referências a documentos relacionados no prefácio. Se a documentação do usuário consistir em mais de um manual, consulte os outros documentos aqui, com os números de versão corretos. O prefácio é também o lugar onde uma possível seção "Como usar este guia" vem.

Imagem intitulada Criar um manual do usuário Etapa 6

3. Incluir um índice se o manual tiver mais de 10 páginas.

Imagem intitulada Criar um manual do usuário Etapa 7

4. Coloque as instruções/procedimentos e material de referência no centro do manual. Na maioria dos casos, todos os procedimentos e materiais de referência têm suas próprias seções, mas você pode encaminhar o usuário para um conteúdo específico de uma seção para outra. Desta forma, o usuário pode encontrar as informações que procura mais rapidamente.

Os procedimentos devem ser escritos em uma estrutura consistente nas instruções do manual. Comece com uma visão geral da tarefa e, em seguida, descreva o que o usuário deve fazer e o que ele deve perceber como resultado. As etapas devem ser numeradas e introduzidas com verbos de ação, pois as etapas estão escritas em cada seção deste artigo.

Os materiais de referência podem incluir listas de opções, dicas, soluções e perguntas frequentes. Glossários e índices podem ser incluídos aproximadamente no final do manual, embora uma lista de termos comumente usados possa ser fornecida na capa. O índice pode ser omitido se o manual tiver menos de 20 páginas.

Imagem intitulada Criar um manual do usuário Etapa 8

5. Se necessário, use imagens para apoiar o texto. Gráficos ou capturas de tela podem ilustrar melhor certos pontos do manual do que texto, especialmente em procedimentos complexos onde o usuário precisa de confirmação visual de que as etapas foram executadas corretamente. Os gráficos podem ser produzidos usando software de design ou software gráfico, câmeras digitais e software de edição de fotos ou, no caso de capturas de tela, capturadas usando o recurso de captura de tela do seu PC ou um programa gráfico.

Depois de criar uma imagem gráfica, você pode salvá-la em um formato compactado adequado para seu processador de texto ou programa DTP. Você também vai querer reduzir o tamanho físico da imagem para torná-la um pouco mais fácil de encaixar na página, sem sacrificar os detalhes. (Se necessário, você pode dividir a imagem original em partes e exibir as partes relevantes, juntamente com o texto de apoio.)

Se você usar vários gráficos em procedimentos, faça com que eles tenham um tamanho consistente, com as mesmas medidas de comprimento e largura ou reduzidos da mesma maneira. Isso tornará as imagens mais atraentes para o usuário. Além disso, ao fazer capturas de tela, verifique se o computador usa um esquema de cores padrão ao capturar imagens, se o manual do usuário exibir capturas de tela coloridas.

Enquanto os programas de edição de gráficos como o Photoshop e o Paint Shop Pro oferecem a capacidade de fazer uma captura de tela, programas específicos como o SnagIt oferecem a capacidade de modificar, catalogar e legendar imagens facilmente.

Parte 3 de 3: Crie um guia do usuário legível

Imagem intitulada Criar um manual do usuário Etapa 9

1. Escolha algumas fontes legíveis. Embora os computadores possam suportar várias fontes diferentes, o objetivo de um guia do usuário é ser fácil de ler. Escolher apenas um pequeno número de fontes que funcionem bem juntas é a melhor maneira de atingir esse objetivo. As fontes podem ser divididas em 2 tipos: serif (serif) e sans serif (sans serif).

As fontes com serifa apresentam pequenos enfeites nas extremidades das linhas principais que compõem a letra. As fontes com serifa incluem fontes como Times New Roman, Baskerville e Book Antiqua. As fontes com serifa são mais adequadas para grandes pedaços de texto em tamanho de fonte de 10 a 12 no corpo principal de um manual impresso.
As fontes sem serifa exibem apenas as linhas que compõem as letras, sem embelezamento. As fontes sem serifa incluem fontes como Arial, Calibri e Century Gothic. As fontes sans serif podem ser usadas para grandes pedaços de texto em tamanhos de 8 a 10 pontos em um PDF ou manual online, embora a falta de sans serifs exibidas em 12 pontos ou maiores torne a leitura mais difícil. No entanto, eles podem ser eficazes em um tamanho maior para exibir títulos e cabeçalhos, e também são ótimos em tamanhos menores para notas de rodapé e números nas colunas e tabelas.
Em geral, use fontes regulares como Arial ou Times New Roman para seu manual do usuário, embora você possa usar uma fonte decorativa para citações ou títulos importantes, ao escrever um manual para um jogo de fantasia ou sf. (No caso de citações atraentes, muitas vezes você pode usar uma das fontes simples e a citação atraente fica em itálico.)
Depois de escolher certas fontes para usar, crie uma página de amostra no papel para verificar se as fontes combinam bem. Você também vai querer mostrar este exemplo para quem tiver que aprovar o manual antes de continuar a escrevê-lo.

Imagem intitulada Criar um manual do usuário Etapa 10

2. Preste atenção no layout. Depois de escolher uma das fontes do manual, você terá que decidir onde colocar tudo nas páginas.

Em geral, você coloca o título ou título do capítulo no cabeçalho ou rodapé, possivelmente com o título na página esquerda e o título do capítulo na página direita. Coloque também os números de página no cabeçalho ou rodapé, perto da borda (cabeçalho ou rodapé) ou no centro (somente no rodapé). Você pode fazer com que cada primeira página de uma seção ou capítulo seja diferente das outras páginas colocando o número da página correspondente no centro inferior da página e as outras páginas no canto superior da página.

Você pode querer indicar o texto explicativo em caixas coloridas ou sombreadas para distingui-lo do resto do texto. Escolha uma cor ou nível de sombreamento sem comprometer a legibilidade.

Opte por margens bastante amplas em todos os lados, com espaço extra nas bordas que serão unidas.

Imagem intitulada Criar um manual do usuário Etapa 11

3. Pense no tipo de encadernação para o manual do usuário. Se o seu guia do usuário tiver mais de 4 páginas, as páginas precisam ser unidas de alguma forma. Embora um grampo no canto possa ser suficiente para documentos internos, os guias de usuário externos que acompanham um produto geralmente são encadernados de 3 maneiras:

O grampeamento é adequado para manuais compostos por folhas de papel dobradas: 21 x 27,5 cm, 21 x 35 cm ou 27,5 x 42,5 cm. Os manuais produzidos a baixo custo de 48 páginas ou menos são agrupados desta forma.

O ponto de sela é mais comumente usado para guias de referência de terceiros do que para manuais do proprietário incluídos em produtos não automotivos, embora alguns manuais do proprietário mais abrangentes sejam encadernados dessa maneira. (Paint Shop Pro originalmente veio com um manual do usuário encadernado em grampeamento quando foi publicado pela JASC Software.)

A encadernação espiral é adequada para os manuais do proprietário projetados para serem usados em ambientes mais agressivos, como ao ar livre, onde os manuais grampeados ou grampeados se desfazem. Alguns manuais encadernados em espiral têm páginas laminadas para evitar que quebrem se o manual ficar molhado ou enlameado.

Imagem intitulada Criar um manual do usuário Etapa 12

4. Crie um documento modelo para o seu manual. Muitos programas de processamento de texto e editoração eletrônica permitem que você crie um documento modelo para seu manual do usuário para que, conforme você digita, o texto apareça automaticamente na fonte selecionada para a parte do manual em que está trabalhando. (Na verdade, este artigo foi escrito inicialmente usando um modelo do Microsoft Word.) A maioria desses programas também inclui uma coleção de modelos predefinidos que você pode personalizar para atender às suas necessidades, em vez de criar o modelo do zero.

Processadores de texto e programas de editoração eletrônica também oferecem a capacidade de criar "estilos", fontes predefinidas e formatos para cabeçalhos, rodapés, cabeçalhos e texto simples. Você pode escolher um dos nomes dos estilos predefinidos (por exemplo, `Head1`, `Normal`, `Quote`) ou criar um estilo personalizado com seu próprio nome. Tente seguir as convenções dos nomes de estilo existentes tanto quanto possível, se você usar vários estilos para a mesma classe de texto. (Por exemplo, o Microsoft Word rotula estilos de texto de cabeçalho como `Título1`, `Título2` etc., do título principal aos diferentes níveis de subtítulos.) Tente pré-criar todos os estilos para não precisar interromper o processo de escrita para criá-los novamente.

Pontas

Sempre que possível, use códigos de campo ou variáveis de texto. Você pode atribuir valores aos códigos de campo, como o nome de um produto, o manual ou o título de um capítulo, e colocá-los dentro do seu documento, em vez do texto a ser mencionado. Quando você visualiza ou imprime o manual, a variável é substituída pelo texto. Se o nome do produto for alterado ou se você alterar o nome do manual ou de um capítulo, é mais fácil alterar as informações ajustando o valor da variável de texto do que pesquisando e substituindo.