Criação de Manuais de Instruções Retoricamente Eficazes

Manuais de Instruções

Muitas pessoas associam manuais de instruções a aparelhos, acessórios de computador e produtos que requerem montagem (por exemplo, móveis). Como não os utilizamos regularmente ou só os esperamos em determinados contextos, é fácil esquecer a sua importância. A qualidade de um manual de instruções bem desenhado pode passar despercebida. No entanto, quando nos deparamos com a frustração de montar uma estante ou brinquedo, ou de tentar descobrir como mudar ou activar um determinado aparelho, o significado de um manual de instruções bem concebido torna-se claro.

Entendendo a situação retórica dos manuais de instruções

Manuais de instruções, tal como outros tipos de textos, são moldados por uma situação retórica. As escolhas que os redactores técnicos fazem em relação ao conteúdo e à forma dependem da finalidade do manual de instruções, do público visado e do contexto em que o manual é utilizado. Ao escrever o seu próprio manual de instruções, considere as seguintes ideias e perguntas relativas à situação retórica.

Propósito

Em geral, o propósito de um manual de instruções é familiarizar o utilizador com o produto e/ou guiá-lo através de uma série de passos que conduzem à conclusão de uma tarefa. Entretanto, cada manual de instruções também terá um resultado mais específico. A identificação do resultado específico ajudará a tomar decisões retóricas mais eficazes sobre o conteúdo e o design. Pergunte-se:

Quais são os resultados específicos pretendidos das instruções? (por exemplo, assar um bolo do zero, instalar um ar condicionado, etc.)
Além de ajudar os usuários a alcançar o(s) principal(is) resultado(s) desejado(s), existem outros propósitos que o manual serve? (por exemplo, oferecer conselhos de resolução de problemas, ensinar aos usuários como realizar tarefas adicionais e simples necessárias para alcançar o objetivo principal)

Audiência

Criar um perfil do seu público (ou seja, o usuário principal pretendido do documento) é essencial para fazer escolhas ponderadas sobre o escopo, o conteúdo e o design. Considere estas perguntas sobre a audiência antes de escrever:

Qual é a familiaridade ou perícia da audiência a respeito do tópico do manual de instruções?
Qual é o nível de conforto geral da audiência com a aprendizagem de novas habilidades relacionadas com o software, aplicações, receitas, etc.?
Qual é a abordagem “típica” da sua audiência à aprendizagem? Como seu manual de instrução abordará o estilo de aprendizagem da audiência, objetivos, e necessidades relacionadas à tarefa?

Contexto

Pense no contexto como a situação temporal, social, tecnológica, e cultural em torno da criação e uso do manual de instrução. As seguintes questões irão ajudá-lo a identificar o contexto:

Quanto tempo terá para completar este manual de instruções?
Há restrições de tempo para o utilizador?
Que restrições tecnológicas deve considerar ao criar o manual de instruções? Considere suas habilidades com tecnologia e nível de acesso.
Como o seu público terá acesso ao manual? (por exemplo, o público pode acessar o manual online através de um website da empresa)
Que ferramentas ou materiais adicionais você está assumindo que o público já tem? Eles terão acesso à tecnologia ou aos materiais necessários para seguir as instruções? (por exemplo, para construir com sucesso uma estante, o usuário precisará de um martelo, uma chave de fendas e uma área de trabalho aberta)
De que perspectiva cultural você está escrevendo o manual de instruções? O público irá compartilhar esse mesmo contexto cultural? (por exemplo, uma receita alemã que pede açúcar de baunilha, um ingrediente não disponível prontamente nos Estados Unidos, pode precisar ser modificado para usuários americanos)

Usando o conhecimento da situação retórica para fazer escolhas retóricas efetivas

Embora a maioria dos manuais de instruções dependa de algumas convenções padrão, cada manual de instruções deve ser adaptado para atingir um propósito específico para um determinado público dentro de um determinado contexto. A secção seguinte introduz algumas características comuns aos manuais de instruções, ao mesmo tempo que leva em consideração a situação retórica e como ela pode requerer desvios de certas convenções.

Escopo

A situação retórica ajuda a determinar a quantidade de detalhes a incluir num manual de instruções. Por exemplo, o escopo de um manual de instruções para montar uma mesa é fácil de determinar porque tem apenas um resultado: montar a mesa. Entretanto, um manual de instruções para uma câmera Digital Single Lens Reflex (DSLR) pode ser escrito tanto para usuários amadores quanto para usuários mais experientes e pode precisar incluir instruções para completar tarefas básicas (por exemplo, instalar a bateria e o cartão de memória), bem como tarefas mais avançadas (por exemplo ajuste de configurações para ambientes de disparo específicos).

Conteúdo

