Pergunta originalmente respondida no Quora em 28/08/2019
Antes de começar:
- Tem gente que tem muita dificuldade para ler e entender textos. Pense no seu público. Dependendo da situação, um manual com figuras, sem palavras pode ser a solução.
Há basicamente dois modos de criar um manual:
Criando o sumário (ou índice) primeiro
- Faça o índice constando todos os tópicos e sub tópicos na sequência que o manual deve abordar.
- Preencha cada um dos tópicos listados no índice.
Criando o sumário por último
- Escreva sobre o produto da maneira que se sentir confortável, use parágrafos e sentenças pequenas, um para cada assunto.
- Organize os parágrafos na sequência lógica que você entender melhor.
- Agrupe os parágrafos em tópicos.
- Mude o Word para o modo “Estrutura de Tópicos” (1) e configure o nível dos parágrafos na área de “Ferramentas de Estrutura de Tópicos” (2) conforme print abaixo:
- Feche o modo de exibição da estrutura de tópicos, vá para a página que você quer inserir o sumário (índice) e o insira selecionando a aba Referências (1) e clicando no ícone Sumário (2).
Considerações ao criar manuais:
- O manual deve ter capa, nome do autor nem que sejam as iniciais ou a matrícula funcional, número da versão, data da publicação e um email ou telefone para comunicar falhas.
- A primeira versão do manual, mesmo revisada, sempre será uma droga. Basta divulgar para o público geral e alguém não irá entender o que foi escrito, irão achar erros e uma nova versão deverá ser liberada.
- Peça para seu inimigo revisar o manual, é uma chance de estreitar laços profissionais e mitigar conflitos. Aceite as sugestões propostas.
- Toda figura ou gráfico devem ser numerados e referenciados no texto. Colocou uma figura ou gráfico, o texto tem que falar claramente deles. Esses elementos gráficos não podem ser um boi voando no manual. Esses elementos gráficos devem estar localizados próximos de sua explicação escrita.
- Manuais são lineares. O leitor não pode ficar trocando de páginas para entender o manual. Não fale na página 11 de um assunto abordado na página 5. Ou se junta os assuntos ou se repete o assunto.
- Não use frases negativas como: não ligue, não feche, não solte e prefira frases afirmativas como: mantenha desligado, deixe aberto, assegure que esteja fixo.
- Considere que alguns leitores irão entender melhor a frase “não deixe o motor da bomba ligado pois ele irá queimar, e outros leitores irão entender melhor a frase “para evitar que o motor da bomba queime, assegure que ele esteja desligado“. Em pontos importantes, coloque as duas frases.
- NÃO USE LETRAS GARRAFAIS, NÃO FIQUE DESTACANDO O TEXTO COM NEGRITO E NÃO FIQUE USANDO O ITÁLICO COMO SE FOSSE PIPOCA DE CINEMA. ISSO VAI DEIXAR SEU LEITOR P*** DA VIDA. QUEM É ESSE AUTOR FOLGADO QUE FICA DANDO ORDENS IDIOTAS?
- Evite usar letras em caixa alta bem como aplicar formatações em negrito e itálico constantemente. Isso polui o texto e o leitor pode fazer exatamente o contrário do que está escrito, só para desacreditar o manual. Note que acabei de colocar o texto negativo e positivo.
- Ao usar siglas, para evitar confusões, sempre explique o que elas significam. Se o manual constantemente usa a frase “Guarde o Local Bem Trancado”, tudo bem associar com a sigla “GLBT”, desde que isso seja explicado na primeira vez que a sigla for utilizada como: Guarde o Local Bem Trancado (GLBT). Considere criar um dicionário de abreviações.
- Coloque no rodapé o número das páginas no formato “Página 1 de 14”. Conforme figura abaixo, vá na aba “Layout” (1) do Word e use o recurso “Partes rápidas” (2). Escolha a opção “Campo” (3) e os campos “Page” e “NumPages” na janela que irá abrir.
- Formate a página com bordas. Isso é feito na aba “Design” (1), “Bordas de Página” (2). Configure na janela “Bordas e Sombreamento” (3) a borda da página de acordo com sua preferência.
Use quebra de seções e quebra de páginas que fica na aba “Layout” para organizar o texto e abuse do modo de exibição”Estrutura de Tópicos” que fica na aba “Exibir” para organizar o documento inteiro, incluindo o sumário.
Espero que ajude.