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

Uma das maneiras mais importantes de revisar uma versão preliminar é verificar o conteúdo—como isso é óbvio! Todas as boas transições, boa organização e uma estrutura de frases clara no 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 __ENTIDADE_0__comunidades virtuais__ENTIDADE_1__ mas nunca se deu ao trabalho de definir o que esse termo significa. Seria difícil começar a ler esse relatório.
• Está lá, mas não é suficiente: pegue o mesmo exemplo—imagine que o autor fez apenas algumas afirmaçõ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 autor incluiu uma seção de 3 páginas sobre cache de dados, mas escrita para desenvolvedores de produtos (um público "especialista") quando o relatório realmente era destinado a não especialistas.

Se você consegue perceber como as informações são inadequadas em um rascunho de relatório, deve estar a caminho de saber exatamente o que fazer para revisar. Uma ferramenta útil de brainstorming é pensar em termos de tipos de conteúdo.

Use as perguntas fornecidas em conteúdo do documento para revisar seu rascunho sobre tipos de informação a serem adicionados ou alterados.

Verifique a estrutura do seu conteúdo

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

• um, abordado na próxima seção, envolve olhar para a sequência de blocos de informação, verificando se estão na ordem correta.
• Outro diz respeito aos níveis de informação. Você pode olhar para as sentenças ou parágrafos em um rascunho e ver que algumas sentenças têm um nível mais profundo de discussão sobre o tema do que outras. Outras sentenças funcionam como a estrutura sobre a qual essas sentenças de nível mais profundo dependem. Ao olhar para 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ê tiver o conteúdo certo em um relatório, pelo menos terá 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:

• Identifique o tópico de fragmentos de informação em vários níveis. Para avaliar a organização de um conjunto de parágrafos, você começa pensando em uma palavra ou frase para identificar o tópico de cada parágrafo—em outras palavras, ter uma noção de cada um. Então, você se distancia dessas palavras ou frases, considerando se elas estão na sequência certa. 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 blocos de informação. Uma vez que você conhece o tema de cada um dos fragmentos de informação (em qualquer nível que você esteja investigando), então 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:
  
  
  • Geral → específico: Uma maneira comum de organizar é dispor pedaços de conteúdo do geral ao 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 forma de organizar os elementos de uma discussão é começar com os simples, básicos e fundamentais e, em seguida, passar para os mais complexos e técnicos.
  • Objeto-em-repozo → objeto-em-movimento: Outro padrão organizacional envolve primeiro descrever a coisa (como se estivesse em uma fotografia), e depois discutir sua operação ou processo (como se estivesse 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.
  • Aplicação do conceito →, exemplosUm padrão organizacional comum é discutir um conceito em termos gerais e depois discutir uma aplicação dele. Por exemplo, outro capítulo deste livro discute propostas primeiro de forma conceitual e depois discute exemplos de propostas.
  • Dados → conclusões: Outra forma de organizar informações é apresentar dados (observações, dados experimentais, resultados de pesquisas) e, em seguida, 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 sustentam.)
  • Problema, pergunta → solução, resposta: Você também pode organizar as 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 assuntos técnicos para não especialistas é começar discutindo uma versão simplificada do tema, estabelecer uma compreensão sólida sobre isso e, em seguida, voltar e explicar tudo novamente, mas desta vez adicionando muitos detalhes técnicos!
  • Mais importante → menos importante: Um método de organização mais "retórico" é começar com a informação mais importante, a mais chamativa, a mais dramática primeiro e depois passar para informações que são progressivamente menos assim. (E esse padrão pode ser invertido: você pode construir um clímax, em vez de começar com ele.)
  • Mais convincente → menos convincente: — Similarmente, você pode começar com o argumento mais convincente para a sua posição — para chamar a atenção de todos — e depois passar para argumentos menos e menos convincentes. (Esse padrão também pode ser invertido: você pode construir até seus argumentos mais convincentes.)

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

E, em qualquer caso, você deve evitar misturar essas abordagens—por exemplo, descartando alguns dados, depois afirmando algumas conclusões e, em seguida, fazendo isso de forma desordenada. Mantenha as maçãs separadas das laranjas!

Uma das melhores coisas que você pode fazer é voltar através de um rascunho e verificar se você pode inserir frases tópicas e visões gerais em pontos-chave. Quando escrevemos, normalmente não temos certeza de exatamente para onde um parágrafo ou seção está indo em termos de seu conteúdo e lógica. Uma vez que "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 eles acabaram de estar.

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 aproxima, 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 revisado.)

Para um tratamento detalhado deste tópico, veja frases tópicas e resumos.

Você pode ter as informações certas em um relatório e tê-las organizadas corretamente, mas algo importante ainda pode dar errado. Os leitores podem perder o "fluxo" das ideias, ter dificuldade em 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—diversos dispositivos que ajudam os leitores a avançar por 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 de estrutura é 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 colocam quando e onde bem entenderem. Desculpe—na escrita técnica, o parágrafo é um jogador chave na batalha 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 forma como um tópico está sendo discutido.

Em uma página cheia de texto 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. Apenas dê uma segunda olhada naquelas longas parágrafos e verifique 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.