Como criar um manual do usuário

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

07-08-2024 |
italia |
fai da te |
Programma di scrittura o pubblicazione |
Programma di grafica o registrazione visiva |

Os manuais do usuário são guias escritos fisicamente (em papel) ou documentos eletrônicos (PDF ou XPS) que fornecem instruções sobre como fazer ou usar algo.Embora os “guias do usuário” sejam mais comumente considerados como relacionados a software de computador, os manuais do usuário também são anexados a computadores ou outros dispositivos eletrônicos, como TVs, aparelhos de som, telefones e tocadores de MP3, bem como a eletrodomésticos e equipamentos de jardim.Um bom manual do usuário informa os usuários sobre as funcionalidades do produto, ensinando também suas respectivas operações de forma eficaz e de fácil acesso.Abaixo estão os elementos a serem considerados ao criar conteúdo e layout eficazes de um manual do usuário.

Papel 1

Parte 1 de 3:

Criação de documentação amigável

Baixar PDF

1
Defina o usuário de referência. Para escrever um manual de sucesso, você precisa traçar o perfil do seu usuário, seja formal, criando um perfil escrito, ou informal, reservando um tempo para fazer suposições razoáveis sobre as características do seu usuário.Um perfil como esse é útil quando você faz parte de uma equipe que escreve documentação do usuário e também pode ser útil no processo de levar o produto da ideia à forma final.Ao escrever um perfil de usuário, os elementos a serem considerados incluem:
- Onde os usuários utilizarão o manual, em casa, no escritório, em um local de trabalho remoto ou no carro.Isto pode afetar não apenas o conteúdo, mas também o estilo do manual.
- Como os usuários usarão o guia.Se for necessário consultar o manual raramente ou procurar informações, este deverá assumir principalmente a forma de um documento de referência.Se for algo que inicialmente será consultado com frequência pelos usuários, a seção de referência deverá vir acompanhada de uma seção “Introdução” e instruções sobre os usos mais comuns do produto.
- Quanta experiência os usuários já possuem com o produto ou outros da mesma categoria.Se o seu produto for novo ou tiver diferenças substanciais em relação a produtos similares, você precisará incluir uma explicação dessas diferenças, bem como instruções sobre como começar a usá-lo.Se o produto aborda algo com o qual os usuários costumam ter problemas, como muitos aplicativos de computador, você precisará fornecer informações e detalhes adequados em um estilo compreensível.
2
Atenda às necessidades do seu usuário de uma forma que eles possam entender. A menos que o usuário tenha experiência técnica, provavelmente será melhor evitar terminologias específicas, preferindo explicações claras e simples.O texto também deverá ser organizado para acomodar o raciocínio dos usuários;Listar recursos de produtos agrupando-os por suas funções geralmente faz mais sentido do que os pedidos mais comumente usados em listas.
- Às vezes, não há como contornar os termos técnicos, como no caso de software de gráficos que inclui gráficos de Fibonacci junto com gráficos de pizza e de barras mais comuns.Em casos semelhantes, é útil definir o termo e fornecer uma explicação, por exemplo, investigando a definição e a utilidade das tabelas de Fibonacci na análise financeira.
3
Explique o problema que o usuário está tentando resolver e apresente a solução. Fornecer apenas a solução para um problema genérico funciona na fase de venda do produto, mas uma vez que o usuário o comprou, ele deve saber como utilizá-lo da melhor forma.Identifique problemas específicos que o usuário encontrará, indique-os no guia do usuário e depois siga as instruções para resolvê-los.
- Se o problema for complexo, divida-o em partes menores.Liste cada parte com instruções sobre como resolvê-la ou lidar com ela e organize-as em sucessão.Este processo é conhecido como “chunking”.
Anúncio

Papel 2

Parte 2 de 3:

Elementos de um manual do usuário

Baixar PDF

