Tenho que escrever documentos técnicos, como manuais, relatórios e artigos de periódicos.
Recentemente, comecei frases com “Isto “na maior parte do tempo. Por exemplo,
Implante uma bóia de marcação na localização GPS da âncora e outra na localização GPS do quadro. Isso torna a navegação muito mais fácil.
ou
Os arquivos de registro serão analisado para configurações de calibração e outros metadados. Esse processo pode levar alguns minutos para arquivos muito grandes.
ou
Se novas baterias forem inseridas, o magnetômetro deve ser recalibrado. Esta operação é semelhante à recalibração frequentemente necessária ao usar uma bússola de smartphone.
Essas frases estão corretas ou existem outras construções de frases que podem ser lidas melhor? Devo apenas aceitar e seguir em frente?
Comentários
- Documentos técnicos devem ser escritos para clareza, não elegância ou estilo superior. Acho que os exemplos que você forneceu são claros e requerem menos processamento cognitivo do que as alternativas. Eu digo fique com eles e siga em frente.
- Isso torna a navegação muito mais fácil. Isso faria blá. Isso torna a navegação blá. Em verdade, em verdade, eu digo a você que tornaria a navegação muito mais fácil.
Resposta
Há uma vantagem distinta em continuar a fazer o que tem feito até agora.
Esta é a repetição do padrão
Instrua o leitor a realizar uma ação,
imediatamente seguido por
Descrição / comentário sobre o resultado e / ou benefício da ação “,
diminui a carga cognitiva de seus leitores: eles não são constantemente obrigados a realizar o trabalho adicional de interpretar uma variedade de formatos de apresentação e estruturas de frases para classificar as instruções das descrições ou para entender suas relações mútuas.
A maneira como você está apresentando informações para ler capacita-os a saber imediatamente o que se espera deles e por quê.
O fato de uma frase começar com “Isto” é, na verdade, um sinal útil para seus leitores de que o que está para se seguir é provavelmente uma descrição ou comentário sobre uma ação que você acabou de pedir que eles realizem.
Este aspecto da apresentação do material é uma maneira importante pela qual a documentação técnica difere da ficção literária.
Dependendo do estilo do escritor de ficção, parte do prazer de ler ficção depende ao ser surpreendido com justaposições inesperadas e pequenos quebra-cabeças, alguns dos quais são criados ou tornados mais intrigantes pela variação da forma como o material é apresentado ao leitor.
No seu caso, você está (ou deveria estar) mirando para o resultado oposto: a previsibilidade de sua apresentação e a clareza de compreensão de seus leitores “vão de mãos dadas. A relativa brevidade das frases e a repetitividade do formato em sua documentação reduzem o escopo para a criação de ambigüidade não intencional.
Vale a pena correr em min d uma razão importante para evitar ambigüidade na documentação técnica: além de ser irritante, pode até ser perigoso ou prejudicial se o leitor for confundido com uma ação incorreta (como energizar um circuito que não deve ser energizado).
Comentários
- @geometrikal – É ‘ provavelmente ciúme de minhas orelhas pontudas e nariz pequeno fofo.
- Uma excelente resposta @Erik Kowal. É por isso que votei positivamente 🙂
Resposta
Quase qualquer palavra ou frase pode ser usada em demasia, mas nomear um tópico (agente, “personagem” ou assunto) em uma frase e, em seguida, referenciá-lo com isto na próxima frase é uma excelente maneira de ajudar os leitores em uma passagem com clareza e facilidade. É um exemplo de um tipo principal de sequência de tópicos , um elemento estilístico vital de boa escrita.
É possível que você possa às vezes encontrar uma maneira melhor de formular, geralmente alongando a frase antecedente em uma ou mais cláusulas; mas – especialmente quando você está tratando de material complexo – menos frases longas pode ajudar o processo de seus leitores. (Não há nada de errado com frases longas bem estruturadas, mas eu prefiro os pares de frases em seus exemplos a qualquer maneira que eu possa pensar em combiná-los.)
Na ficção com muito diálogo, nós somos frequentemente encontramos muitas ocorrências da palavra dito. Não é automaticamente melhor passar por eles e tentar substituir muitos deles por verbos alternativos ( chorou, murmurou, emitiu etc.). Algumas palavras são repetidas frequentemente sem chamar atenção para a repetição. Isso (!) Ocorre porque eles desempenham bem e silenciosamente as funções pretendidas.
Resposta
Todas as frases parecem corretas para mim. Mas se você quiser se livrar do “isso” no início da segunda frase, pode reescrever um pouco a primeira frase.
Por exemplo, em vez de
Implante uma bóia de marcação na localização GPS da âncora e outra na localização GPS do quadro. Isso torna a navegação muito mais fácil.
escreva
Implementando uma bóia de marcador em a localização GPS da âncora e outra na localização GPS do quadro tornam a navegação muito mais fácil.
Em vez de
Os arquivos de log serão analisados para as configurações de calibração e outros metadados. Esse processo pode levar alguns minutos para arquivos muito grandes.
escreva
Analisar os arquivos de registro para configurações de calibração e outros metadados pode levar alguns minutos para arquivos muito grandes.
Na minha opinião, o terceiro exemplo é provavelmente o melhor deixado como você citou.
Comentários
- Como suponho que você perceba, suas alternativas mudam o significado dos pares de frases originais. Sua primeira alteração perde a função principal do original: Instruir para implantar. Sua segunda alteração perde a função principal do original: informar que ocorrerá uma análise.
- Para a primeira, você pode usar a voz passiva: A navegação é facilitada pelo processo. Não é a melhor das frases, no entanto. Para o segundo, que tal ” Arquivos muito grandes podem fazer esse processo demorar alguns minutos “?