Notas:
- Este capítulo, assim como o resto 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 garante ser bem-sucedido, preciso ou atualizado.
- Por favor, clique aqui para ajudar David McMurrey pague pela hospedagem de sites: Doe qualquer valor que puder! A escrita técnica online continuará gratuita.
O foco deste capítulo é um dos mais importantes de todos os usos da escrita técnica—instruções. Como você sabe, instruções são aquelas explicações passo a passo de como fazer algo: como construir, operar, reparar ou manter coisas.
Certifique-se de conferir o exemplos.
Escrevendo um conjunto de instruções para o trabalho ou para uma aula de redação técnica? Experimente isso. guia de planejamento de instruções.
Instruções de Escrita
Uma das utilizações mais comuns e uma das mais importantes da redação técnica são as instruções—essas explicações passo a passo de como fazer as coisas: montar algo, operar algo, reparar algo ou fazer a manutenção de rotina em algo. Mas, para algo aparentemente tão fácil e intuitivo, as instruções estão entre os documentos mais mal escritos que você pode encontrar. Assim como eu, você provavelmente já teve muitas experiências irritantes com instruções mal redigidas. 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á a você o que os profissionais consideram as melhores técnicas.
No final, uma 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, a pessoa tentando seguir suas instruções.
- Sua capacidade de visualizar o procedimento em grande detalhe e de capturar essa consciência no papel
- Finalmente, sua disposição para ir essa milha extra e testar suas instruções no tipo de pessoa para quem você 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 adicionar alguns avisos especiais nos pontos óbvios e você está feito! Bem, não exatamente, mas esse é 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 das suas instruções. Lembre-se de que definir um público significa definir seu nível de familiaridade com o tópico, assim como outros detalhes semelhantes. Veja a discussão sobre públicos e passos a serem usados na definição de públicos.
Mais importante ainda, se você está em um curso de escrita, 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 adequação ao público-alvo. E lembre-se também de que em um curso de escrita técnica é preferível escrever para públicos não especializados— muito mais desafiador para você como escritor.
Número de tarefas. Quantas tarefas há 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-independent de ações dentro do procedimento: por exemplo, ajustar o relógio em um micro-ondas é uma tarefa na grande procedure 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; configurar o nível de potência; usar o timer; limpar e manter o micro-ondas, entre outros. (O instruções sobre como usar uma câmera são organizadas por tarefas.)
Algumas instruções têm apenas uma única tarefa, mas possuem muitos passos dentro dessa tarefa única. Por exemplo, imagine um conjunto de instruções para montar um balanço infantil. 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. A fase então é um grupo de etapas semelhantes dentro de um procedimento de tarefa única. No exemplo do 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 para tarefas. Concentre-se nas tarefas que seus leitores desejam realizar; use frases em como fazer ou – nos títulos.
Melhor abordagem para a discussão passo a passo. Outra consideração, que talvez você não consiga determinar 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 características de 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
- deletando 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ões, veja o capítulo sobre análise de tarefas.
Por outro lado, em uma abordagem de ferramentas para instruções sobre como usar uma copiadora, haveria estas seções improváveis:
- botão de copiar
- botão de cancelar
- botão de aumentar/reduzir
- botão de agrupar/grampear
- botão de tamanho de cópia, e assim por diante
Se você projetasse um conjunto de instruções sobre este 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 combina exatamente com a tarefa a que 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 de ferramentas/recurso 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ê deve agrupá-las para que os leitores possam encontrar tarefas individuais mais facilmente. Por exemplo, a seguir estão agrupamentos de tarefas comuns em instruções:
- tarefas de desembalar e configuração
- instalação e personalização de tarefas
- tarefas operacionais básicas
- tarefas de manutenção de rotina
- 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ê encontrará comumente nas instruções. Não suponha que cada uma delas deve estar nas instruções reais que você escreve, nem que elas precisam estar na ordem apresentada aqui, nem que essas são 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 a exemplo de instruções.
Vista 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 a introdução das suas instruções com cuidado. Certifique-se de que ela faça algumas das seguintes coisas (mas não necessariamente nesta ordem) que se aplicam às suas instruções:
- Indique as tarefas específicas ou o procedimento a ser explicado, bem como o escopo de cobertura (o que não irá 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 realiza.
- Indique as condições em que estas instruções devem (ou não) ser utilizadas.
- Forneça uma visão geral do conteúdo das instruções.
Veja a seção sobre introduções para discussão posterior.
Avisos gerais de advertência, cautela, perigo. Instruções muitas vezes devem alertar os leitores sobre a possibilidade de danificar seu equipamento, estragar o procedimento e se machucar. Além disso, as instruções muitas vezes devem enfatizar pontos-chave ou exceções. Para essas situações, você usa avisos especiais—nota, aviso, cautela e avisos de perigo. Observe como esses avisos especiais são utilizados nas instruções de exemplo listadas acima.
Fundo técnico ou teoria. No início de certos tipos de instruções (após a introdução, claro), pode ser necessário um discussão de 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 aplicativos de software nos quais você define suas próprias cores ajustando as barras deslizantes de vermelho, verde e azul. Para realmente entender o que você está fazendo, você precisa ter algum conhecimento sobre cores. Da mesma forma, você pode imaginar que, para certas instruções que utilizam 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 para pão, martelos, furadeiras e serras) e suprimentos, os itens que são consumidos no procedimento (como madeira, tinta, óleo, farinha e pregos). Nas instruções, estes geralmente são listados 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 todos os itens—por exemplo, marcas, tamanhos, quantidades, tipos, números de modelo e assim por diante.
Discussão dos passos. Quando você chegar à redação dos passos, há várias coisas a ter em mente: (1) a estrutura e o formato desses passos, (2) informações suplementares que podem ser necessárias e (3) o ponto de vista e o estilo de escrita geral.
Estrutura e formato. Normalmente, imaginamos um conjunto de instruções como sendo formatado como listas numeradas verticais. E a maioria é, de fato. Normalmente, você formata suas instruções passo a passo dessa maneira. No entanto, existem algumas variações, assim como outras considerações:
- Etapas de 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 venha antes de colocar o novo óleo. Essas 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 você verificar isso, verificar aquilo quando você está tentando consertar algo. Você pode fazer esse tipo de etapa em praticamente qualquer ordem. Com esse tipo, a lista com marcadores é o formato apropriado.
- Passos alternativos são aqueles em que duas ou mais maneiras de realizar a mesma coisa são apresentadas. Passos alternativos também são usados quando várias condições podem existir. Use listas com marcadores com OR inserido entre as alternativas, ou a introdução indicando que alternativas estão prestes a ser apresentadas.
- Passos aninhados. Em alguns casos, etapas individuais dentro de um procedimento podem ser bastante complexas por si só e precisam ser divididas em subtarefas. Nesse caso, você faz um recuo adicional e sequencia as subtarefas como a, b, c, e assim por diante.
- __ENTIDADE_0__Instruções sem degraus__ENTIDADE_1__. E, finalmente, existem instruções que realmente não podem usar listas verticais numeradas e que fazem pouco, se é que fazem, para direcionar o leitor de forma clara. Algumas situações devem ser tão generalizadas ou tão variáveis que os passos não podem ser definidos.
Veja o capítulo sobre listas para o estilo e formato dessas possibilidades.
Discussão suplementar. Muitas vezes, não é suficiente simplesmente dizer aos leitores para fazer isso ou aquilo. Eles precisam de informações explicativas adicionais, como como a coisa deve parecer antes e depois da etapa; por que devem se importar em fazer essa etapa; qual princípio mecânico está por trás do que estão fazendo; até uma explicação ainda mais detalhada 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 esconder o passo real. Você quer que o passo real—as ações específicas que o leitor deve tomar—se destaque. Você não quer que tudo isso fique enterrado em um monte de palavras. Existem pelo menos duas técnicas para evitar esse problema: você pode separar a instrução do suplemento em parágrafos distintos; ou pode destacar a instrução em negrito.
Destacando os passos reais do usuário nas instruções. O texto em negrito ajuda a distinguir a ação real das informações suplementares.
Evite a escrita telegráfica—omitindo artigos "definidos" (o, a, um). Verdade, robôs escrevem dessa forma, mas nós não precisamos.
Estilo de escrita. A maneira como você realmente escreve instruções, frase por frase, pode parecer contraditória ao que as aulas de redação anteriores lhe ensinaram. No entanto, note como as instruções do mundo real são escritas; elas usam muitos tipos de escrita imperativa (comando ou direto ao ponto); usam muito você. Isso é totalmente apropriado. Você quer chamar a atenção do seu leitor, obter sua atenção total. Por essa razão, frases no estilo de instrução soam assim: Agora, pressione o botão Pause no painel frontal para parar a exibição temporariamente e Você deve ter cuidado para não ...
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 Pause deve ser pressionado para parar a exibição temporariamente." Não só estamos preocupados com a saúde mental do botão Pause, mas também nos questionamos quem deve pressionar a coisa (está falando comigo?). Ou considere este exemplo: "O botão Timer é então ajustado para 3:00." Novamente, como a pessoa que segue estas instruções, você pode perder isso; pode pensar que é simplesmente uma referência a algum estado existente, ou pode se perguntar, "Estão falando comigo?" Quase tão ruim quanto isso é usar a terceira pessoa: "O usuário deve então pressionar o botão Pause." Novamente, é o velho duplo olhar: você olha ao redor da sala e se pergunta, "Eu?" (Para mais detalhes, veja problema da voz passiva.)
Outro dos problemas típicos com o estilo de escrita em instruções é que as pessoas parecem querer omitir artigos: "Pressione o botão Pausar no painel frontal para interromper temporariamente a exibição das informações" ou "Terrestre, por favor forneça o endereço da pizzaria mais próxima." Por que fazemos isso? Todos nós queremos secretamente ser robôs? De qualquer forma, tenha certeza de incluir todos os artigos (a, um, o) e outras palavras desse tipo que normalmente usaríamos em instruções.
Gráficos nas Instruções
Provavelmente mais do que em qualquer outra forma de escrita (exceto talvez quadrinhos), gráficos são cruciais para instruções. Às vezes, as palavras simplesmente não conseguem explicar o passo. Ilustrações são frequentemente críticas para a capacidade dos leitores de visualizar o que se espera que eles façam.
Em um curso de redação técnica, as instruções podem exigir que você inclua ilustrações ou outros tipos de gráficos—qualquer coisa que normalmente seria usada nas instruções. O problema, é claro, pode ser que você não tenha acesso a gráficos que sejam 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. Neste capítulo, você verá não apenas sugestões para criar gráficos, mas também requisitos sobre seu formato.
Formato em Instruções
Títulos. Em suas instruções, use bem os cabeçalhos. Normalmente, você gostaria de ter cabeçalhos para qualquer seção de antecedentes que possa ter, a seção de equipamentos e suprimentos, um cabeçalho geral para a seção de instruções propriamente dita e subtítulos para as tarefas ou fases individuais 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 costumam fazer uso intenso de listas, especialmente listas verticais numeradas para as explicações passo a passo. Listas verticais simples ou listas em duas colunas são geralmente boas para a seção de equipamentos e materiais. 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 podem danificar seu equipamento, desperdiçar suprimentos, causar a falha de todo o procedimento, se ferir ou ferir outros—mesmo de forma grave ou fatal. Empresas foram processadas por falta desses avisos especiais, por avisos especiais mal escritos ou por avisos 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 colocação dentro das instruções.
Número, abreviações e símbolos. Instruções também usam muitos números, abreviações e símbolos. Para diretrizes sobre essas áreas.
Indicação de avisos nas instruções. No primeiro exemplo, observe como o aviso está indentado para o texto do passo anterior. No segundo exemplo, observe que o aviso severo está colocado no início, antes de qualquer um dos passos.
Promptes de IA para Instruções
Checklists, que normalmente permanecem sem leitura, podem ser usadas como fonte para prompts de IA com alguma modificação. 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 seus componentes podem ser encontradas na livro didático de redação técnica online.
Quando você quiser usar a 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 fazer avaliações, como um livro didático online. Em seguida, 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 as instruções escritas por um estudante do segundo ano de faculdade nos EUA. Abaixo está um resumo dos capítulos do livro didático sobre instruções e avisos para usar como base da sua avaliação. (Informações identificáveis mascaradas):
|
Informação Relacionada
Quiz de leitura. Use este quiz 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 suas opiniões, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.
