Contente
- Coloque-se no lugar do leitor
- O que você precisa entender sobre seus leitores
- Seus leitores já estão frustrados
- Uma nota antes de começar a escrever instruções
- A fórmula mágica para escrever instruções
- A fórmula mágica: o novo método dado
- Agora você está pronto para escrever boas instruções
- Limpeza Final
- Teste de usabilidade suas instruções
- Conclusões e generalizações
Laura é uma redatora técnica. Ela gosta de tocar piano, viajar, belas artes e fazer joias.
Coloque-se no lugar do leitor
Para escrever melhores instruções ou procedimentos de "como fazer" para o computador, você deve primeiro se colocar no lugar do leitor ou do usuário.
O usuário não sabe nada sobre o seu site ou software e não vai (e não deve precisar) se dar ao trabalho de ler todo o conjunto de instruções antes de iniciar seu trabalho. O usuário está simplesmente usando seu produto para cumprir algum objetivo dele (fazer uma compra, pesquisar informações e assim por diante).
O que você precisa entender sobre seus leitores
Primeiras coisas primeiro. Você precisa aceitar o fato de que seus leitores muito provavelmente não querem ler o que você escreveu. Isso significa que, para escrever instruções úteis e eficazes, você primeiro precisa aceitar todas as seguintes verdades:
- Seus leitores / usuários não querem aprender como usar seu produto / serviço; eles querem realizar alguma tarefa ou meta própria.
- Eles só leram a documentação em desespero, depois que o que tentaram fazer falhou.
- Eles agora estão frustrados.
- Eles estão perdidos quanto a como proceder para completar seu objetivo / tarefa.
Seus leitores já estão frustrados
Como redator de instruções, você está começando em uma situação ruim porque os usuários (que você provavelmente não conhece e nunca conhecerá) já estão frustrados com seu produto / serviço no momento em que recorrem às instruções que você escreveu como realizar cada tarefa. Portanto, seja gentil com eles e dê-lhes instruções claras, concisas, definitivas e precisas que os coloque de volta no caminho para atingir seu objetivo o mais rápido possível: É uma forma de bom atendimento!
O padrão torna-se bastante fácil e é aplicável à maioria dos tipos de instruções passo a passo, não apenas às instruções do computador.
Uma nota antes de começar a escrever instruções
Antes de começar a escrever instruções, você precisa saber em que estilo elas devem ser escritas.
Peça um "Guia de estilo da casa" (o departamento de marketing é um bom lugar para começar) e obtenha a última cópia do Manual de estilo para publicações técnicas da Microsoft.Mas e quanto aos usuários do Apple Macintosh? Eles já estão familiarizados com o estilo de redação da Microsoft ou não ficarão confusos com ele, porque você implementará o estilo de redação de forma consistente em todo o manual de instruções.
Um dicionário e um tesauro também nunca fazem mal, embora também possam ser encontrados na Internet, e quais usar devem ser especificados no Guia de Estilo da Casa. Em caso de dúvida, use Merriam Webster, o "padrão ouro" dos dicionários.
A fórmula mágica para escrever instruções
| Onde estou? | O que devo fazer? | O que aconteceu? |
|---|---|---|
Diga ao leitor onde eles estão → | Diga a eles o que fazer → | Descreva os resultados de suas ações |
A fórmula mágica: o novo método dado
Agora você conhece um dos fundamentos da comunicação técnica, seja ou não um escritor profissional. É também conhecido como método dado-novo porque você começa contando ao leitor algo que ele já sabe, um "dado", e então você dá a ele algo "novo". Títulos / cabeçalhos claros são a chave para o sucesso aqui.
Observe que este método ajuda o leitor / usuário já frustrado a entender rapidamente se o seu procedimento específico se aplica à situação deles porque você deu a ele um título claro, se eles estão no ponto de partida correto (porque você disse a eles por onde começar), o que fazer nesse ponto e como devem ser os resultados.
Agora você está pronto para escrever boas instruções
Agora que você conhece as regras de escrita, pode começar a escrever as instruções mantendo a perspectiva do usuário em mente o tempo todo.
Você intitula as instruções "Como realizar a tarefa ABC", certificando-se de que todas as instruções sob este título têm a ver com a realização da tarefa ABC (e nada mais). Agora você está pronto para escrever as instruções por conta própria.
A primeira coisa a fazer é orientar os usuários: diga-lhes onde estão e o que devem ver na tela, como o nome da janela que devem estar vendo. Em seguida, diga a eles quais botões apertar na janela atual e / ou que texto eles precisam digitar em quais campos. Em seguida, diga a eles como chegar à próxima etapa / local e descreva o que devem ver na tela ao realizar essa ação.
Por exemplo:
- De Janela principal, selecione todas as opções que deseja ativar. Clique OK. O Segunda janela aparece mostrando o status atual das opções selecionadas.
- No Segunda janela, verifique se todas as opções selecionadas estão corretas.
- Se todas as opções estiverem corretas, clique Opções de ativação. O Terceira Janela parece.
- Se as opções não estiverem todas corretas, clique Voltar para voltar ao Janela principal e selecione opções diferentes.
Limpeza Final
Quando terminar de escrever, execute o verificador ortográfico e gramatical e peça a um ou mais especialistas no assunto (PMEs) - pessoas que conhecem o produto - que analisem o documento. Faça as alterações, execute novamente o verificador ortográfico e gramatical e peça a alguém para revisar / editar o documento.
Depois de inserir as alterações feitas pelo editor, você geralmente termina (a menos que sua empresa tenha um processo formal de liberação de documentos, que você deve seguir).
Observe que as alterações feitas pelos especialistas no assunto e pelo editor (a exportação do assunto na redação e estilo exatos) devem ser aceitas quase sem questionamento: é seus trabalho para conhecer sua área de especialização. Se você fortemente discordar de uma alteração, só então leve-a ao conhecimento do SME ou do editor, conforme o caso. Caso contrário, faça as alterações sugeridas.
Teste de usabilidade suas instruções
Depois de ter um rascunho muito bom, recrute várias pessoas para testar suas instruções - para repassá-las do início ao fim e anotar (e permitir que você anote) quaisquer áreas nas quais elas se perderam ou se confundiram ou onde as instruções estão erradas.
Idealmente, os testadores de usabilidade devem ser os clientes / usuários reais do produto / site que você documentou. No entanto, em uma situação difícil recrutar algumas pessoas do escritório que não estão familiarizadas com o que você escreveu e fazer com que testem o documento é melhor do que nada. Nesse caso, observe que os testadores são usuários especialistas no assunto, portanto, suas alterações são tão valiosas quanto as de seus PMEs e editores (PMEs) do produto.
O teste de usabilidade em si é uma disciplina ampla demais para ser abordada neste artigo.
No entanto, depois de fazer as alterações no teste de usabilidade, execute as alterações no editor e, se aplicável, no seu produto / serviço de PMEs: talvez uma pequena mudança no produto / serviço, agora ou em uma versão futura, faria uma grande diferença para os usuários.
Conclusões e generalizações
Podemos fazer as seguintes conclusões e generalizações sobre como escrever instruções de software:
- Os leitores ficam frustrados quando estão lendo seu trabalho.
- Você precisa deixar o leitor à vontade, dizendo-lhe onde ele está, o que fazer e onde irá parar.
- Você precisa que os especialistas revisem seu documento para verificar a precisão do produto, bem como a precisão da escrita.
- Você precisa aceitar as alterações feitas por seus especialistas, a menos que você significativamente discordar, caso em que converse com o especialista em questão sobre o assunto.
- O teste de usabilidade é a melhor maneira de garantir que seu documento seja um sucesso ao atender às necessidades dos usuários / leitores. Pode até levar a melhorias no produto!
Este artigo é preciso e verdadeiro, de acordo com o melhor conhecimento do autor. O conteúdo é apenas para fins informativos ou de entretenimento e não substitui aconselhamento pessoal ou consultoria profissional em questões comerciais, financeiras, jurídicas ou técnicas.
