Technical Writing Essentials

Descriptive technical writing usa uma combinação de visuais e texto para “mostrar” e “dizer” ao leitor sobre as informações que estão sendo transmitidas. Como descrições mais criativas, as descrições técnicas às vezes se baseiam nos “cinco sentidos” e comparações metafóricas (analogias) para permitir ao leitor conceituar completamente o que está sendo descrito. Mais frequentemente, porém, elas se baseiam em descritores concretos e mensuráveis. As descrições técnicas podem tomar muitas formas, dependendo do propósito e do público. As descrições podem variar desde uma breve frase, até um parágrafo, uma seção inteira de um relatório, ou um manual inteiro. Descrições técnicas mal escritas podem causar confusão, perder tempo e até mesmo resultar em catástrofe! Descrições técnicas de produtos são muitas vezes exigidas legalmente para garantir a segurança e conformidade. A atenção aos detalhes é crítica.

As especificações do produto requerem descrições detalhadas das características do design; as instruções muitas vezes requerem detalhes descritivos específicos para “mostrar” ao leitor o que fazer. Algumas categorias gerais de descrições técnicas incluem o seguinte:

• Descrições de mecânica: fornecem uma visão geral detalhada dos aspectos físicos de uma ferramenta, máquina ou outro dispositivo mecânico que possui peças móveis e foi projetado para executar uma função específica. Podem ser descrições de produtos para vendas ou fabricação, documentação de especificações de projeto, info-grafia, etc. Este capítulo foca em detalhes este tipo de descrição.
• Descrições de Processo: detalha uma série de eventos (naturais/biológicos/ecológicos, mecânicos, sociais ou fenômenos psicológicos) que acontecem em seqüência particular, a fim de alcançar um resultado específico. Estes podem ser categorizados em processos não-instrucionais (tais como análises de processo de como um motor de combustão interna funciona, ou processos naturais como a fotossíntese) e processos instrucionais (tais como procedimentos recomendados/requisitos e instruções explícitas passo-a-passo a serem seguidas). (Veja Seção 7.7 para informações detalhadas sobre as Instruções de Escrita).
• Definições: esclarecer o significado específico, muitas vezes relacionado a um contexto específico, ou expressar a natureza essencial dos termos a serem definidos. Estes podem variar em comprimento desde uma simples frase esclarecedora até um documento extenso de várias páginas. As definições incluem frequentemente descrições detalhadas e visuais para ilustrar as ideias. Clique no link abaixo para ver uma apresentação em PowerPoint do aluno sobre como escrever definições eficazes para fins técnicos. Esta apresentação está incluída com permissão expressa do aluno.

Definições na Escrita Técnica – Exemplo de apresentação do aluno (.pdf)

Descrições mecânicas devem fornecer uma compreensão clara do objeto sendo descrito, incluindo

• Aspecto geral e propriedades físicas
• Função/propósito geral
• Partes componentes
• Como as partes interagem para criar um todo funcional.

O leitor deve ser capaz de imaginar claramente, e portanto entender, a natureza do objeto sendo descrito, o que ele faz, e como ele funciona.

A fim de alcançar esta clareza para o leitor, o escritor deve escolher detalhes significativos e organizar a informação de forma lógica. Selecionar detalhes que possam ser descritos de forma precisa e mensurável, tais como

Dependente da necessidade do leitor, a descrição pode variar desde uma visão geral que requer apenas algumas frases até um manual multi-capítulo detalhando todos os aspectos das peças e funções do mecanismo, a fim de solucionar problemas técnicos e reparos completos. Para um exemplo divertido deste último, veja o Star Trek: The Next Generation: Manual Técnico (capa ilustrada na Figura 7.4.1), que fornece descrições detalhadas de todo o equipamento e tecnologia utilizados a bordo do fictício U.S.S. Enterprise-D.

