Manuais

Um manual, como estamos definindo aqui, é uma combinação dos seguintes:

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

tudo focado em um tópico específico para as necessidades de um público específico. Se você estiver fazendo um curso de redação 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 ser uma "ajuste" natural e lógico para o seu projeto de manual.

Infográfico gerado pelo NotebookLM deste capítulo

Noções Básicas do Manual

Conceitos. Informação conceitual explica como as coisas funcionam, como as coisas estão montadas. Para instruções mais complexas, você precisa conhecer alguns conceitos, teoria, contexto, 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 reais— é fácil. Mas entender como matiz, intensidade, brilho, saturação, densidade, contraste, RGB—isso é difícil. Você precisa conhecer a teoria das cores de computador para criar a cor que precisa.

Considere outro exemplo: comandos simples do 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, bem como curingas. Você realmente não pode entender como usar esses comandos—seguir instruções usando-os—a menos que você entenda esses conceitos básicos.

Instruções. Se você entende os conceitos fundamentais, então pode seguir de forma inteligente 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, na embalagem de produtos, em guias do usuário que vêm com eletrodomésticos 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, teve que estudar e aprender os conceitos de arquivos, diretório e curingas primeiro. Então você pôde seguir e entender as instruções sobre como mudar de diretório, copiar, deletar ou mover arquivos. Depois de um tempo, no entanto, você não precisa mais das instruções, mas de vez em quando tem requisitos especiais que não estão cobertos na seção de instruções ou você não consegue lembrar certos procedimentos que foram abordados na seção de instruções. Agora é a hora de você precisar de informações básicas de referência: você apenas vai para essa seção e rapidamente procura.

E assim, depois de mais tempo, você não precisa mais da seção de conceitos nem da seção de instruções: você se acostumou tanto a esses procedimentos que os conhece 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 arrancar as seções de conceitos e instruções e jogá-las fora. Tudo o que você precisará é da seção de referência.

Formato e Estilo do Manual

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

Protótipo do manual. A partir do link abaixo, você pode obter uma versão de teste do manual. Ele inclui todas as páginas necessárias em um bom formato. Incluídos neste documento do 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

Prototipo de conteúdos. O protótipo para o índice é particularmente útil: ele fornece os estilos do Word para produzir um índice com aspecto profissional. É difícil acertar os alinhamentos à esquerda e à direita e os pontos de liderança:

Protótipo do índice

Promptes de IA para Manuais

Listas de verificação, que geralmente não são lidas, podem ser usadas como fonte para prompts de 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 seus pensamentos, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.