Instruções

O foco para este capítulo é um dos mais importantes de todos os usos das instruções técnicas de escrita. Como você sabe, instruções são aquelas explicações passo-a-passo de como fazer algo: como construir, operar, reparar ou manter as coisas.

Certifique-se de verificar os exemplos.

Instruções de escrita

Um dos usos mais comuns e um dos mais importantes da escrita técnica são as instruções – estas explicações passo-a-passo de como fazer as coisas: montar algo, operar algo, reparar algo, ou fazer manutenção de rotina em algo. Mas para algo aparentemente tão fácil e intuitivo, as instruções são alguns dos piores documentos escritos que você pode encontrar. Como eu, você provavelmente já teve muitas experiências enfurecedoras com instruções mal escritas. O que se segue neste capítulo pode não ser um guia à prova de tolos, à prova de tolos para escrever instruções, mas irá mostrar-lhe o que os profissionais consideram as melhores técnicas.

Ultimamente, uma boa escrita de instruções requer:

• Claro, escrita simples
• Uma compreensão completa do procedimento em todos os seus detalhes técnicos
• A sua capacidade de se colocar no lugar do leitor, a pessoa que tenta usar as suas instruções
• A sua capacidade de visualizar o procedimento em grande detalhe e capturar essa consciência no papel
• Finalmente, a sua vontade de ir a essa distância extra e testar as suas instruções sobre o tipo de pessoa para quem as escreveu.

Por agora, 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 colocar alguns avisos especiais nos pontos óbvios e já está! 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 estas considerações para planejar suas próprias instruções.

Algumas Preliminares

No início de um projeto para escrever instruções, é importante determinar a estrutura ou características do procedimento particular sobre o qual você vai escrever.

Audiência e situação. No início do processo, defina o público e a situação das suas instruções. Lembre-se que definir uma audiência significa definir o seu nível de familiaridade com o tópico, bem como outros detalhes do género. Veja a discussão de audiências e passos a usar na definição de audiências.

Mais importante, se você estiver em um curso de escrita, você precisará escrever uma descrição de sua audiência e anexá-la às suas instruções. Isto permitirá ao seu instrutor avaliar as suas instruções em termos da sua exactidão para o público pretendido. E lembre-se também que num curso de escrita técnica é preferível escrever para audiências não especializadas – muito mais um desafio para si como escritor.

Número de tarefas. Quantas tarefas há no procedimento sobre o qual você está escrevendo? Vamos usar o termo procedimento para nos referirmos a todo o conjunto de actividades que as suas instruções se destinam a discutir. Uma tarefa é um grupo semi-independente de ações dentro do procedimento: por exemplo, colocar o relógio em um forno de microondas é uma tarefa no grande procedimento geral de operar um forno de microondas.

Um procedimento simples como trocar o óleo em um carro contém apenas uma tarefa; não há agrupamentos semi-independentes de atividades. Um procedimento mais complexo como a utilização de um forno de microondas contém muitas dessas tarefas semi-independentes: ajustar o relógio; ajustar o nível de potência; utilizar o temporizador; limpar e manter o forno de microondas, entre outras. (As instruções de utilização de uma câmara estão organizadas 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 conjunto de baloiço 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. Uma fase então é um grupo de passos semelhantes dentro de um procedimento de uma única tarefa. No exemplo do swing-set, configurar o quadro seria uma fase; ancorar a coisa no chão seria outra; montar o balanço da caixa seria ainda outra.

Best approach to the step-by-step discussion. 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 características das ferramentas).

Em uma abordagem de tarefa (também conhecida como orientação de tarefa) para instruções sobre como usar um serviço de atendimento telefônico, você teria estas seções:

• gravar a sua saudação
• discrever as suas mensagens
• saving your messages
• forwarding your messages
• deletar as suas mensagens, e assim por diante

