Notas:
- Este capítulo, assim como o restante deste livro-texto de escrita técnica, concentra-se 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! Redação Técnica Online permanecerá gratuita.
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 de 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? Experimente 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 fazer manutenção rotineira 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 irritantes com instruções mal escritas. O que 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 habilidade de se colocar no lugar do leitor, a pessoa que tenta usar suas instruções
- Sua capacidade de visualizar o procedimento em grande detalhe e de capturar essa percepção no papel
- Finalmente, a sua disposição em ir além e testar as suas instruções no tipo de pessoa para quem as escreveu.
A esta altura, você provavelmente já 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, não exatamente, 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 em particular sobre o qual você vai escrever.
Público e situação. No início do processo, defina o público e a situação das 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 sobre públicos e etapas a serem usadas 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 quanto à 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 referir-se ao conjunto completo de atividades que suas instruções visam abordar. Uma tarefa é um grupo semi-independente de ações dentro do procedimento: por exemplo, ajustar o relógio de um forno de micro-ondas é uma tarefa no grande procedimento geral de operar um forno de 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: acertar o relógio; ajustar o nível de potência; usar o temporizador; limpar e fazer a manutenção do micro-ondas, entre outras. (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 instruções para montar um balanço para crianças. Na minha própria experiência, havia mais de 130 passos! Isso pode ser um pouco intimidador. Uma boa abordagem é agrupar passos semelhantes e relacionados em fases, e começar a renumerar os passos em cada nova fase. Uma fase então é um conjunto de etapas semelhantes dentro de um procedimento de uma única tarefa. No exemplo do conjunto de balanços, montar a armação seria uma fase; ancorar a estrutura no solo seria outra; montar o balanço tipo caixa seria ainda outra.
Use orientação voltada a tarefas. Foque nas tarefas que seus leitores querem realizar; use formulações nas manchetes no formato como ou –ing.
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 nas tarefas, ou pode focar nas ferramentas (ou nas funcionalidades das ferramentas).
Em um abordagem da tarefa (também conhecida 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
- apagando suas mensagens, e assim por diante
Estas são tasks—as coisas típicas que gostaríamos de fazer com a máquina. Para mais detalhes, veja o capítulo sobre análise de tarefa.
Por outro lado, em um abordagem de ferramentas Para instruções sobre como usar uma fotocopiadora, haveria estas seções improváveis:
- botão de copiar
- botão Cancelar
- botão aumentar/reduzir
- botão agrupar/grampear
- botão de copiar tamanho, e assim por diante
Se você projetasse um conjunto de instruções neste plano, escreveria etapas para usar cada botão ou recurso da fotocopiadora. Instruções usando essa abordagem de ferramentas são difíceis de fazer funcionar. Às vezes, o nome do botão não corresponde exatamente à tarefa à qual está associado; às vezes você precisa usar mais do que apenas um botão para realizar a tarefa. Ainda assim, pode haver momentos em que a abordagem por ferramentas/recursos seja 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 encontrem as 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á em 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.
Enquanto você lê 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 o conteúdo e organização—muitos outros são possíveis.
Introdução. Planeje cuidadosamente a introdução às suas instruções. Certifique-se de que ela faça qualquer uma das seguintes coisas (mas não necessariamente nesta ordem) que se aplicam às suas instruções particulares:
- Indique as tarefas específicas ou o procedimento a ser explicado, bem como o âmbito de cobertura (o que não vai ser coberto).
- Indique o que o público precisa em termos de conhecimento e formação para entender as instruções.
- Dê uma ideia geral do procedimento e do que ele alcança.
- Indique as condições em que essas instruções devem (ou não devem) ser usadas.
- Dê 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, cautela e perigo. Instruções muitas vezes devem alertar os leitores para a possibilidade de arruinar seu equipamento, estragar o procedimento, e se ferirem. Além disso, instruções muitas vezes devem enfatizar pontos-chave ou exceções. Para essas situações, você usa avisos especiais—avisos de nota, de aviso, de cautela e de 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), você pode precisar de uma discussão sobre as informações de base relacionadas ao procedimento. Para certas instruções, esse contexto é crítico—caso contrário, os passos no procedimento não fazem sentido. Por exemplo, você pode ter alguma experiência com aqueles applets de software em que define suas próprias cores ajustando as barras deslizantes de vermelho, verde e azul. Para realmente entender o que está fazendo, você precisa ter alguns fundamentos sobre cor. Da mesma forma, você pode imaginar que, para certas instruções envolvendo câmeras, alguma teoria também pode ser necessária.
Equipamentos 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 (tais como madeira, tinta, óleo, farinha e pregos). Em instruções, estas tipicamente são listadas ou em uma simples lista vertical 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 marcas, 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 formatado como listas numeradas verticais. E, na verdade, a maioria é. Normalmente, você formata suas instruções passo a passo dessa maneira. Existem algumas variações, no entanto, bem como algumas outras considerações:
- Passos em ordem fixa são etapas que devem ser realizadas na ordem apresentada. Por exemplo, se você está trocando o óleo de um carro, drenar o óleo é uma etapa que deve vêm antes de colocar o óleo novo. Estas são listas numeradas (normalmente, 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 você verificar isto, verificar aquilo quando você está tentando consertar algo. Você pode executar esse tipo de etapa em praticamente qualquer ordem. Com esse tipo, a lista com marcadores é o formato apropriado.
- Etapas alternativas 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 desse tipo, com OU inserido entre as alternativas, ou o enunciado introdutório indicando que as alternativas estão prestes a ser apresentadas.
- Etapas aninhadas. Em alguns casos, etapas individuais dentro de um procedimento podem ser bastante complexas por si só e precisam ser subdivididas 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 pouco, se é que fazem algo, direcionam o leitor de forma direta, 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 formato dessas possibilidades.
Discussão suplementar. Frequentemente, não é suficiente simplesmente dizer aos leitores para fazer isto ou aquilo. Eles precisam de informações explicativas adicionais, tais como a aparência da coisa 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; uma explicação ainda mais em nível micro da etapa—discussão das ações específicas que compõem a etapa.
O problema com a discussão suplementar, porém, é que ela pode ocultar a etapa real. Você quer que a etapa real—as ações específicas que o leitor deve tomar—se destaque. Você não quer que tudo fique enterrado em um amontoado de palavras. Há pelo menos duas técnicas para evitar esse problema: você pode separar a instrução do suplemento em parágrafos distintos; ou você pode colocar a instrução em negrito.
Colocar em negrito as etapas reais do usuário nas instruções. Texto em negrito ajuda a distinguir a ação real da informação complementar.
Evite a escrita telegráfica—omitindo os 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 estranha razão, algumas instruções soam assim: "O botão Pause deve ser pressionado para parar a exibição temporariamente." Não apenas nos preocupamos com a saúde mental do botão Pause, mas nos perguntamos quem deveria pressionar a coisa (você está falando comigo?). Ou considere este exemplo: "O botão Timer é 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, "Eles estão falando comigo?" Quase tão ruim é usar a terceira pessoa: "O usuário então deve pressionar o botão Pause." De novo, é aquele olhar duplo: você olha ao redor da sala e se pergunta, "Quem, eu?" (Para mais detalhes, veja problema de voz passiva.)
Outro dos problemas típicos de estilo de escrita em instruções é que as pessoas parecem querer omitir artigos: "Pressione o botão Pause no painel frontal para interromper temporariamente a exibição de informações" ou "Terrestreum, um/uma, 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 nas histórias em quadrinhos), os gráficos são cruciais para as instruções. Às vezes, as palavras simplesmente não conseguem explicar a etapa. Ilustrações são frequentemente cruciais 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 normalmente seria usado nas instruções. O problema, claro, pode ser que você não tenha acesso a gráficos que seriam adequados às suas instruções específicas, e que você não se sinta particularmente confiante em suas habilidades artísticas. Há 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 quanto ao seu formato.
Formato nas instruções
Títulos. Em suas instruções, faça bom uso de títulos. Normalmente, você vai querer títulos para qualquer seção de contexto que possa ter, a seção de equipamentos 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, instruções normalmente fazem amplo uso de listas, particularmente listas numeradas na vertical para as explicações passo a passo propriamente ditas. Listas verticais simples ou listas de duas colunas costumam ser boas para a seção de equipamentos e suprimentos. Listas dentro da frase são boas sempre que você der uma visão geral do que está por vir. Veja listas para requisitos comuns.
Avisos especiais. Nas instruções, você deve alertar os leitores sobre possibilidades em que eles possam danificar seu equipamento, desperdiçar suprimentos, fazer com que todo o procedimento falhe, ferir a si mesmos ou a outros—até mesmo gravemente ou fatalmente. Empresas foram processadas por falta desses avisos especiais, por avisos especiais mal redigidos, ou por avisos especiais fora de lugar. Veja avisos especiais para uma discussão completa sobre o uso apropriado desses avisos especiais, bem como seu formato e posicionamento dentro das instruções.
Número, abreviaturas e símbolos. Instruções também usam muitos números, abreviações e símbolos. Para diretrizes sobre estas áreas.
Indentação de avisos em instruções. No primeiro exemplo, observe como o aviso está recuado para o texto do passo anterior. No segundo exemplo, observe que o aviso grave é colocado no início antes de qualquer um dos passos.
Solicitações 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-o 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 quiser usar IA para avaliar um projeto de escrita, apresente-se, diga à IA quem você é e o que deseja. Dê à IA um ponto de referência para realizar as avaliações, como um livro-texto online. Em seguida, poste o que você quer que a IA verifique em sua avaliação.
Modifique a introdução para adequá-la à sua identidade.
|
Instruções de 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 de um livro didático sobre instruções e avisos para usar como base da sua avaliação. (Informações identificadoras mascaradas):
|
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ções 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.
