Anotações:
- 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 pelo hosting: Doe qualquer quantia que puder! A Escrita Técnica Online continuará sendo 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
Um dos usos mais comuns e um dos mais importantes da escrita técnica são as instruções—aquelas explicações passo a passo de como fazer as coisas: montar algo, operar algo, consertar algo ou fazer 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 teve muitas experiências irritantes 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á 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 usar suas instruções
- Sua capacidade de visualizar o procedimento em grandes detalhes e de registrar essa consciência no papel
- Finalmente, sua disposição para ir aquela milha a mais e testar suas instruções no tipo de pessoa para quem você as escreveu.
Neste ponto, você provavelmente já estudou cabeçalhos, 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 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 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 tema, bem como outros detalhes semelhantes. Consulte a discussão de públicos e etapas a serem usadas na definição de públicos.
Mais importante, se você estiver 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 para o 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 existem no procedimento sobre o qual você está escrevendo? Vamos usar o termo procedimento para se referir ao conjunto inteiro de atividades que suas instruções pretendem discutir. A tarefa é um grupo semi-independente de ações dentro do procedimento: por exemplo, ajustar o relógio em um micro-ondas é uma tarefa dentro do 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 micro-ondas, contém muitas dessas tarefas semi-independentes: ajustar o relógio; definir 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 organizados por tarefas.)
Algumas instruções têm apenas uma única tarefa, mas possuem muitos passos dentro dessa única tarefa. Por exemplo, imagine um conjunto de instruções para montar um balanço infantil. Na minha própria experiência, foram 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. fase então é um grupo de etapas similares 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 mais uma.
Use a orientação para tarefas. Concentre-se nas tarefas que seus leitores desejam realizar; use frases de 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 logo de 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 das ferramentas).
Em um abordagem da tarefa (também conhecido como orientação para a tarefa) 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
Estes 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 um abordagem de ferramentas Para as instruções sobre como usar uma fotocopiadora, haveria estas seções improváveis:
- botão de copiar
- botão de cancelar
- botão aumentar/reduzir
- botão de agrupar/grudar
- botão de copiar-tamanho, e assim por diante
Se você desenhasse um conjunto de instruções sobre este plano, escreveria etapas para usar cada botão ou recurso da copiadora. 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 associada a ele; às vezes, você precisa usar mais do que apenas um botão para realizar a tarefa. No entanto, 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, as seguintes são agrupamentos comuns de tarefas nas instruções:
- tarefas de desembalagem e configuração
- instalando e personalizando 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
O seguinte é uma revisão das seções que você encontrará comumente nas instruções. Não presuma que cada uma delas deve esteja 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.
À medida que você lê o seguinte sobre seções comuns em instruções, observe o exemplo de instruções.
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 a introdução das suas instruções com cuidado. 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:
- Indique as tarefas ou procedimentos específicos a serem explicados, bem como o escopo de cobertura (o que não vai ser coberto).
- Indique o que o público precisa em termos de conhecimento e experiência 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 apresentações para uma discussão futura.
Avisos gerais de advertência, cautela, perigo. As instruções frequentemente devem alertar os leitores sobre a possibilidade de danificar seus equipamentos, 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. Note como esses avisos especiais são usados 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 uma discussão sobre o contexto relacionado 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 em que você define suas próprias cores movendo as barras deslizantes de vermelho, verde e azul. Para realmente entender o que você está fazendo, você precisa ter um conhecimento básico 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 de 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, esses itens 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, nomes de marcas, tamanhos, quantidades, tipos, números de modelo e assim por diante.
Discussão dos passos. Ao 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 formatadas 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, bem como outras considerações:
- Etapas em 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 venha antes de colocar o novo óleo. 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 você verificar isso, verificar aquilo, quando você está tentando consertar algo. Você pode fazer esse tipo de etapas 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.
- Etapas aninhadas. Em alguns casos, etapas individuais dentro de um procedimento podem ser bastante complexas por si mesmas e precisam ser divididas em subetapas. Nessa situação, você deve indentar ainda mais e sequenciar as subetapas como a, b, c, e assim por diante.
- __ENTIDADE_0__Instruções__ENTIDADE_1__ sem degraus. 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 apresentados.
Veja o capítulo sobre listas para o estilo e formato dessas possibilidades.
Discussão suplementar. Freqüentemente, 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 eles deveriam se importar em realizar esta etapa; qual princípio mecânico está por trás do que estão fazendo; até mesmo uma explicação em um 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 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 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 colocar a instrução em negrito.
Destacando os passos reais do usuário nas instruções. Texto em negrito ajuda a distinguir a ação real da informação suplementar.
Evite escrita telegráfica—omitindo artigos "entendidos" (o, uma, um). É verdade, robôs escrevem assim, 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 escrita anteriores ensinaram. No entanto, note como as instruções do "mundo real" são escritas—elas usam muitos tipos de escrita imperativa (comando, ou endereço direto); elas usam muito "você." Isso é totalmente apropriado. Você quer chamar a atenção do seu leitor, capturar toda a atenção dele ou dela. Por essa razão, as frases no estilo de instrução soam assim: "Agora, pressione o botão Pause no painel frontal para parar temporariamente a exibição" e "Você deve ter cuidado para não ..."
Um problema particular envolve o uso da voz passiva nas instruções. Por alguma razão estranha, algumas instruções soam assim: "O botão de Pausa deve ser pressionado para parar a exibição temporariamente." Não apenas estamos preocupados com a saúde mental do botão de Pausa, mas perguntamos quem deve pressionar a coisa (você está falando comigo?). Ou considere este exemplo: "O botão do Timer é então ajustado para 3:00." Novamente, como a pessoa que segue essas 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 é usar a terceira pessoa: "O usuário deve então pressionar o botão de Pausa." Novamente, é aquele velho efeito de duplo-take: você olha ao redor da sala e se pergunta, "Quem, 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 Pause no painel frontal para parar 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? Todos nós queremos secretamente ser robôs? De qualquer forma, tenha certeza de incluir todos os artigos (a, um, o) e outras palavras assim 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 quadrinhos), os gráficos são cruciais para instruções. Às vezes, palavras simplesmente não conseguem explicar o passo. Ilustrações são frequentemente críticas para a capacidade dos leitores de visualizar o que eles devem fazer.
Em um curso de escrita 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 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. Neste capítulo, você verá não apenas sugestões para criar gráficos, mas também requisitos sobre seu formato.
Formatar em 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 antecedentes 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 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 geralmente fazem uso intenso de listas, particularmente listas verticais numeradas para as explicações passo a passo. Listas verticais simples ou listas em duas colunas costumam ser boas para a seção de equipamentos e suprimentos. Listas embutidas são boas sempre que você fizer 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 as possibilidades em que eles podem danificar seu equipamento, desperdiçar suprimentos, fazer com que todo o procedimento falhe, se ferir ou ferir outros — até mesmo gravemente ou fatalmente. Empresas já foram processadas por falta desses avisos especiais, por avisos especiais mal redigidos 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úmeros, abreviações e símbolos. As 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, observe como o aviso está indentado para o texto do passo anterior. No segundo exemplo, observe que o aviso severo é colocado no início, antes de qualquer um dos passos.
Promptes de IA para Instruções
Checklists, que geralmente ficam sem ser 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 seus componentes podem ser encontradas no manual 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 realizar as avaliações, como um livro didático online. Em seguida, publique o que você quer que a IA verifique em sua avaliação.
Modifique a introdução para se ajustar à 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 faculdade dos EUA. Abaixo está um resumo dos capítulos do livro sobre instruções e avisos para usar como base de sua avaliação. (Informações identificáveis ocultadas):
|
Informação Relacionada
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 ser tão intuitivo que não precisa de um manual
Os Manuais de Operação Contribuem para o Desempenho Empresarial?
Como escrever instruções. techscribe
Agradeceria seus pensamentos, reações, críticas em relação a este capítulo: sua resposta—David McMurrey.
