Frases claras

Tempo estimado: 10 minutos

Escritores de comédia buscam os resultados mais engraçados, escritores de terror lutam pelos mais assustadores e escritores técnicos buscam os mais claros. Na redação técnica, a clareza é mais important que todas as outras regras. Esta unidade sugere algumas maneiras de deixar suas frases mais claras.

Escolha verbos fortes

Muitos redatores técnicos acreditam que o verbo é a parte mais importante de uma frase. Escolha o verbo certo e o resto da frase se resolve sozinha. Infelizmente, alguns redatores se limitam a apenas um pequeno grupo de verbos genéricos. Escolher o verbo certo leva um pouco mais de tempo, mas dá resultados melhores.

Para envolver e educar os leitores, escolha verbos precisos, fortes e específicos. Reduza verbos imprecisos, fracos ou genéricos, como os seguintes:

Por exemplo, perceba como fortalecer o verbo fraco nas frases a seguir cria frases mais envolvente:

Verbo fraco Verbo forte
A exceção ocorre ao dividir por zero. Dividir por zero gera a exceção.
Esta mensagem de erro ocorre quando... O sistema gera esta mensagem de erro quando...
Temos o cuidado de garantir que... Garantimos cuidadosamente que...

Muitos redatores confiam em formas de ser como se fossem as únicas opções. Use verbos diferentes e perceba seu texto melhorar. Vale destacar que uma forma do verbo ser às vezes é a melhor escolha de verbo, então não sinta que você tem que eliminar todas as formas de ser de sua escrita.

Observe que os verbos genéricos geralmente são sinais de outros problemas, como:

Exercício

Esclareça as frases a seguir escolhendo verbos mais específicos. Sinta-se à vontade para reorganizar as frases e adicionar, modificar ou excluir palavras:

  1. Quando uma declaração de variável não possui um tipo de dados, ocorre um erro do compilador.
  2. Erros de compilador ocorrem quando você deixa um ponto e vírgula no final de uma instrução.
Clique para revelar a resposta.
  1. Algumas respostas possíveis:
    • Quando uma declaração de variável não especifica um tipo de dados, o compilador gera uma mensagem de erro.
    • Se você declarar uma variável, mas não especificar um tipo de dados, o compilador gerará uma mensagem de erro.
    2. Algumas respostas possíveis:
    • Os compiladores emitem erros quando você omite um ponto e vírgula no final de uma instrução.
    • Um ponto e vírgula ausente no final de uma instrução causa erros do compilador.

Reduza a quantidade de “há” e “existe”

As frases que começam com Há ou Existe casam um substantivo genérico com um verbo genérico. Casamentos genéricos deixam os leitores entediados. Mostre amor verdadeiro por seus leitores, fornecendo um assunto real e um verbo real.

Na melhor das hipóteses, você pode simplesmente excluir Há e Existe (e possivelmente outra palavra ou duas posteriormente na frase). Por exemplo, considere a seguinte frase:

Há uma variável chamada met_trick que armazena a precisão atual.

Removendo Há substitui o sujeito genérico por um sujeito melhor. Por exemplo, qualquer uma das frases a seguir é mais clara que a original:

Uma variável chamada met_trick armazena a precisão atual.

A variável met_trick armazena a precisão atual.

Às vezes, você pode melhorar uma frase que usa Há ou Existe, movendo o sujeito verdadeiro e o verbo verdadeiro do final da frase para o início. Por exemplo, observe que o pronome você aparece no final da frase a seguir:

Há dois fatos perturbadores sobre Perl que você precisa conhecer.

Substituir Há por Você fortalece a frase:

Você precisa conhecer dois fatos perturbadores sobre Perl.

Em alguns casos, redatores começam as frases com Há ou Existe para evitar o incômodo de criar sujeitos ou verbos verdadeiros. Se não existir nenhum sujeito, considere criar um. Por exemplo, na seguinte frase Há não identifica a entidade receptora:

Não há garantia de que as atualizações serão recebidas em ordem sequencial.

Substituir Há por um sujeito significativo (como clientes) cria uma experiência mais clara para o leitor:

Os clientes podem não receber as atualizações em ordem sequencial.

Exercício

Esclareça as seguintes frases removendo Há, e possivelmente reorganizando, adicionando, modificando ou excluindo outras palavras:

  1. Há muita sobreposição entre X e Y.
  2. Não há uma camada de criação para o thread principal.
  3. Há uma interface Python de baixo nível, TensorFlow, para carregar um modelo salvo.
  4. Há uma função de fragmentação chamada distribute que atribui chaves.
Clique para revelar a resposta.
  1. X e Y se sobrepõem muito.
  2. O thread principal não fornece uma camada de criação.
  3. O TensorFlow fornece uma interface Python de baixo nível para carregar um modelo salvo.
  4. A função de fragmentação distribute atribui chaves.

Minimize certos adjetivos e advérbios (opcional)

Adjetivos e advérbios funcionam incrivelmente bem na ficção e na poesia. Graças aos adjetivos, a grama velha e sem graça fica proeminente e verdejante, enquanto o cabelo sem vida se transforma em algo brilhante e exuberante. Os advérbios empurram os cavalos para correr loucamente e livremente e os cães para latir alto e ferozmente. Infelizmente, adjetivos e advérbios às vezes fazem os leitores técnicos também latir alto e ferozmente. Isso porque adjetivos e advérbios tendem a ser definidos de forma muito vaga e subjetiva para leitores técnicos. Pior, adjetivos e advérbios podem fazer a documentação técnica parecer perigosamente como material de marketing. Por exemplo, considere a seguinte passagem de um documento técnico:

Definir esse sinalizador faz com que o aplicativo seja executado extremamente rápido.

De fato, extremamente rápido chama a atenção dos leitores, mas não necessariamente de uma maneira boa. Alimente seus leitores técnicos com dados factuais em vez de falar de marketing. Refatore advérbios e adjetivos amorfos em informações numéricas objetivas. Por exemplo:

Definir esse sinalizador faz com que o aplicativo seja executado 225-250% mais rápido.

A mudança anterior tira um pouco de charme da frase? Sim, um pouco, mas a frase reformulada ganha precisão e credibilidade.

Não confunda educar seus leitores (escrita técnica) com divulgar ou vender um produto (escrita de marketing). Quando seus leitores esperam educação, forneça educação; não espalhe material publicitário ou de vendas dentro de material educacional.

Próxima unidade:

O conteúdo desta página é uma tradução livre e adaptada. O material original está disponível em inglês no Google Developers sob a licença Creative Commons (CC BY 4.0).