Algumas secções padrão dos manuais de instruções incluem matéria frontal, uma introdução, uma série de passos, uma conclusão e matéria posterior, embora alguns manuais possam não utilizar todas estas secções ou rotulá-las desta forma. A matéria frontal e posterior extensas, por exemplo, são frequentemente encontradas em manuais mais longos e complexos. A maioria dos conjuntos de instruções, contudo, contém uma introdução que fornece as informações necessárias para completar os passos de forma segura e eficiente. A introdução pode incluir uma explicação de quem deve realizar a tarefa (talvez o usuário precise ter proficiência em determinada habilidade), os materiais necessários, quaisquer precauções que o usuário deve tomar (dicas de segurança ou outros avisos) e, em alguns casos, uma estimativa de quanto tempo o processo levará (uma característica comum das receitas). Em alguns casos, é necessário incluir uma explicação do motivo pelo qual o usuário deve seguir as instruções. Por exemplo, instruções para trocar o óleo de um carro podem explicar porque a tarefa é necessária para o bom funcionamento do veículo.

Seguir este material introdutório é a sequência de instruções passo a passo. Consulte a secção seguinte sobre “Idioma” para saber como esboçar passos claros e eficazes. Finalmente, um manual de instruções pode incluir um “Guia de Resolução de Problemas” ou uma secção de “Dicas” para ajudar os utilizadores a resolver problemas comuns que possam encontrar ao seguir as instruções ou após completar o processo.

Linguagem

As perguntas sobre “Audiência” e “Contexto” acima podem ajudá-lo a fazer escolhas de linguagem eficazes. As subseções seguintes incluem explicações de características linguísticas comuns dos manuais de instruções, juntamente com dicas para escrever clara e concisamente neste gênero.

Imperative mood

Instructions, like commands, often use the imperative mood. Para escrever desta forma, dirija-se diretamente ao público usando voz ativa e verbos específicos. Qual das seguintes instruções fornece o passo mais claro?

“Pressione o botão vermelho para começar a jogar o jogo”
“Quando o botão vermelho é pressionado, o jogo começará”
“O operador deve pressionar o botão”

Embora um usuário possa provavelmente fazer sentido de qualquer uma destas frases, a primeira fornece a explicação mais clara sobre qual ação deve ser executada pelo usuário. A segunda, construção passiva, não especifica quem deve pressionar o botão. O terceiro exemplo refere-se a um assunto vago, o “operador”, que pode confundir o usuário.

Word Choice

Quando escrever instruções, uma cuidadosa consideração da escolha de palavras é importante porque em alguns casos, a segurança do usuário está em risco. Por este motivo, esforce-se por clareza e concisão. Para tomar decisões eficazes sobre a escolha de palavras, considere o nível de conhecimento e a cultura do seu público primário. Você pode achar necessário

definir termos complexos.
escrever acrônimos na primeira vez em que são introduzidos (por exemplo câmera reflexa digital de lente única, DSLR).
evitar o uso de similes, metáforas, gírias ou substituições que possam confundir os usuários.
usar linguagem simples, pois em alguns casos, podem surgir sérias consequências legais quando um conjunto de instruções não é claro. Para mais informações sobre linguagem clara, veja http://www.plainlanguage.gov/index.cfm
incluir traduções das instruções em várias línguas.
usar títulos e subtítulos breves e informativos

Consistência e Paralelismo

Estrutura paralela, ou paralelismo, significa usar a mesma estrutura gramatical para apresentar informações ou idéias. O paralelismo é frequentemente usado para melhorar a legibilidade e criar consistência.

Esta lista numérica de instruções contém um passo que quebra a estrutura paralela. Qual destes passos parece diferente dos outros?

Remover o parafuso para abrir o compartimento da bateria.
Inserir baterias, seguindo a imagem no compartimento da bateria.
Agora pode fechar o compartimento, e aparafusá-lo.

Três passos quebram a estrutura paralela da lista porque não começa com um verbo diretivo.

Os seguintes cabeçalhos usam estrutura paralela? Porque ou porque não?

“Instalar baterias”
“Desligar/ligar dispositivo”
“Como carregar o seu dispositivo”

Design

Design do documento refere-se à forma como a informação é organizada e apresentada. Como os visuais requerem menos tempo para serem processados, os usuários normalmente notarão – e responderão – a qualidade do design antes da qualidade do conteúdo. Mesmo se você optar por não incluir imagens ou gráficos, você precisará considerar o design. No mínimo, isso inclui fazer escolhas sobre layout, ordem das informações, tamanho da fonte, tipo de letra, cabeçalho, cor e espaço em branco. Os elementos de design devem guiar o usuário através do manual de forma suave. Isso significa tornar o documento digitalizável; um documento digitalizável permite aos usuários navegar pelo conteúdo para localizar informações específicas. Como em qualquer documento, as decisões relativas ao design devem considerar o público, a finalidade e a facilidade de uso.

