Manuais

A manual, como estamos definindo aqui, é uma combinação do seguinte:

• informação conceito
• instrução informação
• informação de referência

tudo focado em um tópico específico para as necessidades de um público específico. Se você está fazendo um curso de escrita técnica usando este livro, seu projeto de manual deve inclua de alguma forma ou maneira cada um desses três elementos. Além disso, esses elementos devem se encaixar de forma natural e lógica no seu projeto de manual.

Certifique-se de conferir o exemplos.

Infográfico gerado pelo NotebookLM deste capítulo.

Fundamentos do Manual

Conceitos. Informação conceitual explica como as coisas funcionam, como as coisas são montadas. Para instruções mais complexas, você precisa conhecer alguns conceitos, teoria, histórico, princípios para executar as instruções. Considere o exemplo da função de software que permite modificar ou criar sua própria cor. Usar algo como Photoshop, Illustrator, CorelDraw ou Paint Shop Pro para fazer isso—os botões e sliders— é fácil. Mas entender como matiz, intensidade, brilho, saturação, densidade, contraste, RGB—isso é difícil. Você precisa conhecer a teoria das cores do computador para criar a cor que você precisa.

Considere outro exemplo: comandos simples de sistema de arquivos Linux—ls, cd, cp, mv, pwd. Para usar esses comandos, você precisa entender o que são arquivos e diretórios, e provavelmente o que é um sistema operacional, assim como curingas. Você realmente não pode entender como usar esses comandos—seguir instruções usando-os—a menos que você compreenda esses conceitos básicos.

Instruções. Se você entender os conceitos fundamentais, então poderá seguir inteligentemente os procedimentos passo a passo. Instruções são aquelas coisas familiares em forma de lista numerada que o guiam cuidadosamente através de um procedimento. Instruções estão em toda parte, nas embalagens de produtos, nos manuais de usuário que acompanham aparelhos e computadores.

Referência. A última categoria de informação envolve informações de consulta, ou informações de referência rápida. Se você seguiu o exemplo do sistema de arquivos acima, precisou estudar e aprender os conceitos de arquivos, diretório e curingas primeiro. Então você poderia seguir e entender as instruções sobre como mudar de diretório, copiar, deletar ou mover arquivos. Após um tempo, porém, você não precisa mais das instruções, mas de vez em quando tem requisitos especiais que não são abordados na seção de instruções ou não consegue se lembrar de certos procedimentos que foram abordados na seção de instruções. Agora é a hora em que você precisa de informações de referência básicas: você apenas vai para essa seção e rapidamente consulta.

E assim, depois de mais tempo, você não precisa mais da seção de conceitos ou da seção de instruções: você se acostumou tanto a esses procedimentos que os sabe de cor. Mas de vez em quando você esquece algum pequeno detalhe ou tem alguma tarefa especial que nunca fez antes — é quando você vai para a seção de referência. Você provavelmente poderia rasgar as seções de conceitos e instruções e jogá-las fora. Tudo o que você vai precisar é da seção de referência.

Formato e Estilo do Manual

Em um curso de redação técnica usando este livro, pode-se esperar que você utilize as diretrizes específicas para o uso de títulos, listas, avisos, gráficos, tabelas, documentação e introduções:

Prototipo do manual. A partir do link abaixo, você pode obter uma versão básica do manual. Ela inclui todas as páginas necessárias em um bom formato. Incluídos neste documento Word estão estilos de parágrafo e de caractere que facilitarão seu trabalho e adicionarão algumas habilidades profissionais ao seu repertório.

Protótipo do manual

Protótipo de conteúdos. O protótipo para o índice é particularmente útil: ele fornece os estilos do Word para produzir um índice com aparência profissional. É difícil acertar os alinhamentos à esquerda e à direita e os pontos de guia:

Protótipo do índice

Exemplos de Manual

Aqui estão alguns links para exemplos de manuais. Esteja ciente de que existem alguns problemas nos exemplos, problemas que, na sua maioria, comentei. Alguns deles são manuais limítrofes. O que torna um manual valioso para mim é a presença de discussão conceitual, instruções e informações de referência.

Não se esqueça de conferir o exemplos.

Prompts de IA para Manuais

Listas de verificação, que normalmente são ignoradas, podem ser usadas como fonte de prompts para IA com algumas modificações. Copie o seguinte, cole em um sistema de IA como o Gemini do Google e veja o que você pode ter perdido.

Nota: Todas as referências ao conteúdo, formato, estilo dos techdocs ou seus componentes podem ser encontradas no livro-texto de redação técnica online.

em breve!

Eu apreciaria suas opiniões, reações, críticas em relação a este capítulo: sua resposta—David McMurrey.