Estas são tarefas – coisas típicas que gostaríamos de fazer com a máquina. Para mais discussão, veja o capítulo sobre análise de tarefas.

Por outro lado, em uma abordagem de ferramentas para instruções sobre como usar uma fotocopiadora, haveria estas seções improváveis:

• botão de cópia
• botão de cancelamento
• botão de ampliação/redução
• botão de colar/agrupar
• botão de tamanho de fotocopiadora, e assim por diante

Se tivesse concebido um conjunto de instruções sobre este plano, escreveria passos para usar cada botão ou recurso da fotocopiadora. As instruções usando esta abordagem de ferramentas são difíceis de fazer funcionar. Às vezes, o nome do botão não corresponde bem à tarefa à qual está associado; às vezes você tem que usar mais do que apenas um botão para realizar a tarefa. Ainda assim, pode haver momentos em que a abordagem ferramentas/funções pode ser preferível.

Grupos 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 de tarefas comuns em instruções:

1. Desempacotar e configurar tarefas
2. Instalar e personalizar tarefas
3. tarefas básicas de operação
4. tarefas de manutenção de rotina
5. tarefas de resolução de problemas; e assim por diante

Seções comuns nas instruções

A seguir está uma revisão das secções que normalmente se encontram nas instruções. Não assuma que cada uma delas deve estar nas instruções que você escreve, nem que devem estar na ordem apresentada aqui, nem que estas são as únicas seções possíveis num conjunto de instruções.

Como você leu o seguinte nas seções comuns das instruções, confira as 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. Planeie cuidadosamente a introdução às suas instruções. Certifique-se de fazer qualquer uma das seguintes coisas (mas não necessariamente nesta ordem) que se aplicam às suas instruções específicas:

• Indique as tarefas ou procedimentos específicos a serem explicados, bem como o âmbito da cobertura (o que não será coberto).
• Indique o que o público precisa em termos de conhecimento e experiência para compreender as instruções.
• Dê uma ideia geral do procedimento e do que este realiza.
• Indique as condições em que estas instruções devem (ou não) ser usadas.
• Dê uma visão geral do conteúdo das instruções.

Veja a secção de introduções para discussão posterior.

Aviso geral, cuidado, avisos de perigo. As instruções muitas vezes devem alertar os leitores para a possibilidade de arruinar o equipamento, estragar o procedimento e se machucar. Além disso, as instruções devem muitas vezes enfatizar pontos-chave ou exceções. Para estas situações, você usa avisos especiais – nota, advertência, cuidado e avisos 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 de fundo relacionada com o procedimento. Para certas instruções, este fundo é crítico – de outra forma, as etapas do procedimento não fazem sentido. Por exemplo, você pode ter tido alguma experiência com aqueles applets de software em que você define suas próprias cores ao tocar as barras deslizantes vermelha, verde e azul. Para realmente entender o que você está fazendo, você precisa ter algum fundo sobre cores. Da mesma forma, você pode imaginar que, para certas instruções usando câmeras, alguma teoria também pode ser necessária.

Equipamento e suprimentos. Note que a maioria das instruções incluem uma lista das coisas que você precisa reunir antes de iniciar o procedimento. Isso inclui equipamentos, as ferramentas que você usa no procedimento (como tigelas de mistura, colheres, panelas, martelos, brocas e serras) e suprimentos, as coisas que são consumidas no procedimento (como madeira, tinta, óleo, farinha e pregos). Nas instruções, estas normalmente estão listadas ou em uma lista vertical simples ou em uma lista de duas colunas. Use a lista de duas colunas se você precisar adicionar algumas especificações a alguns ou todos os itens – por exemplo, marcas, tamanhos, quantidades, tipos, números de modelos e assim por diante.

Discussão dos passos. Quando você chegar à escrita real dos passos, há várias coisas a ter em mente: (1) a estrutura e formato desses passos, (2) informações suplementares que podem ser necessárias, e (3) o ponto de vista e estilo geral de escrita.

