Quando escrever instruções, evite uma linguagem persuasiva e adopte uma abordagem baseada em tarefas. Mantenha a escrita concisa e clara, e concentre-se em permitir ao usuário realizar a tarefa com sucesso.

Em geral, siga estas orientações:

Concisão e Clareza

Calibra frases curtas e compreensíveis. Use terminologia comum sempre que possível. Evite usar expressões idiomáticas, gírias, jargões, apelidos, abreviaturas e acrônimos. Se você usar terminologia que possa ser nova ou confusa, então defina claramente cada termo quando ele aparecer pela primeira vez nas instruções.

Audiência

É importante conhecer o seu público ao escrever as instruções, então você está incluindo todas as informações necessárias e excluindo informações desnecessárias. Conhecer o seu público permite que você faça suposições razoáveis e bem informadas com base no provável histórico, experiência e familiaridade do público com o assunto. Por exemplo, se você estiver escrevendo instruções para um grupo de idosos na filial local da biblioteca pública, pode não ser seguro assumir que eles estão familiarizados com os fundamentos da abertura de uma aplicação de software específica. Entretanto, se você estiver escrevendo instruções para um grupo de desenvolvedores de software dentro de uma organização profissional, pode ser seguro assumir que eles estão familiarizados com o básico de abrir um aplicativo de software específico.

Ao decidir que informações incluir e excluir das instruções, é importante identificar claramente quem é o seu público e qual é a sua provável proficiência com o tópico das instruções e informações básicas relacionadas.

Se for provável que um público tenha uma ampla gama de experiência e conhecimento que inclua vários níveis de familiaridade e especialização, você pode usar várias técnicas para manter cada conjunto de instruções concisas e focadas em uma única tarefa, ao mesmo tempo em que fornece as informações necessárias. Por exemplo, você pode criar instruções separadas para informações pré-requisitos e fornecer ao seu público os meios para acessar rápida e facilmente as instruções separadas (através de hiperlinks, apêndices, etc.).

Gráficos

Fotos falam mais alto do que as palavras. Adicionar gráficos para transmitir os seus pensamentos pode ser mais eficaz do que as próprias palavras. As instruções que são bem ilustradas e acompanham as suas instruções escritas são geralmente muito bem sucedidas. Adiciona um nível extra de compreensão e permite ao leitor escumar ou solucionar problemas caso ocorram. As imagens acrescentam uma dimensão adicional que permitirá ao seu leitor visualizar o produto final. Além disso, ao usar gráficos você deve estar atento aos alunos visuais, e adaptar os gráficos.

Embora as imagens sejam ótimas, você deve ser cauteloso para não incluir fotografias ou ilustrações que sejam confusas ou não associadas com as instruções escritas reais. Se você emparelhar uma imagem pobre com suas instruções, você pode causar estresse ao leitor ou introduzir confusão ao tentar decifrar o que você quer dizer.

Também, ao tirar fotos, certifique-se de que a área esteja bem iluminada e que as imagens sejam claras e brilhantes. Fotos escuras ou confusas são muitas vezes difíceis de seguir. Tome cuidado para fotografar o sujeito na mesma orientação cada vez para evitar confusão e considere usar um tripé.

O tamanho também é importante quando usar imagens em instruções. Uma imagem que é muito pequena para ser vista é tão inútil como uma imagem desfocada.

Para ser poderoso e compreensível, seu texto e gráfico para cada passo deve estar claramente correlacionado com aquele passo das instruções.

Formatação

Lembrar que os leitores estarão realmente executando a tarefa enquanto lêem junto com as instruções. Portanto, você não deve usar blocos sólidos de texto pequenos e difíceis de decifrar. Certifique-se de criar um design e layout para a sua página de instruções que permita uma leitura fácil e acrescente qualidade estética. Manter a página simples, mas com uma hierarquia definida, ajudará o leitor a completar os passos das instruções.

Ao desenhar sua página, uma hierarquia sólida é importante para a capacidade de leitura. O uso de títulos em negrito, itálico e numerais romanos ajudará o leitor a encontrar seu lugar facilmente e ajuda na aparência visual geral.

Ordem

É importante que suas instruções sejam planejadas em uma progressão lógica. Assegure-se de indicar o problema claramente na primeira página. Siga os seus problemas com um conjunto de passos específicos que detalham como resolver o problema proposto. As instruções técnicas devem fluir em um padrão lógico. Por exemplo, ao montar uma mesa, não seria bom se você colocasse os toques finais nela antes de ter todos os parafusos no lugar. Como dito anteriormente, também deve haver gráficos claros onde for necessário para esclarecer a ação. Lembre-se, uma imagem vale mais que mil palavras.

Teste e Verificação

Todos nós sabemos que as instruções são difíceis de escrever e que às vezes soa bem no papel, mas quando você realmente tenta colocar as instruções para usar, você pode descobrir que a sua frase não faz sentido para os outros. Lembre-se que o que pode ser comum ou óbvio para você pode confundir seus leitores, então conheça seu público. Além de testar as suas instruções em si mesmo, peça a alguém que não saiba nada sobre o seu produto para testá-lo. Isto é chamado de estudo de usabilidade. Tome notas sobre o que funcionou e o que não funcionou e depois reveja as suas instruções em conformidade. A longo prazo, quanto mais pessoas testarem as suas instruções, mais eficaz será o conjunto final.