Revisão de Poder: Revisão em Nível de Estrutura

Uma das maneiras mais importantes de revisar um rascunho é verificar o conteúdo—quão óbvio é isso! Todas as boas transições, boa organização e estrutura de frase clara do mundo não podem ajudar um documento técnico que não tenha o conteúdo certo. O conteúdo de um documento técnico pode estar "errado" de várias maneiras:

• Pode estar completamente ausente: por exemplo, imagine que alguém escreveu um relatório sobre "comunidades virtuais" mas nunca se preocupou em definir o que esse termo significa. Seria difícil desde o início desse relatório.
• Está lá, mas não é suficiente: pegue o mesmo exemplo—imagine que o escritor fez apenas algumas declarações vagas sobre comunidades virtuais. O que era necessário era pelo menos um parágrafo sobre o assunto, se não uma seção completa de 3 ou 4 páginas.
• Está lá, mas no nível errado para o público: Também é possível apresentar informações em um nível inadequado em termos de conhecimento, formação ou necessidades dos leitores. Imagine que o escritor incluiu uma seção de 3 páginas sobre cache de dados, mas escrita para o desenvolvedor de produto (um "especialista") quando o relatório era realmente destinado a não especialistas.

Se você consegue perceber como a informação é inadequada em um rascunho de relatório, você deve estar bem encaminhado para saber o que especificamente fazer para revisar. Uma ferramenta de brainstorming útil é pensar em termos de tipos de conteúdo.

Use as perguntas fornecidas em conteúdo do documento para revisar seu rascunho para tipos de informações a adicionar ou mudar.

Verifique a estrutura dos seus conteúdos

Existem duas maneiras de olhar para a organização da informação em um documento:

• um, coberto na próxima seção, envolve olhar para a sequência de blocos de informação, verificando se estão na ordem correta.
• Outra está relacionada aos níveis de informação. Você pode olhar para as frases ou parágrafos em um rascunho e ver que algumas frases discutem o tópico em um nível mais profundo do que outras. Outras frases atuam como a estrutura sobre a qual essas frases de nível mais profundo dependem. Ao analisar a estrutura dessa maneira, você não só verifica sua organização, mas também obtém muitas boas ideias sobre como melhorar o conteúdo do texto.

Uma explicação muito mais detalhada é fornecida em coordenação e subordinação em parágrafos.

Verifique a organização

Se você tem o conteúdo certo em um relatório, pelo menos você tem todas as "coisas certas" disponíveis para os leitores. No entanto, ainda pode não estar adequadamente organizado—como quando você acaba de se mudar e tudo está uma bagunça ou ainda em caixas. Você precisa de duas habilidades essenciais para revisar a organização de um rascunho:

• Identificar o tópico de partes de informação em vários níveis. Para avaliar a organização de uma sequência de parágrafos, você começa pensando em uma palavra ou frase para identificar o tópico de cada parágrafo—em outras palavras, compreenda cada um. Em seguida, você se afasta dessas palavras ou frases, considerando se estão na sequência correta. No entanto, isso é apenas um nível. Você também pode olhar dentro um parágrafo individual para sua organização. Nesse caso, você identifica o tópico de cada frase e considera a sequência dessas frases.
• Escolha a melhor sequência para os fragmentos de informação. Assim que você souber o tópico de cada um dos pedaços de informação (em qualquer nível que estiver investigando), você pode decidir se estão na sequência correta. Essa decisão envolve conhecer os padrões comuns de sequenciamento; aqui estão alguns exemplos:
  
  
  • General → específico: Uma maneira comum de organizar é dispor blocos de conteúdo do geral para o específico. Por exemplo, definindo tudo coletores solares é uma discussão mais geral do que discutir os diferentes tipos de coletores solares. E descrever o funcionamento de um tipo específico de coletor solar é ainda menos geral. Este padrão é ilustrado aqui:
    
    
    Revisão com o padrão organizacional do geral para o específico. é uma progressão mais natural começar definindo o que todos os coletores solares fazem, e depois passar para seus diferentes tipos.
  • Simples, básico → complexo: Outra maneira de organizar as unidades de uma discussão é começar com as simples, básicas e fundamentais e, em seguida, passar para as mais complexas e técnicas.
  • Coisa-em-repozo → coisa-em-movimento: Outro padrão de organização envolve primeiro descrever a coisa (como se em uma fotografia), e depois discutir sua operação ou processo (como se em um vídeo). Essa abordagem pode funcionar bem para uma discussão sobre um sistema de injeção de combustível.
  • Movimento espacial: — Se você está descrevendo os detalhes físicos de algo, pode querer usar algum padrão de movimento físico, por exemplo, de cima para baixo, da esquerda para a direita, ou de fora para dentro.
  • Movimento temporal: — Um dos padrões mais comuns é baseado no movimento através do tempo; organize a discussão dos eventos em relação à sequência temporal.
  • Conceito → aplicação do conceito, exemplosUm padrão organizacional comum é discutir um conceito em termos gerais e, em seguida, discutir uma aplicação dele. Por exemplo, outro capítulo deste livro discute propostas primeiro de forma conceitual e depois apresenta exemplos de propostas.
  • Dados → conclusões: Outro meio de organizar informações é apresentar dados (observações, dados experimentais, resultados de pesquisas) e depois passar para as conclusões que podem ser tiradas a partir desses dados. (E esse padrão às vezes é invertido: apresenta-se a conclusão primeiro, depois os dados que a apoiam.)
  • Problema, pergunta → solução, resposta: Você também pode organizar informações discutindo primeiro um problema ou levantando uma questão e, em seguida, passando para a solução ou resposta.
  • Versão simplificada → versão detalhada: Uma maneira útil de explicar questões técnicas para não especialistas é começar discutindo uma versão simplificada da coisa, estabelecer uma compreensão sólida dela e, em seguida, voltar e explicar tudo novamente, mas desta vez adicionando os detalhes técnicos de forma densa e pesada!
  • Mais importante → menos importante: Um método de organização mais "retórico" é começar com as informações mais importantes, as mais atraentes, as mais dramáticas primeiro e depois passar para informações que são progressivamente menos impactantes. (E esse padrão pode ser revertido: você pode construir até um clímax, em vez de começar com ele.)
  • Mais convincente → menos convincente: — Da mesma forma, você pode começar com o argumento mais convincente para sua posição—para chamar a atenção de todos—e então passar para argumentos cada vez menos convincentes. (Esse padrão também pode ser invertido: você pode desenvolver seus argumentos até chegar aos mais convincentes.)