Antes de começar a esboçar a sua descrição, deve considerar o seu propósito e audiência: Porque é que o seu público precisa desta descrição? Para que vão usá-la? Você está descrevendo diferentes tipos de painéis solares para os consumidores médios para ajudá-los a escolher aquele que melhor se adapta às suas necessidades? Está a dar esquemas aos técnicos e instaladores?

Após ter o seu propósito e público claramente em foco, esboce uma descrição que inclua os seguintes elementos:

1. Definição: Qual é, e qual é a sua principal finalidade?
2. Visão geral: Descreva a aparência geral do mecanismo (“big picture”).
3. Componentes: Descreva os componentes principais em seções rotuladas; considere cuidadosamente a ordem das informações aqui. Crie uma conexão lógica entre cada componente descrito.
4. Explicação: como as peças trabalham em conjunto para cumprir sua função? Que princípios chave regem o seu funcionamento? Considere quanto detalhe é necessário aqui para o seu público-alvo.
5. Visuais: inclua gráficos que ilustrem claramente o mecanismo e/ou suas partes. Mostre o dispositivo como um todo; considere mostrar detalhes específicos em vistas expandidas, cortes, ou diagramas etiquetados. Você pode até embutir ou link para vídeos mostrando o dispositivo em ação.
6. Conclusão: dependendo da finalidade, você pode rever o histórico do produto, disponibilidade, fabricação, custos, avisos, etc.)
7. Referências: Fontes usadas na descrição, ou fontes adicionais de informação disponíveis (se relevantes).

Você pode considerar o uso de um template, como o Template de Descrição Técnica abaixo, tendo em mente que embora os templates possam ser guias úteis, eles não oferecem muita flexibilidade e podem não funcionar para todas as situações.

Descrições da amostra

Examine a descrição do “Up Goer Five” na Figura 7.4.2 (clique na imagem para uma versão maior). Quem poderia ser o público pretendido?

Compare a descrição na Figura 7.4.2 para a informação dada no site da NASA sobre o Rover de Curiosidade de Marte.

Note as diferenças no nível de detalhe, vocabulário e propósito geral das descrições. Se você usou as informações no site da NASA para preencher o Modelo de Descrição Técnica, você pode acabar com algo como a tabela a seguir. Objectivos

Você pode descobrir que alguns desses elementos não são necessários; mais uma vez, considere o que o seu público-alvo já sabe. Encontre um equilíbrio entre o óbvio e o incorrecto, assumindo que os seus leitores têm o conhecimento que lhes falta.

Ao refinar os detalhes da sua descrição e das suas partes componentes, considere o seguinte:

• Organização: Use um princípio lógico para organizar sua descrição
  • De baixo para cima (ou fundação para cima)
  • Esquerda para a direita (ou da direita para a esquerda)

  >

  • De dentro para fora (ou de fora para dentro)
  • As características mais ou menos importantes
  • Componente central para periféricos

  >

  • Propriedades materiais, etc.

  >

  >

>

• Linguagem: Usar termos específicos, precisos e concretos – evitar termos vagos ou demasiado gerais
  • Utilizar terminologia correcta – definir termos como necessários para o seu público
  • Utilizar analogia para descrever uma coisa desconhecida em termos de uma coisa familiar
  • Utilizar linguagem objectiva – sem “ad speak” ou termos subjectivos
  • Utilizar tempo presente, verbos ativos para descrever como o dispositivo aparece e o que faz
  • Utilizar palavras que criam imagens vívidas e específicas na mente do leitor.

Selecionar um objeto comum, cotidiano (como um dos objetos da Figura 7.4.3) e esboçar uma descrição técnica para um público não familiarizado com o objeto. Comece imaginando um público alvo e uma finalidade, e depois tente preencher o Modelo de Descrição Técnica com informações detalhadas. Usando as informações do seu modelo, rascunhe uma breve descrição de 1-2 parágrafos, e adicione visuais devidamente capturados.