Estrutura e formato. Normalmente, nós imaginamos um conjunto de instruções como sendo formatadas como listas numeradas verticais. E a maioria delas são, de fato. Normalmente, você formata as suas instruções passo a passo desta forma. Existem algumas variações, contudo, assim como algumas outras considerações:

• Passos de ordem fixa são passos que devem ser executados na ordem apresentada. Por exemplo, se você estiver trocando o óleo em um carro, drenar o óleo é um passo que deve vir antes de colocar o novo óleo. Estas são listas numeradas (normalmente, listas numeradas na vertical).
• Passos de ordem variável são passos que podem ser executados em praticamente qualquer ordem. Bons exemplos são os guias de resolução de problemas que lhe dizem para verificar isto, verifique se onde está a tentar corrigir alguma coisa. Você pode fazer estes tipos de passos em praticamente qualquer ordem. Com este tipo, a lista de bulleted é 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 bulleted lists com este tipo, com OR inserido entre as alternativas, ou o lead-in indicando que as alternativas estão prestes a ser apresentadas.
• Nested steps. Em alguns casos, as etapas individuais de um procedimento podem ser bastante complexas por direito próprio e precisam ser decompostas em sub-passos. Neste caso, você recuar mais e sequenciar as sub-passos como a, b, c, e assim por diante.
• Instruções “Stepless”. E finalmente existem instruções que realmente não podem usar lista vertical numerada e que fazem pouco ou nenhum direcionamento do leitor em estilo instrucional. Algumas situações devem ser tão generalizadas ou tão variáveis que os passos não podem ser indicados.

Ver o capítulo sobre listas para o estilo e formato destas possibilidades.

Discussão suplementar. Muitas vezes, não é suficiente simplesmente dizer aos leitores para fazer isto ou aquilo. Eles precisam de informações explicativas adicionais, como como a coisa deve ser antes e depois do passo; por que eles devem se importar em fazer este passo; que princípio mecânico está por trás do que eles estão fazendo; ainda mais uma explicação micro-nível da discussão de passos das ações específicas que compõem o passo.

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 seja enterrado num monte de palavras. Há pelo menos duas técnicas para evitar este problema: você pode dividir a instrução do suplemento em parágrafos separados; ou você pode negritar a instrução.

Dobrar os passos reais do usuário nas instruções. O texto em negrito ajuda a distinguir a acção real da informação suplementar.

Estilo de escrita. A forma como escreve realmente as instruções, frase por frase, pode parecer contraditória com o que as aulas anteriores de escrita lhe ensinaram. No entanto, note como as instruções do “mundo real” são escritas – elas usam muitos tipos imperativos (comando, ou endereço direto) de escrita; elas usam muitos tipos de “você”. Isso é totalmente apropriado. Você quer entrar na cara do seu leitor, chamar toda a atenção dele ou dela. Por essa razão, as frases ao estilo de instrução soam como estas: “Agora, pressione o botão de pausa no painel frontal para parar o visor temporariamente” 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 Pausa deve ser pressionado para parar o visor temporariamente.” Não só estamos preocupados com a saúde mental do botão Pausa, mas também nos perguntamos quem é suposto deprimir a coisa (você está falando comigo?). Ou considere este exemplo: “O botão Temporizador está então definido para as 15:00.” Novamente, como a pessoa que segue estas instruções, você pode perder isto; você pode pensar que é simplesmente uma referência a algum estado existente, ou você pode se perguntar: “Eles estão falando comigo?” Quase tão mau é usar a terceira pessoa: “O usuário deve então pressionar o botão de pausa.” Mais uma vez, é o velho 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 com o estilo de escrita nas instruções é que as pessoas parecem querer deixar de fora os artigos: “Pressione o botão Pausa no painel frontal para parar temporariamente a exibição de informações” ou “Earthperson, por favor forneça a morada do restaurante de pizza mais próximo.” Porque é que fazemos isto? Será que todos nós secretamente queremos ser robôs? De qualquer forma, certifique-se de incluir todos os artigos (a, an, the) e outras palavras que normalmente usaríamos em instruções.