Estas são apenas algumas possibilidades. Quando o objetivo é informativo, você organiza as informações de forma a garantir que os leitores compreendam o básico antes de passar para as questões complicadas e técnicas. Quando o objetivo é persuasivo, você organiza as coisas para maximizar o efeito persuasivo sobre os leitores, por exemplo, colocando os argumentos mais fortes primeiro.

E, em qualquer situação, evite misturar essas abordagens—por exemplo, descartando alguns dados, depois declarando algumas conclusões e, em seguida, fazendo isso de maneira aleatória. Mantenha as maçãs separadas das laranjas!

Uma das melhores coisas que você pode fazer é voltar através de um rascunho e verificar se consegue inserir frases tópicas e visões gerais em pontos-chave. Quando escrevemos, normalmente não temos certeza exatamente para onde um parágrafo ou seção está indo em termos de conteúdo e lógica. Uma vez que ele "chegou lá," muitas vezes é necessário voltar ao início e adicionar algum tipo de visão geral ou modificar o que já está lá para tornar a visão geral mais clara. Os leitores precisam saber para onde estão indo em um relatório, o que está por vir e, a propósito, onde estão.

Ter uma visão geral em um relatório é como ter um mapa quando você está em uma cidade nova. Frases tópicas e visões gerais oferecem uma perspectiva sobre o que está onde: o tópico, os subtópicos, o propósito da discussão que se segue, sua relação com a seção anterior e com o documento como um todo. (Agora, parte disso envolve transições, que é o próximo elemento a ser analisado.)

Para um tratamento detalhado deste tópico, veja frases principais e visões gerais.

Você pode ter a informação certa em um relatório e tê-la organizada adequadamente, mas algo importante ainda pode dar errado. Os leitores podem perder o "fluxo" das ideias, ter dificuldade para perceber como os pedaços de informação estão relacionados ou conectados entre si. O que os leitores precisam é de uma orientação contínua—que é o que você, o escritor, fornece. E o que você usa para fornecer essa orientação é chamado de transições—vários dispositivos que ajudam os leitores a avançar através de um documento. Há (ou certamente deveria haver) uma lógica que conecta cada frase em um documento e que dita uma certa sequência para essas frases.

Veja o capítulo sobre coerência e transições para discussão detalhada e exemplos.

Uma última maneira de revisar seu rascunho em nível estrutural é verificar como você definiu as quebras de parágrafo. Os parágrafos são criaturas estranhas—alguns estudiosos da escrita acreditam que eles não existem e são apenas pontos de quebra arbitrários que os escritores jogam sempre que e onde quiserem. Desculpe—na escrita técnica, o parágrafo é um jogador chave na luta pela clareza e compreensão. Embora nem sempre seja possível, os parágrafos devem ocorrer onde há alguma mudança de tópico ou subtópico ou alguma mudança na maneira como um tópico está sendo discutido.

Em uma página inteira de escrita com espaçamento simples, procure por pelo menos uma a quatro quebras de parágrafo—não há nada de mágico nessa média, então não a trate como se fosse uma lei. Basta dar uma segunda olhada nesses parágrafos longos e verificar a possibilidade de quebras de parágrafo.

Agradeceria suas opiniões, reações e críticas em relação a este capítulo: sua resposta—David McMurrey.