Escrever documentos de trabalho que o leitor entenda rápido e consiga seguir

## Antes de escrever, definir quem vai ler e o que precisa fazer Antes de redigir, identifique: - quem usará o documento; - o que essas pessoas já sabem; - o que precisam aprender ou decidir; - que ação, se houver alguma, devem realizar; e - que restrições ou riscos podem afetar o uso das informações. Escreva para o leitor pretendido com menos conhecimento que ainda precise agir corretamente. Se vários públicos tiverem necessidades diferentes, separe seus percursos ou identifique claramente as seções aplicáveis a cada um. ## Colocar a resposta principal primeiro, na ordem das perguntas do leitor Apresente o propósito e a mensagem mais importante perto do início. Organize o restante na ordem em que o leitor provavelmente fará perguntas, e não na ordem em que quem escreve descobriu as informações. Use esta sequência quando for adequada: 1. Explique por que o documento é importante. 2. Apresente a decisão, a exigência ou a resposta principal. 3. Explique o que o leitor precisa saber ou fazer. 4. Acrescente detalhes de apoio, exceções e referências. Inclua informações porque elas ajudam o leitor a compreender ou agir. Transfira o conteúdo de contexto necessário apenas para poucos leitores para uma seção posterior claramente identificada. ## Dividir textos longos com títulos que antecipem o conteúdo Divida conteúdos longos em seções curtas e focadas. Dê a cada seção um título que antecipe seu conteúdo ou responda a uma provável pergunta do leitor. Não use mais de três níveis de títulos, a menos que o documento realmente precise de uma hierarquia mais profunda. Seções paralelas devem usar redação paralela e níveis comparáveis de detalhe. Um título não deve prometer um conteúdo que a seção não oferece. Quando o leitor precisar de contexto antes dos detalhes, inicie uma seção densa com uma breve frase de orientação. ## Dizer quem é responsável por cada ação Prefira frases que indiquem diretamente o responsável e a ação. - Use a voz ativa quando a responsabilidade for importante. - Use a voz passiva quando o agente for desconhecido, irrelevante ou intencionalmente secundário. - Mantenha o agente próximo da ação. - Apresente as condições antes ou junto da instrução que elas limitam. Não use a voz passiva para ocultar que ainda não há um responsável definido. Se a responsabilidade for compartilhada, nomeie os papéis e diferencie suas ações. ## Usar palavras conhecidas e chamar sempre a mesma coisa pelo mesmo nome Use a palavra mais simples que seja exata. Prefira linguagem conhecida a jargão, expressões rebuscadas ou abreviações sem explicação. Mantenha um termo técnico quando ele for necessário para garantir precisão ou quando os leitores precisarem reconhecê-lo em outro lugar. Defina-o no primeiro uso e, depois, use o mesmo termo de forma consistente. Não alterne entre quase sinônimos se a mudança puder sugerir um significado diferente. Desfaça longas sequências de substantivos em expressões que revelem as relações entre as ideias. ## Deixar claro se uma ação é obrigatória ou só recomendada Expresse ações com verbos, em vez de escondê-las em substantivos abstratos. Prefira formas verbais diretas e o presente quando eles descreverem com exatidão a regra, o processo ou o estado atual. Escolha deliberadamente as palavras que expressam obrigação: - use **must** para uma exigência; - use **may** para uma permissão; - use **should** para uma recomendação; e - use **will** para uma ação futura prevista ou prometida. Não recorra a um verbo modal ambíguo quando os leitores precisarem saber se uma ação é obrigatória, opcional, recomendada ou esperada. ## Tirar palavras repetidas e deixar uma ideia por frase Elimine palavras que repitam uma ideia, acrescentem formalidade sem significado ou digam o que o leitor já pode deduzir. Prefira um termo preciso a termos em pares que signifiquem quase a mesma coisa. Mantenha cada frase concentrada em uma ideia principal. Divida uma frase quando suas condições, exceções e ações disputarem a atenção. Coloque os modificadores junto das palavras que modificam e mantenha cada condição próxima do resultado que ela controla. Use uma formulação positiva quando ela for mais clara do que uma construção negativa. Mantenha a forma negativa quando ela expressar a regra com mais exatidão ou evitar um mal-entendido perigoso. ## Usar listas e tabelas para o documento ser lido rápido Use a estrutura visual para revelar o significado: - marcadores para itens sem sequência obrigatória; - números para etapas ou itens classificados; - tabelas para comparações repetidas; - espaços em branco para separar ideias; e - ênfase moderada para distinções realmente importantes. Mantenha consistentes a tipografia, o espaçamento, os rótulos e o alinhamento. Evite elementos decorativos que disputem a atenção com a mensagem. Escolha um layout que continue compreensível ao ser copiado, redimensionado, impresso ou visualizado em uma tela estreita. Altere um formato antigo quando ele impedir os leitores de encontrar ou usar as informações, a menos que uma exigência vinculante impeça a mudança. ## Antes de entregar, reler como leitor e conferir nomes e números Antes da entrega, leia o documento uma vez como se não tivesse sido você quem o escreveu. Confirme que o leitor pretendido consegue: 1. identificar rapidamente o propósito; 2. encontrar a seção relevante; 3. compreender a ação ou decisão exigida; 4. diferenciar regras de recomendações e exemplos; e 5. reconhecer condições, exceções, responsáveis e prazos. Em seguida, verifique a exatidão e a consistência de nomes, números, links, rótulos, linhas de assunto e formatação. Remova qualquer frase que gere uma pergunta à qual o documento deveria ter respondido.