Gráficos em Instruções

Provavelmente mais do que em qualquer outra forma de escrita (excepto talvez para banda desenhada), os gráficos são cruciais para as instruções. Às vezes, as palavras simplesmente não conseguem explicar o passo. As ilustrações são frequentemente críticas para a capacidade do leitor de visualizar o que é suposto fazer.

Em um curso técnico de escrita, 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 adequados às suas instruções particulares e que não se sinta muito confiante nas suas capacidades artísticas. Existem formas de ultrapassar estes problemas! Dê uma olhada nas sugestões em gráficos. Nesse capítulo, você verá não só sugestões para a criação de gráficos, mas também requisitos sobre seu formato.

Formato em Instruções

Cabeçalhos. Nas suas instruções, faça um bom uso dos cabeçalhos. Normalmente, você quer cabeçalhos para qualquer seção de fundo que você 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 cabeçalhos para requisitos comuns.

Listas. Da mesma forma, as instruções normalmente fazem uso pesado de listas, particularmente listas verticais numeradas para as explicações passo-a-passo reais. Listas verticais simples ou listas de duas colunas são normalmente boas para a seção de equipamentos e suprimentos. Listas em frases são boas sempre que você dá uma visão geral das coisas que estão por vir. Veja listas para requisitos comuns.

Anúncios especiais. Nas instruções, você deve alertar os leitores sobre as possibilidades em que eles podem danificar o equipamento, desperdiçar suprimentos, fazer com que todo o procedimento falhe, ferir a si mesmos ou outros – mesmo que seja grave ou fatal. As empresas foram processadas por falta destes avisos especiais, por avisos especiais mal escritos, ou por avisos especiais que estavam fora do lugar. Consulte os avisos especiais para uma discussão completa sobre o uso adequado destes avisos especiais, bem como o seu formato e colocação dentro das instruções.

Indentação dos avisos nas instruções. No primeiro exemplo, observe como o aviso é recuado em relação ao texto da etapa anterior. No segundo exemplo, observe que o aviso severo é colocado no início antes de qualquer uma das etapas.

Número, abreviaturas, e símbolos. As instruções também usam muitos números, abreviaturas e símbolos. Para orientações sobre estas áreas.

Revision Checklist for Instructions

Quando você reler e revisar as suas instruções, tenha cuidado com problemas como os seguintes:

• Certifique-se de fornecer instruções reais – explicações de como construir, operar ou reparar algo.
• Escreva uma boa introdução – nela, indique o procedimento exato a ser explicado, indique os requisitos do público e forneça uma visão geral do conteúdo.
• Certifique-se de que usa os vários tipos de listas sempre que apropriado. Em particular, use listas verticais numeradas para passos sequenciais.
• Utilize cabeçalhos para marcar todas as seções principais e subtítulos das subseções. (Lembre-se que nenhum cabeçalho “Introdução” é necessário entre o título e o primeiro parágrafo. Lembre-se de não usar cabeçalhos de primeiro nível nesta atribuição; comece com o segundo nível.)
• Utilizar avisos especiais conforme apropriado.
• Certifique-se de usar o estilo e o formato para todos os cabeçalhos, listas, avisos especiais e gráficos, conforme apresentados nestes capítulos. Se isso for um problema, entre em contato com o seu instrutor.
• Utilizar gráficos para ilustrar quaisquer ações ou objetos-chave.
• Fornecer explicação adicional suplementar dos passos conforme necessário.
• Lembrar-se de criar uma seção listando equipamentos e suprimentos, se necessário.

Apreciaria seus pensamentos, reações, críticas em relação a este capítulo: sua resposta-David McMurrey.