Consistência/Repetição

Usar um elemento de design de forma uniforme em todo o documento guia os usuários, dando-lhes uma noção do que esperar (por exemplo, a mesma fonte e tamanho para todos os cabeçalhos; o mesmo layout de página para página).

Contraste

Usar um elemento de design para destacar informações ou características específicas do manual (por exemplo, capitalizar uma palavra para ênfase; colocar uma caixa ou borda em torno de um item; mudar as cores para ênfase). O contraste é principalmente eficaz quando um documento usa consistência em geral. Se houver falta de consistência, é mais difícil criar contraste.

Alinhamento

Organizar itens em uma página com alinhamento horizontal e/ou vertical cria hierarquia e estrutura, e pode ser usado para ajudar a alcançar equilíbrio, contraste ou consistência. Por exemplo, este documento usa alinhamento vertical para criar uma hierarquia entre o nome de um elemento de desenho, que é deixado alinhado, e sua descrição, que é indentada.

Balance

Distribuindo os itens uniformemente através de um determinado espaço. Para conseguir isso, o peso de cada item – isto é, a tendência do olho para gravitar em direção a um item – deve ser considerada. Por exemplo, como uma imagem pesa mais do que o texto, as decisões sobre a colocação da imagem devem considerar como equilibrar o seu peso em relação a outros itens, a fim de evitar confusão visual.

Espaço Branco

Utilizar espaço branco para criar um documento profissional e equilibrado. Em vez de indicar a cor do espaço, este elemento de desenho refere-se a uma ausência de imagens e texto. O espaço em branco ajuda a distinguir entre itens individuais e grupos de itens (ou seja, secções do manual) e facilita a digitalização de documentos.

Agrupamento/Proximidade

Colocar imagens ou conteúdos relacionados uns com os outros. Por exemplo, agrupar imagens de todos os materiais necessários para completar a tarefa dada.

Cor

Selecionar cores para criar contraste e ênfase, para guiar os leitores através do espaço e para projetar um documento visualmente agradável. Você deve considerar o documento em geral, a fim de criar um esquema de cores consistente. Por exemplo, se você quiser usar azul no seu documento, você vai querer garantir que ele seja usado consistentemente e complementa outras cores do documento. Isto é particularmente importante ao integrar gráficos e/ou imagens a cores.

Imagens

Selecionar imagens apropriadas para o contexto e propósito do manual. Você deve considerar se as imagens se destinam a ficar isoladas ou a complementar as instruções escritas. Considere tipos de imagens, tais como desenhos, fotos e ilustrações gráficas e se são necessários avisos ou anotações adicionais para destacar partes específicas da imagem. As imagens devem ser escolhidas para complementar outros elementos de desenho no manual.

Conclusão

Um bom manual de instruções começa com uma cuidadosa consideração da situação retórica – propósito, público e contexto. Esta informação é fundamental para fazer escolhas apropriadas e eficazes sobre o conteúdo, linguagem e design. Em um cronograma ideal, escritores técnicos têm a oportunidade de conduzir testes de usabilidade, que são projetados para avaliar quão bem um documento cumpre seu propósito. Uma vez que seu manual de instruções seja testado, você incorporará o feedback recebido para finalizar seu design e conteúdo.

Exercício 1 – Familiarize-se com manuais de instruções

O site a seguir contém vários exemplos de manuais de instruções de código aberto. Siga este link, navegue pela lista, e escolha um manual para ver em profundidade. Navegue pelo manual para se familiarizar com o seu conteúdo e design. Depois, num memorando ao seu instrutor ou colegas de turma, dirija-se ao seguinte.

Identificar a situação retórica

Quem é o público? Como você sabe quem é a platéia? O que você pode supor sobre a audiência com base no conteúdo e escolhas de design no manual?
Qual é a finalidade do documento? Como você sabe que este é o propósito principal (isto é, que conteúdo e escolhas de projeto sinalizam o propósito)?
Que contexto informa o conteúdo escrito e projeto deste manual?

Examinar escolhas de composição

Descrever o escopo geral e a organização do manual. Quão detalhado é o manual? O que ele cobre? Como é organizada a informação?
Todas as “características padrão” do conteúdo deste manual? Porquê ou porque não? Existem funcionalidades adicionais? Quais são elas e quais são os seus objectivos?
Localize e descreva exemplos de escolha de linguagem eficaz. Explique por que você os acha eficazes.
Localizar e descrever exemplos de design eficaz. Explique porque os considera eficazes.
Se fosse o autor deste manual, o que teria feito de diferente e porque?

Exercício 2 – Planear um manual de instruções

Imagine que está a escrever um manual de instruções para um processo ou produto com o qual está familiarizado e aborde as seguintes instruções.