Um dos usos mais comuns e importantes da escrita técnica é fornecer instruções, aquelas explicações passo a passo de como montar, operar, reparar, ou fazer manutenção de rotina em algo. Embora possam parecer intuitivas e simples de escrever, as instruções são alguns dos piores documentos escritos que você pode encontrar. A maioria de nós provavelmente já teve muitas experiências enfurecidas com instruções mal escritas. Este capítulo irá mostrar-lhe o que os profissionais consideram as melhores técnicas no fornecimento de instruções.
Um conjunto eficaz de instruções requer o seguinte:
- Claro, preciso e simples escrito
- Uma compreensão completa do procedimento em todos os seus detalhes técnicos
- A capacidade de se colocar no lugar do leitor, a pessoa que tenta usar suas instruções
- A capacidade de visualizar o procedimento em detalhes e capturar essa consciência no papel
- Vontade de testar suas instruções sobre o tipo de pessoa para quem você as escreveu.
No início de um projeto para escrever um conjunto de instruções, é importante determinar a estrutura ou características do procedimento particular sobre o qual você vai escrever. Aqui estão alguns passos a seguir:
Faça uma análise cuidadosa do público e das tarefas
Tornar o processo, defina o público e a situação das suas instruções. Lembre-se que definir uma audiência significa definir o nível de familiaridade dos seus leitores com o tópico.
Determine o número de tarefas
Quantas tarefas existem 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 microondas é uma tarefa no grande procedimento geral de operar um forno microondas.
Um procedimento simples como trocar o óleo em um carro contém apenas uma tarefa; não há grupos semi-independentes de atividades. Um procedimento mais complexo como a utilização de um forno de microondas contém várias tarefas semi-independentes: ajuste do relógio; ajuste do nível de potência; utilização do temporizador; limpeza e manutenção do forno de microondas, entre outras.
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 a montagem de 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 frame seria uma fase; ancorar a coisa no chão seria outra; montar o swing da caixa seria ainda outro.
3. Determine a melhor abordagem para a discussão passo a passo
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 tarefas (também conhecida como orientação de tarefas) para instruções sobre o uso de um serviço de atendimento telefônico, você teria estas seções:
- Recording your greeting
- Playing back your messages
- Saving your messages
- Forwarding your messages
- Deleting your messages, and so on
These are tasks-the typical things we would want to do with the machine.
Por outro lado, numa abordagem de ferramentas às instruções de utilização de uma fotocopiadora, provavelmente haveria secções sobre como utilizar funcionalidades específicas:
- Botão de cópia
- Botão de cancelamento
- Botão de ampliação/redução
- Botão de retracção/agrupamento
- Botão de cópia, e assim por diante
Se tivesse concebido um conjunto de instruções neste 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.
4. Agrupamentos de design 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 mais facilmente as tarefas individuais. Por exemplo, as seguintes são agrupamentos de tarefas comuns nas instruções:
- Desembalar e configurar tarefas
- Instalar e personalizar tarefas
- Tarefas básicas de operação
- Tarefas de manutenção de rotina
- Tarefas de resolução de problemas.
Seções comuns nas instruções
A seguir está uma revisão das seções que você normalmente encontrará nas instruções. Não assuma que cada uma delas deve estar nas instruções que escreve, nem que devem estar na ordem aqui apresentada, nem que estas são as únicas secções possíveis num conjunto de instruções.
Para formatos alternativos, veja as instruções de exemplo.
Introdução: planeie cuidadosamente a introdução às suas instruções. Pode incluir qualquer um dos seguintes itens (mas não necessariamente nesta ordem):
- Indique as tarefas ou procedimentos específicos a serem explicados, bem como o escopo (o que será e não será coberto)
- Indique o que o público precisa em termos de conhecimento e histórico para entender as instruções
- Dê uma idéia geral do procedimento e o que ele 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.
Aviso geral, cuidado, avisos de perigo: muitas vezes as instruções devem alertar os leitores para a possibilidade de arruinar o equipamento, estragar o procedimento e ferir-se a si próprios. 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.
Fundo técnico ou teoria: no início de certos tipos de instruções (após a introdução), 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, imaginamos um conjunto de instruções como sendo formatadas como listas numeradas verticais. E a maioria delas são, de fato. Normalmente, você formata 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 may be used in cases when individual steps within a procedure are rather complex in their own right and need to be broken down into sub-steps. Neste caso, você recuar mais e sequenciar os sub-passos como a, b, c, e assim por diante.
- Instruções “Step-less”. pode ser usado quando você realmente não pode usar uma lista vertical numerada ou fornecer instruções diretas do leitor. Algumas situações devem ser tão generalizadas ou tão variáveis que os passos não podem ser indicados.
Discussão suplementar: muitas vezes, não é suficiente simplesmente dizer aos leitores para fazerem isto ou aquilo. Eles precisam de informações explicativas adicionais, tais como como como a coisa deve ser antes e depois do passo; por que eles devem se preocupar 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 tudo isso enterrado em um 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.
Estilo de escrita
Colocar os passos-chave do usuário em negrito pode ser uma maneira muito útil para sinalizar claramente o que o leitor precisa fazer. Muitas vezes o verbo comando é negrito; às vezes a fonte em negrito destaca o componente chave que está sendo discutido.
O uso da voz passiva nas instruções pode ser problemático. Por alguma razão estranha, algumas instruções soam assim: “O botão Pausa deve ser pressionado para parar temporariamente o visor.” Não só estamos preocupados com a saúde mental do botão de pausa, mas também nos perguntamos quem é suposto deprimir a coisa (ninjas?). Seria mais útil indicar quando o leitor deve “premir o botão de pausa”. Considere este exemplo: “O botão Temporizador está então definido para as 15:00.” Mais uma vez, pode-se perguntar: “está definido por quem? Ninjas?” A pessoa que segue estas instruções pode pensar que é simplesmente uma referência a algum estado existente, ou ela pode se perguntar: “Eles estão falando comigo?” Usar a terceira pessoa também pode levar a constrangimentos: “O usuário deve então pressionar o botão de pausa.” As instruções normalmente devem ser escritas usando formas de verbos de comando e usando “você” para deixar perfeitamente claro o que o leitor deve fazer.
Illustrating Your Instructions
Talvez mais do que em qualquer outra forma de escrita técnica, 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 geralmente críticas para a capacidade dos leitores de visualizar o que eles devem fazer. Certifique-se de que os gráficos representam a imagem da perspectiva do leitor.
Formatting Your Instructions
Desde que as pessoas raramente querem ler as instruções, mas muitas vezes têm de, formatar as instruções para a capacidade de leitura relutante. Tente fazer seu leitor querer lê-las, ou pelo menos não resistir à idéia de consultá-las. O formato altamente legível permitirá aos leitores que descobriram algumas das instruções por si próprios saltar para a secção onde estão presas. Use o que você aprendeu sobre cabeçalhos, listas, visuais e espaço passivo para criar instruções eficazes e legíveis:
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 reais, e subtítulos para as tarefas ou fases individuais dentro dessa seção.
Listas: da mesma forma, as instruções normalmente fazem uso extensivo 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 do que está por vir.
Notificações Especiais: você pode ter que alertar os leitores para as possibilidades em que eles podem danificar seus equipamentos, resíduos de suprimentos, causar todo o procedimento para falhar, ferir a si mesmos ou outros – mesmo seriamente ou fatalmente. 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.
Ao reler e rever as suas instruções, verifique se elas fazem o seguinte:
- Descreva claramente o procedimento exato a ser explicado
- Dê uma visão geral do conteúdo
- Indique os requisitos do público
- Utilize vários tipos de listas sempre que apropriado; em particular, utilizar listas numeradas para passos sequenciais
- Utilizar cabeçalhos e subtítulos para dividir as seções e subseções principais em uma ordem lógica e coerente
- Utilizar avisos especiais conforme apropriado
- Utilizar gráficos para ilustrar ações e objetos-chave
- Fornecer explicação suplementar adicional dos passos conforme necessário
- Criar uma seção listando equipamentos e suprimentos, se necessário.