1
Inclua a capa e as páginas de título apropriadas. Você precisará de uma capa para cada guia do usuário, que consiste em mais do que apenas um cartão de referência, e capas para manuais mais longas do que uma folha de papel dobrada (4 ou mais páginas).
- Se o manual estiver protegido por direitos autorais, deverá ser especificado tanto na capa quanto na página de rosto.
- Caso necessite informar os termos e condições de uso do manual e do produto relacionado, deverá incluí-los no interior da capa.
Se a documentação do usuário abranger mais de um volume, forneça aqui referências aos outros documentos, com as versões corretas.A introdução também é a parte onde você pode inserir a seção “Como usar este guia”, se necessário.
4
Coloque instruções/métodos e materiais de referência no corpo principal do manual. Em muitos casos, cada método e material de referência deve ter sua própria seção, embora você sempre possa dizer ao usuário para referenciar conteúdo específico de uma seção para outra.Dessa forma, o usuário consegue encontrar com mais rapidez as informações que procura.
- Os métodos devem ser escritos de forma consistente em toda a seção de instruções do manual.Comece com uma visão geral da tarefa e depois descreva o que o usuário precisa fazer e quais resultados ele deve alcançar.As etapas devem ser numeradas e começar com verbos de ação, assim como as etapas de cada seção deste artigo.
- Os materiais de referência podem incluir uma lista de opções, dicas e perguntas frequentes.Glossários e apêndices podem ser adicionados no final do manual, embora uma lista de termos comumente usados possa aparecer no início.O índice pode ser omitido se o manual tiver menos de 20 páginas.
5
Use gráficos quando necessário 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 os usuários precisam de confirmação visual da execução correta.Os gráficos podem ser produzidos utilizando programas CAD ou software gráfico, edição digital e câmeras digitais, ou no caso de capturas de tela, através da função interna do computador (“stamp”/cmd+shift+3) ou de um programa gráfico que forneça a opção de gravação de tela.
- Uma vez criados os gráficos, salve-os em um formato compactado para permitir que sejam usados em programas de escrita ou publicação.Você também desejará reduzir o tamanho do arquivo para facilitar a inclusão na página sem reduzir os detalhes para o usuário (se necessário, pode ser necessário quebrar a imagem original e mostrar as partes relevantes à medida que você avança no texto) .
- Se você estiver usando vários gráficos em seus métodos, mantenha a consistência nas dimensões, sejam elas todas do mesmo comprimento e largura ou sempre reduzidas na mesma proporção do tamanho original.Isso tornará as imagens mais convidativas para o usuário.Da mesma forma, ao salvar capturas de tela em um computador, certifique-se de que o computador esteja configurado para uma cor padrão durante esta etapa, caso o manual exija que você preserve essas cores.
- Embora programas gráficos como Photoshop e Paint Shop Pro ofereçam bons recursos de salvamento de tela, programas especializados como SnagIt também permitem editar, catalogar e fixar telas com facilidade.
Anúncio

Papel 3

Parte 3 de 3:

Projetando um manual legível

Baixar PDF

