Verifique o conteúdo
Uma das maneiras mais importantes de revisar um rascunho é verificar o conteúdo—como isso é óbvio! Todas as boas transições, boa organização e estrutura de frases clara do mundo não podem ajudar um techdoc que não tem o conteúdo certo. O conteúdo de um techdoc 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 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, senã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 o desenvolvedor de produtos (um "especialista") quando o relatório era realmente destinado a não especialistas.
Se você conseguir perceber como a informação é inadequada em um rascunho de relatório, você deve estar a caminho de saber o que fazer especificamente para revisar. Uma ferramenta útil de brainstorming é pensar em termos de tipos de conteúdo.
Use as perguntas fornecidas em documento conteúdos para revisar seu rascunho para tipos de informações a adicionar ou alterar.
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 pedaços de informação, verificando se estão na ordem certa.
- Outro tem a ver com níveis de informação. Você pode olhar para as frases ou parágrafos em um rascunho e ver que algumas frases vão a um nível mais profundo de discussão sobre o tema do que outras. Outras frases atuam como a estrutura sobre a qual aquelas frases de nível mais profundo dependem. Ao olhar para a estrutura dessa maneira, você não apenas 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.
Verificar organização
Se você tiver o conteúdo certo em um relatório, pelo menos você terá todas as "coisas certas" disponíveis para os leitores. No entanto, pode ainda não estar devidamente organizado—como quando você acabou 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 blocos de informações 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, tenha uma noção de 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. Neste caso, você identifica o tópico de cada frase e considera a sequência dessas frases.
- Escolha a melhor sequência para os trechos de informação. Uma vez que você conhece o tópico de cada um dos segmentos de informação (em qualquer nível que você esteja investigando), então você pode decidir se eles 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 os 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 então passar para seus diferentes tipos. - Simples, básico → complexo: Uma outra forma de organizar os itens de uma discussão é começar pelos simples, básicos e fundamentais e depois passar para os mais complexos e técnicos.
- Coisa-em-reposo → coisa-em-movimento: Outro padrão de organização envolve primeiro descrever a coisa (como se fosse em uma fotografia), depois discutir seu funcionamento ou processo (como se fosse 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 discute exemplos de propostas.
- Dados → conclusões: Outro meio 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: apresentar a conclusão primeiro, depois os dados que a sustentam.)
- Problema, questão → solução, resposta: Você também pode organizar a informação discutindo primeiro um problema ou levantando uma questão, e depois 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 do assunto, estabelecer uma compreensão sólida sobre ele, e então voltar e explicar tudo novamente, mas desta vez adicionando os detalhes técnicos de forma densa e abrangente!
- Mais importante → menos importante: Um método de organização mais __ENTIDADE_0__retórico__ENTIDADE_1__ é começar com a informação mais importante, a mais chamativa, a mais dramática, e depois passar para informações que sejam progressivamente menos impactantes. (E esse padrão pode ser invertido: 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 depois passar para argumentos cada vez menos convincentes. (Esse padrão também pode ser invertido: você pode construir até seus argumentos mais convincentes.)
- Geral → específico: Uma maneira comum de organizar é dispor os 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:
Essas são apenas algumas possibilidades. Quando o objetivo é informativo, você organiza as informações de modo a garantir que os leitores compreendam o básico antes de passar para o conteúdo complicado e técnico. 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, de qualquer forma, evite misturar essas abordagens—por exemplo, jogando fora alguns dados, depois fazendo algumas conclusões, e então fazendo isso de forma desordenada. Mantenha as maçãs separadas das laranjas!
Fortaleça as frases tópicas e os resumos.
Uma das melhores coisas que você pode fazer é voltar a um rascunho e verificar se consegue inserir frases tópicas e resumos em pontos-chave. Quando escrevemos, geralmente 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 resumo ou modificar o que já está lá para tornar o resumo mais claro. Os leitores precisam saber para onde estão indo em um relatório, o que vem a seguir e, a propósito, onde estiveram recentemente.
Ter uma visão geral em um relatório é como ter um mapa quando você está em uma nova cidade. As frases-tópico e as 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 seguirá, 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, consulte tópicos e resumos.
Fortalecer a coerência, as transições
Você pode ter as informações corretas em um relatório e organizá-las adequadamente, 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 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 ao longo 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.
Verifique o comprimento do parágrafo.
Uma última maneira de revisar seu rascunho no nível da 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 inserem 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 em 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.
Eu apreciaria seus pensamentos, reações, críticas em relação a este capítulo: sua resposta—David McMurrey.
