Notas:
- Este capítulo, assim como o restante deste livro didático de redação técnica, foca em habilidades de redação técnica. O conteúdo técnico aqui não é garantido como bem-sucedido, preciso ou atualizado.
- Por favor clique aqui para ajudar David McMurrey pague pela hospedagem na web: Doe qualquer quantia que puder! Online Technical Writing continuará gratuito.
O foco deste capítulo é um dos usos mais importantes de toda a redação técnica—instruções. Como você sabe, instruções são essas explicações passo a passo sobre como fazer algo: como construir, operar, reparar ou manter coisas.
Não deixe de conferir o exemplos.
Escrevendo um conjunto de instruções para o trabalho ou para uma aula de redação técnica? Tente isto guia de planejamento de instruções.
Instruções de Escrita
Um dos usos mais comuns e um dos mais importantes da escrita técnica são as instruções—essas explicações passo a passo de como fazer coisas: montar algo, operar algo, consertar algo ou realizar a manutenção de rotina em algo. Mas, para algo aparentemente tão simples e intuitivo, as instruções estão entre os documentos mais mal escritos que você pode encontrar. Como eu, você provavelmente já teve muitas experiências extremamente frustrantes com instruções mal escritas. O que se segue neste capítulo pode não ser um guia infalível e à prova de erros para escrever instruções, mas mostrará o que os profissionais consideram as melhores técnicas.
Em última análise, a boa redação de instruções requer:
- Escrita clara e simples
- Uma compreensão completa do procedimento em todos os seus detalhes técnicos
- Sua capacidade de se colocar no lugar do leitor, da pessoa que está tentando usar suas instruções
- Sua capacidade de visualizar o procedimento em grande detalhe e de registrar essa percepção no papel
- Finalmente, a sua disposição em ir além e testar as suas instruções com o tipo de pessoa para quem as escreveu.
Até agora, você provavelmente estudou títulos, listas e avisos especiais—escrever um conjunto de instruções com essas ferramentas provavelmente parece óbvio. Basta dividir a discussão em listas verticais numeradas e incluir alguns avisos especiais nos pontos óbvios e pronto! Bem, nem tanto, mas isso é um ótimo começo. Este capítulo explora algumas das características das instruções que podem torná-las mais complexas. Você pode, por sua vez, usar essas considerações para planejar suas próprias instruções.
Infográfico gerado pelo NotebookLM deste capítulo
Algumas Preliminares
No início de um projeto para escrever instruções, é importante determinar a estrutura ou as características do procedimento específico sobre o qual você vai escrever.
Público e situação. No início do processo, defina o público e a situação de suas instruções. Lembre-se de que definir um público significa definir seu nível de familiaridade com o tópico, bem como outros detalhes semelhantes. Veja a discussão de públicos e etapas a usar na definição de públicos.
Mais importante ainda, se você estiver em um curso de redação, precisará escrever uma descrição do seu público e anexá-la às suas instruções. Isso permitirá que seu instrutor avalie suas instruções em termos de sua adequação ao público pretendido. E lembre-se também de que, em um curso de redação técnica, é preferível escrever para públicos não especialistas—muito mais desafiador para você como escritor.
Número de tarefas. Quantas tarefas existem no procedimento sobre o qual você está escrevendo? Vamos usar o termo procedimento para se referir ao conjunto completo de atividades que suas instruções se destinam a discutir. A tarefa é um grupo semi-independente de ações dentro do procedimento: por exemplo, ajustar o relógio de um micro-ondas é uma tarefa no grande procedimento geral de operar um micro-ondas.
Um procedimento simples, como trocar o óleo de um carro, contém apenas uma tarefa; não há agrupamentos semi-independentes de atividades. Um procedimento mais complexo, como usar um forno de micro-ondas, contém muitas dessas tarefas semi-independentes: ajustar o relógio; ajustar o nível de potência; usar o temporizador; limpar e manter o micro-ondas, entre outros. (O instruções sobre como usar uma câmera são organizados por tarefas.)
Algumas instruções têm apenas uma única tarefa, mas têm muitos passos dentro dessa única tarefa. Por exemplo, imagine um conjunto de balanços para crianças. Na minha própria experiência, havia mais de 130 passos! Isso pode ser um pouco assustador. Uma boa abordagem é agrupar passos semelhantes e relacionados em fases, e começar a renumerar os passos em cada nova fase. A fase então é um grupo de etapas semelhantes dentro de um procedimento de tarefa única. No exemplo do conjunto de balanço, montar a estrutura seria uma fase; ancorar a coisa no chão seria outra; montar o balanço de caixa seria ainda outra.
Use orientação por tarefas. Concentre-se nas tarefas que seus leitores querem realizar; use formulações "como fazer" ou –ing nos títulos.
Melhor abordagem para a discussão passo a passo. Outra consideração, que talvez você não consiga determinar logo no início, é como focar suas instruções. Para a maioria das instruções, você pode focar em tarefas, ou pode focar em ferramentas (ou em recursos das ferramentas).
Em um abordagem da tarefa (também conhecido como orientação para tarefas) para instruções sobre como usar um serviço de atendimento telefônico, você teria estas seções:
- gravando sua saudação
- reproduzindo suas mensagens
- salvando suas mensagens
- encaminhando suas mensagens
- excluindo suas mensagens, e assim por diante
Estas são tarefas—as coisas típicas que gostaríamos de fazer com a máquina. Para mais discussão, veja o capítulo sobre análise de tarefa.
Por outro lado, em um abordagem de ferramentas para instruções sobre o uso de uma fotocopiadora, haveria estas seções improváveis:
- botão de copiar
- botão cancelar
- botão aumentar/reduzir
- botão agrupar/agrafar
- botão de copiar tamanho, e assim por diante
Se você elaborasse um conjunto de instruções com base neste plano, escreveria passos para usar cada botão ou recurso da fotocopiadora. Instruções que usam essa abordagem de ferramentas são difíceis de fazer funcionar. Às vezes, o nome do botão não corresponde exatamente à tarefa a que está associado; às vezes você tem que usar mais do que apenas um botão para realizar a tarefa. Ainda assim, pode haver ocasiões em que a abordagem por ferramentas/recursos pode ser preferível.
Agrupamentos de tarefas. Listar tarefas pode não ser tudo o que você precisa fazer. Pode haver tantas tarefas que você terá de agrupá-las para que os leitores possam encontrar as tarefas individuais com mais facilidade. Por exemplo, os seguintes são agrupamentos comuns de tarefas em instruções:
- tarefas de desempacotamento e configuração
- instalando e personalizando tarefas
- tarefas operacionais básicas
- tarefas rotineiras de manutenção
- tarefas de solução de problemas; e assim por diante
Seções Comuns em Instruções
A seguir está uma revisão das seções que você normalmente encontrará nas instruções. Não presuma que cada uma delas deve estejam nas instruções reais que você escreve, nem que elas tenham que estar na ordem apresentada aqui, nem que estas sejam as únicas seções possíveis em um conjunto de instruções.
Ao ler o seguinte sobre seções comuns em instruções, confira o instruções de exemplo.
Visão esquemática das instruções. Lembre-se de que este é um modelo típico ou comum para os conteúdos e a organização—muitos outros são possíveis.
Introdução. Planeje cuidadosamente a introdução das suas instruções. Certifique-se de que ela faça qualquer uma das seguintes coisas (mas não necessariamente nessa ordem) que se apliquem às suas instruções particulares:
- Indique as tarefas específicas ou o procedimento a ser explicado, bem como o escopo de cobertura (o que não vai ser coberto).
- Indique o que o público precisa em termos de conhecimentos e experiência prévia para entender as instruções.
- Dê uma ideia geral do procedimento e do que ele realiza.
- Indique as condições em que estas instruções devem (ou não devem) ser usadas.
- Forneça uma visão geral do conteúdo das instruções.
Veja a seção sobre introduções para discussão adicional.
Avisos gerais de advertência, de precaução e de perigo. Instruções frequentemente precisam alertar os leitores sobre a possibilidade de arruinar seu equipamento, estragar o procedimento e se ferir. Além disso, instruções muitas vezes precisam enfatizar pontos-chave ou exceções. Para essas situações, você usa avisos especiais—avisos do tipo nota, aviso, precaução e perigo. Observe como esses avisos especiais são usados nas instruções de exemplo listadas acima.
Contexto técnico ou teoria. No início de certos tipos de instruções (após a introdução, é claro), pode ser necessária uma discussão do contexto relacionada ao procedimento. Para certas instruções, esse contexto é crítico—caso contrário, os passos do procedimento não fazem sentido. Por exemplo, você pode ter tido alguma experiência com aqueles applets de software nos quais você define suas próprias cores ajustando as barras deslizantes de vermelho, verde e azul. Para realmente entender o que está fazendo, você precisa ter algum conhecimento sobre cor. De forma semelhante, você pode imaginar que, para certas instruções envolvendo câmeras, alguma teoria também pode ser necessária.
Equipamento e suprimentos. Observe que a maioria das instruções inclui uma lista das coisas que você precisa reunir antes de começar o procedimento. Isso inclui equipamento, as ferramentas que você usa no procedimento (como tigelas de mistura, colheres, formas de pão, martelos, furadeiras, e serras) e suprimentos, as coisas que são consumidas no procedimento (como madeira, tinta, óleo, farinha, e pregos). Em instruções, estas normalmente são listadas em uma lista vertical simples ou em uma lista de duas colunas. Use a lista de duas colunas se precisar adicionar algumas especificações a alguns ou a todos os itens—por exemplo, nomes de marca, tamanhos, quantidades, tipos, números de modelo, e assim por diante.
Discussão das etapas. Quando você chegar à redação propriamente dita dos passos, há várias coisas a ter em mente: (1) a estrutura e o formato desses passos, (2) informações suplementares que possam ser necessárias, e (3) o ponto de vista e o estilo geral de escrita.
Estrutura e formato. Normalmente, imaginamos um conjunto de instruções sendo formatado como listas verticais numeradas. E a maioria, de fato, é. Normalmente, você formata suas instruções passo a passo reais dessa maneira. Existem algumas variações, no entanto, assim como algumas outras considerações:
- Etapas de ordem fixa são etapas que devem ser realizadas na ordem apresentada. Por exemplo, se você estiver trocando o óleo de um carro, drenar o óleo é uma etapa que deve aparecem antes de colocar o óleo novo. Estas são listas numeradas (geralmente, listas numeradas verticais).
- Passos de ordem variável são etapas que podem ser realizadas em praticamente qualquer ordem. Bons exemplos são aqueles guias de solução de problemas que dizem para verificar isto, verificar aquilo quando você está tentando consertar algo. Você pode executar esse tipo de passos em praticamente qualquer ordem. Com esse tipo, a lista com marcadores é o formato apropriado.
- Passos alternativos são aquelas em que duas ou mais maneiras de realizar a mesma coisa são apresentadas. Passos alternativos também são usados quando podem existir várias condições. Use listas com marcadores com este tipo, com OR inserido entre as alternativas, ou a introdução indicando que alternativas estão prestes a ser apresentadas.
- Etapas aninhadas. Em alguns casos, etapas individuais dentro de um procedimento podem ser bastante complexas por si mesmas e precisam ser divididas em subetapas. Nesse caso, você recua mais e sequencia as subetapas como a, b, c, e assim por diante.
- "Stepless" instruções. E, finalmente, existem instruções que realmente não podem usar uma lista vertical numerada e que oferecem pouco, se é que oferecem, direcionamento direto ao leitor no estilo instrucional. Algumas situações devem ser tão generalizadas ou tão variáveis que os passos não podem ser declarados.
Veja o capítulo sobre listas para o estilo e o formato dessas possibilidades.
Discussão suplementar. Frequentemente, não basta simplesmente dizer aos leitores para fazer isto ou aquilo. Eles precisam de informações explicativas adicionais, tais como de que maneira a coisa deve se apresentar antes e depois da etapa; por que deveriam se importar em realizar essa etapa; qual princípio mecânico está por trás do que estão fazendo; até uma explicação em nível mais micro da etapa—discussão das ações específicas que compõem a etapa.
O problema com a discussão suplementar, no entanto, é que ela pode ocultar a etapa real. Você quer que a etapa real—as ações específicas que o leitor deve realizar—se destaque. Você não quer que tudo fique enterrado em um monte de palavras. Há pelo menos duas técnicas para evitar esse problema: você pode separar a instrução do suplemento em parágrafos separados; ou pode colocar a instrução em negrito.
Colocar em negrito os passos reais do usuário nas instruções. O texto em negrito ajuda a distinguir a ação propriamente dita das informações suplementares.
Evite escrever de forma telegráfica—omitindo artigos "subentendidos" (the, a, an). É verdade, os robôs escrevem assim, mas não precisamos.)
Estilo de escrita.
Um problema particular envolve o uso da voz passiva em instruções. Por alguma razão estranha, algumas instruções soam assim: "O botão Pausa deve ser pressionado para parar a exibição temporariamente." Não só nos preocupamos com a saúde mental do botão Pausa, como também nos perguntamos quem é que deve pressionar essa coisa (você está falando comigo?). Ou considere este exemplo: "O botão Temporizador é então ajustado para 3:00." Novamente, como a pessoa que segue essas instruções, você pode não perceber isso; pode pensar que é simplesmente uma referência a algum estado existente, ou pode se perguntar, "Estão falando comigo?" Quase tão ruim é usar a terceira pessoa: "O usuário deve então pressionar o botão Pausa." Novamente, é a velha reação problema de voz passiva.)
Outro dos problemas típicos no estilo de escrita em instruções é que as pessoas parecem querer omitir os artigos: "Pressione o botão Pause no painel frontal para interromper temporariamente a exibição de informações" ou "Terrestre, por favor forneça o endereço da pizzaria mais próxima." Por que fazemos isso? Será que todos nós secretamente queremos ser robôs? De qualquer forma, certifique-se de incluir todos os artigos (a, um, o) e outras palavras semelhantes que normalmente usaríamos em instruções.
Gráficos nas Instruções
Provavelmente mais do que em qualquer outra forma de escrita (exceto talvez em histórias em quadrinhos), os elementos gráficos são cruciais nas instruções. Às vezes, as palavras simplesmente não conseguem explicar a etapa. Ilustrações costumam ser essenciais para a capacidade dos leitores de visualizar o que devem fazer.
Em um curso de redação técnica, as instruções podem exigir que você inclua ilustrações ou outros tipos de gráficos—o que quer que normalmente fosse usado nas instruções. O problema, é claro, pode ser que você não tenha acesso a gráficos que seriam adequados para suas instruções específicas, e que você não se sinta muito confiante em suas habilidades artísticas. Existem maneiras de superar esses problemas! Dê uma olhada nas sugestões em gráficos. Nesse capítulo, você verá não apenas sugestões para criar gráficos, mas também requisitos sobre o seu formato.
Formato em Instruções
Cabeçalhos. Em suas instruções, faça bom uso de títulos. Normalmente, convém ter títulos para qualquer seção de contexto que você possa ter, para a seção de equipamento e suprimentos, um título geral para a seção de instruções propriamente dita, e subtítulos para as tarefas individuais ou fases dentro dessa seção. Dê uma olhada nos exemplos no início deste capítulo. Veja títulos para requisitos comuns.
Listas. Da mesma forma, as instruções normalmente fazem amplo uso de listas, particularmente listas verticais numeradas para as explicações passo-a-passo propriamente ditas. Listas verticais simples ou listas em duas colunas costumam ser boas para a seção de equipamentos e suprimentos. Listas dentro da frase são boas sempre que você fornece uma visão geral do que está por vir. Veja listas para requisitos comuns.
Avisos especiais. Nas instruções, você deve alertar os leitores para possibilidades em que eles podem danificar seu equipamento, desperdiçar suprimentos, fazer com que todo o procedimento falhe, ferir a si mesmos ou outros—até mesmo de forma grave ou fatal. Empresas foram processadas pela falta dessas notificações especiais, por notificações especiais mal redigidas, ou por notificações especiais que estavam fora de lugar. Veja avisos especiais para uma discussão completa sobre o uso adequado desses avisos especiais, bem como seu formato e posicionamento nas instruções.
Número, abreviações e símbolos. Instruções também usam muitos números, abreviações e símbolos. Para diretrizes nessas áreas.
Indentação de avisos nas instruções. No primeiro exemplo, repare como o aviso está recuado até o texto do passo anterior. No segundo exemplo, observe que o aviso grave é colocado no início antes de qualquer um dos passos.
Prompts de IA para Instruções
Listas de verificação, que normalmente 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 das instruções ou de seus componentes podem ser encontradas em livro didático online de redação técnica.
Quando você quiser usar IA para avaliar um projeto de escrita, apresente-se, diga à IA quem você é, o que deseja. Dê à IA um ponto de referência para fazer avaliações, como um livro didático online. Então poste o que você quer que a IA verifique em sua avaliação.
Modifique a introdução para se adequar à sua identidade.
|
Instruções para prompts de IA Olá, IA. Estou solicitando que você avalie instruções escritas por um estudante do segundo ano de uma faculdade dos EUA. Abaixo está um resumo de capítulos do livro didático sobre instruções e avisos para usar como base da sua avaliação. (Informações de identificação ocultadas):
|
Informações Relacionadas
Questionário de leitura. Use este questionário para testar sua compreensão deste capítulo.
Questionários: gramática, uso, pontuação.
Como posso criar manuais de instrução eficazes
O custo oculto de tão intuitivo que não precisa de um manual
Os manuais operacionais contribuem para o desempenho empresarial?
Como escrever instruções. techscribe
Agradeceria seus pensamentos, reações, críticas a respeito deste capítulo: sua resposta—David McMurrey.