1
Escolha algumas fontes legíveis. Embora os computadores possam suportar muitas fontes diferentes, o objetivo de um manual do usuário é facilitar a leitura.Escolher algumas fontes adequadas é a melhor maneira de atingir esse objetivo.Existem 2 categorias de fontes:“serif” e “sans serif” (com ou sem serifa).
- As fontes serif têm pequenas terminações nas extremidades dos traços principais das letras.As fontes serif incluem Times New Roman, Baskerville e Book Antiqua.As serifas funcionam melhor em blocos de texto grandes de 10 a 12 tamanhos no corpo principal de um manual do usuário impresso.
- As fontes sem serifa exibem apenas os traços que formam as letras sem terminações.As sans serifas incluem Arial, Calibri e Century Gothic.Essas fontes podem ser usadas para grandes blocos de texto de tamanho 8 a 10 em um manual on-line ou PDF, embora a falta de finais torne as frases de tamanho 12+ mais difíceis de ler.No entanto, eles podem ser usados de forma eficaz em tamanhos maiores para exibir títulos e cabeçalhos, e são igualmente adequados em tamanhos menores para rodapés e números em colunas ou tabelas.
- Geralmente você deve escolher fontes neutras como Arial ou Times New Roman para o seu manual do usuário, embora seja melhor optar por uma fonte decorativa no caso de citações ou títulos, se você estiver escrevendo, por exemplo, para um videogame com fantasia ou ciência configurações de ficção (no caso de trechos do mesmo texto, muitas vezes pode-se usar a mesma fonte, no formato “itálico”).
- Depois de escolher as fontes que usará, crie uma página de teste para verificar se as fontes ficam bem juntas no papel.Você também pode mostrar esta prova para qualquer pessoa que precise aprovar a aparência do manual antes de prosseguir.
2
Pense no layout. Depois de escolher as fontes do seu manual do usuário, você precisa decidir sobre o posicionamento dos vários elementos das páginas.
- Normalmente, você desejará colocar o título do manual ou do capítulo no cabeçalho ou na parte inferior da página, de preferência usando o título do manual na página esquerda e o título do capítulo à direita.Os números das páginas devem estar acima ou abaixo, para fora (cabeçalho ou rodapé) ou no centro (somente rodapé).Você pode querer distinguir a primeira página de cada seção ou capítulo das outras, colocando o número da página no centro e as subsequentes no canto externo do cabeçalho.
- Você pode desenhar partes do texto em caixas coloridas ou sombreadas, para separá-las do resto do texto.Certifique-se de escolher uma cor ou grau de sombreamento que não se sobreponha ao texto.
- Deixe margens razoavelmente largas em todos os lados, com espaço suficiente nas bordas para serem unidas.
3
Considere o tipo de encadernação do manual do usuário. Se o seu manual tiver mais de 4 páginas, elas precisarão ser encadernadas de alguma forma.Embora os documentos internos possam ser grampeados em um canto, os manuais externos entregues com o produto geralmente são encadernados de três maneiras:
- Os agrafos laterais são adequados para manuais compostos por folhas de papel dobradas nas dimensões 21x27,5cm, 21x35cm ou 27,5x42,5cm.A maioria dos manuais económicos com menos de 48 páginas são encadernados desta forma.
- A costura lateral é mais comumente usada para guias de referência externos em vez de manuais do proprietário incluídos em produtos não automotivos, embora alguns guias mais longos sejam encadernados desta forma (Paint Shop Pro inicialmente enviado com um guia encadernado por costura, quando foi produzido pela JASC Software ).
- A encadernação em espiral é adequada para guias do usuário projetados para serem mais robustos, como para ambientes externos, onde manuais grampeados ou grampeados não resistiriam.Alguns manuais encadernados em espiral também podem conter páginas laminadas para evitar que sejam danificados pelo contato com água ou lama.
4
Crie um modelo para o seu manual. Muitos programas de escrita e publicação oferecem a possibilidade de criar um documento modelo para o seu manual do usuário, para que quando você escreve, o texto apareça automaticamente na fonte desejada dentro da parte do manual em que você está trabalhando (este artigo, na verdade, foi inicialmente escrito usando um modelo do MS Word).Muitos desses programas também incluem um conjunto de modelos predefinidos que você pode modificar para atender às suas necessidades, em vez de criar um modelo do zero.
- Os programas de escrita e publicação também permitem criar “estilos”, fontes e tamanhos predefinidos para cabeçalhos, rodapés, títulos e corpos de texto.Você pode escolher um dos estilos predefinidos (como "Título1", "Normal", "Citação") ou criar seu próprio estilo personalizado com nome próprio.Tanto quanto possível, siga as convenções de nomenclatura de estilo institucional se você tiver vários estilos para o mesmo trecho de texto (por exemplo, o MS Word rotula os estilos de título como "Título1", "Título2" etc.por títulos, desde o principal até aos vários níveis de legendas).Tente criar todos os estilos necessários com antecedência, para não ter que parar de criá-los durante o processo de escrita.
Anúncio

Conselho

Faça bom uso de variáveis de código e texto sempre que possível.Você pode atribuir valores a ele, como o nome de um produto, o título de um manual ou de um capítulo, e colocá-los no documento em vez de escrever o texto propriamente dito.Ao visualizar ou imprimir um documento, o texto substituirá a variável.Se o nome do produto mudar, ou se você alterar o nome do manual ou de um capítulo, será mais fácil alterar as informações substituindo o valor da variável de texto em vez de procurá-la e substituí-la dentro do documento.

Anúncio

Coisas que você vai precisar

Programa de escrita ou publicação
Programa de gravação gráfica ou visual

Licenciado sob: CC-BY-SA