Dicas de Redação Técnica

Prévia do material em texto

DICAS DE REDAÇÃO TÉCNICA 
 
O que é redação técnica? Primeiramente, vejamos esses dois termos em separado: 
Redação é o ato de redigir, ou seja, de escrever, de exprimir pensamentos e ideias por meio da escrita. 
Técnica é o conjunto de métodos para execução de um trabalho, a fim de se obter um resultado. 
Logo, para você escrever um texto técnico, algumas regras devem ser seguidas, como o tipo de linguagem, a estrutura do texto, 
o espaçamento, a forma de iniciar e finalizar o texto, dentre outros. 
Ninguém aprende a escrever bem da noite para o dia, ao passo que não se escreve sem leituras e/ou estudos anteriores. 
Por esse motivo, elaborei esse manual, para que os futuros Engenheiros utilizem como base na redação de seus Trabalhos de 
Conclusão de Curso. 
Mas alguns cuidados podem e devem ser tomados, antes de considerar um documento pronto. São eles: 
- só utilize um editor de textos, se ele tiver um corretor. O Latex sem corretor pode ser uma péssima opção; 
- não confie na sua habilidade de escrever. Se você estiver com qualquer mínima dúvida, digite a palavra no Google; 
- ao terminar de escrever, leia todo o documento em voz alta para você mesmo ou para alguém; e 
- peça para alguém ler o seu documento. 
Você, com certeza, vai perceber a diferença que essas quatro dicas vão fazer no seu trabalho e na sua carreira. 
 
 
ERROS MAIS COMUNS 
 
Sujeito separado do verbo por vírgula 
Nunca separe o sujeito do verbo com vírgula!!! 
Ex: O primeiro capítulo apresenta . . . 
Ex: O Capítulo 2 descreve . . . .. 
 
Aposto 
Sempre que uma parte do texto puder ser retirada sem que a frase perca o sentido, ela deverá estar entre vírgulas. Isso é um 
aposto. 
Ex: Agradeço a meus pais que, sem sombra de dúvidas, foram . . / Agradeço a meus pais que foram . . 
 
Cuidado com “cujo”, “qual”, “eu” 
Ex: Ela utiliza o método lógico, que o objetivo é evitar o conflito de informações. 
Ex: Ela utiliza o método lógico, cujo objetivo é evitar o conflito de informações. 
Uso da Vírgula 
Ex: Em 2016, as exportações . . 
Ex: Por isso, foram coletadas . . . 
Ex: No início, estavam em amostra . . . 
Ex: No primeiro capítulo, será discutido . . . 
Ex: Deste modo, . . . 
Ex: Sendo assim, . . . 
 
O trema não existe mais 
Ex: consequentemente, consequência 
 
Concordância 
Leia com atenção para verificar as concordâncias em gênero e em número. 
Ex: Tendo em vista os grandes avanços do setor tecnológico, aliado a necessidade de garantir métodos . . . 
Ex: Tendo em vista os grandes avanços do setor tecnológico, aliados a necessidade de garantir métodos . . . 
 
Ex: Existe no mercado muitas opções . . . 
Ex: Existem no mercado muitas opções . . . 
 
Ex: Foi utilizado portas A0, A1 e A2 para os sensores analógicos. 
Ex: Foram utilizadas as portas A0, A1 e A2 para os sensores analógicos. 
 
Ex: Foram utilizadas como entrada as portas 2 e 4 e como saída 5 e 6. 
Ex: Foram utilizadas como entradas as portas 2 e 4 e como saídas 5 e 6. 
 
Ex: Desse modo, se torna mais econômico e seguro a utilização do suprimento. 
Ex: Desse modo, se torna mais econômica e segura a utilização do suprimento. 
 
Ex: Para alimentar o circuito do protótipo foi utilizado basicamente 2 fontes de alimentação. 
Ex: Para alimentar o circuito do protótipo foram utilizadas, basicamente, 2 fontes de alimentação. 
 
Uso de “Mostrar”, “Apresentar”, “Demonstrar”, “Representar”, “Descrever” 
Uma figura não demonstra, nem descreve. Demonstrar está relacionado a provar algo. 
A figura ilustra, mostra, apresenta. 
Economize Palavras 
Se as palavras podem ser retiradas, retire-as. 
Ex: Pode ser medida por vários aparelhos, sendo os seguintes os mais usados: . . . . . 
Ex: Pode ser medida por vários aparelhos, sendo os mais usados: . . . . . 
 
Ex: Possui pinos de entrada e saídas digitais, assim como pinos de entradas e saídas analógicas. 
Ex: Possui pinos de entrada e saídas digitais e analógicas. 
 
Ex: Após os cálculos feitos, são comparados os resultados dos indicadores. 
Ex: Após os cálculos, são comparados os resultados dos indicadores. 
 
Ex: A automação, no total sentido da palavra, pode ser . . . . 
Ex: A automação pode ser . . . . 
 
Ex: O método de secagem direta em da estufa consiste em uma metodologia simples. 
Ex: O método de secagem direta em estufa é simples. 
 
Ex: A alimentação externa é feita através do conector jack com positivo no centro, com onde o valor de tensão da fonte externa 
deve estar entre os limites 7 V a 12 V. 
Ex: A alimentação externa é feita com conector jack (positivo no centro), com valor de tensão entre 7 V e 12 V. 
 
Ex: São enviadas na mesma ordem que entraram, justificando o nome FIFO, do inglês FIFO (First In, First Out), primeiro a entrar, 
primeiro a sair . . . 
Ex: São enviadas na mesma ordem que entraram, FIFO (First In, First Out) . . . 
 
Ex: Esse gás apenas deve ser inalado simultaneamente com o oxigênio 
Ex: Esse gás deve ser inalado simultaneamente com o oxigênio 
 
Ex: Conforme a Equação 01 podemos ver a fórmula que nos possibilita calcular a pressão exercida sobre algum objeto por 
exemplo 
Ex: A Equação 01 possibilita calcular a pressão exercida sobre algum objeto 
 
Ex: Um gás tem como composição um grande número de moléculas que se movimentam muito rápido e de forma aleatória, 
causando várias colisões entre as moléculas do gás e com as paredes de qualquer tipo de recipiente. 
Ex: Um gás é composto de um grande número de moléculas que se movimentam muito rápido e de forma aleatória, colidindo 
com as paredes de qualquer tipo de recipiente. 
 
Ex: Deverão ser instaladas válvulas de bloqueio, as quais são operadas manualmente de maneira a interromper o fluxo do gás. 
Ex: Deverão ser instaladas válvulas de bloqueio operadas manualmente para interromper o fluxo do gás. 
Ex: Uma das utilidades dos cilindros é como backup que é acionada caso o suprimento primário tenha uma falha e haja uma 
queda de pressão no fornecimento dos gases à rede de distribuição 
Ex: Uma das utilidades dos cilindros é como backup caso haja uma queda de pressão no fornecimento dos gases à rede de 
distribuição 
 
Ex: Um microcontrolador é como se fosse um computador em miniatura resumido a um único chip que pode ser encontrado em 
vários aparelhos eletrônicos. 
Ex: Um microcontrolador é um computador em um único chip e pode ser encontrado em vários aparelhos eletrônicos. 
 
Seja Conciso 
Evite explicar coisas muito simples que deveram ser do conhecimento de quem lê. 
Ex: O loop while serve para uma leitura da variável. 
Ex: A lei de Kirchoff afirma que a corrente é proporcional . . . . 
Evite explicar coisas muito complexas que o leitor não precisa entender. Para isso, existem os Anexos e Apêndices. 
 
Não Generalize, Não Maximize, Nem Afirme 
Seja muito cuidadoso ao usar palavras como “único”, “sempre”, “todos”, “jamais”, “maioria”, “minoria”, entre outras que 
podem contribuir para a construção de generalizações indevidas. 
Evite superlativos. 
 
Ex: Não existe nenhum sistema que execute essa tarefa. 
Ex: Em pesquisa bibliográfica realizada, não foi encontrado sistema que execute essa tarefa. 
 
Ex: É importantíssima a troca dos cilindros de sucção. 
Ex: É importante a troca dos cilindros de sucção. 
 
Ex: O óxido nitroso estava com pressão baixíssima. 
Ex: O óxido nitroso estava com pressão muito baixa. 
 
Uso de “a fim de” ou “afim de” 
Ex: As cores foram escolhidas a fim de tornar mais fácil a leitura 
Ex: A função y=a.x+b é a função afim. 
Ex: Os dois sistemas tem funções afins. 
 
Ex: Na busca pela eficiência contínua de produção, afim de sanar as perdas citadas . . . 
Ex: Na busca pela eficiênciacontínua de produção, a fim de sanar as perdas citadas . . . 
 
 
 
Uso de “mau feito” ou “mal feito” 
São duas palavras diferentes. Na dúvida, substitua por bem ou bom e verifique se fica com sentido. 
Ex: Um projeto mau feito traz problemas futuros. / Um projeto bom feito traz problemas futuros. 
Ex: Um projeto mal feito traz problemas futuros. / Um projeto bem feito traz problemas futuros. 
 
Frases longas demais 
Evite frases longas demais. Sempre é possível separar uma frase longa em várias, cada uma com um verbo. 
Um segredo importante é: tente escrever cada frase com apenas um verbo! 
Ex: Agradeço a meu irmão Paulo com ele aprendi que a família é importante e levo isso para a vida toda. 
Ex: Agradeço a meu irmão Paulo. Com ele, aprendi que a família é importante. Levo isso para a vida toda. 
 
Ex: A sua origem ocorreu pela necessidade de reorganização de sistemas antes baseados em relés, sendo ele mais confiável que 
as estruturas originais, ocupando menos espaço e com uma linguagem de programação que assemelhava visualmente aos 
sistemas de relés existentes, linguagem lader. (Longo e confuso!) 
Ex: Teve como origem a necessidade de reorganização de sistemas antes baseados em relés. Ele é mais confiável que as 
estruturas originais e ocupa menos espaço. Além disso, utiliza uma linguagem de programação que se assemelha àquelas dos 
sistemas de relés já existentes (linguagem ladder). 
 
Ex: Essa plataforma é baseada em microcontroladores, que são unidades de processamento com diversos periféricos internos ao 
mesmo circuito integrado, CI, que possibilitam que esse dispositivo possa interagir com o ambiente e ter controle sobre 
atuadores no mesmo, por possuir internamente, além de uma unidade central de processamento, periféricos como memórias, 
comunicação serial, conversores analógicos digitais, dispositivos PWM (Pulse Width Modulation), comparadores, entre outros. 
Ex: Essa plataforma é baseada em microcontroladores. Microcontroladores são unidades de processamento com diversos 
periféricos internos como memórias, comunicação serial, conversores analógicos digitais, dispositivos PWM (Pulse Width 
Modulation), comparadores, entre outros. Esses dispositivos possibilitam a interação com o ambiente e o controle sobre 
atuadores. 
 
Ex: Primeiramente é verificado a temperatura do recipiente de análise e após, é acionado o sistema que dá nome a chamada, 
sistema PID, este é responsável por tornar modular a busca pela temperatura de referência, após a ação do controle de 
temperatura é feita uma nova leitura de peso, a mesma é condicionada há um recurso de comparação, chamado de if, se o peso 
atual for menor que o peso anterior, a amostra é sujeita há um novo tempo de secagem, passado este tempo, é feita uma nova 
comparação, este processo de comparações é feito até a variação de peso ser nula. 
Ex: Primeiramente é verificada a temperatura do recipiente de análise. Em seguida, é acionado o sistema PID, responsável por 
tornar modular a busca pela temperatura de referência. O peso é lido e a secagem continua enquanto o peso medido for menor 
que o peso anterior. 
 
 
Evite Palavras Repetidas 
Ex: A necessidade de melhores resultados no processo está vinculada diretamente à necessidade da aplicação. 
Ex: A necessidade de melhores resultados no processo está vinculada diretamente à aplicação. 
 
Ex: Como sugestão a trabalhos futuros é sugerido a compra dos sensores. 
Ex: Sugere-se como trabalhos futuros a compra dos sensores. 
 
Ex: Alguns desses equipamentos permitem a interrupção de energia (seccionamento), caso haja uma anormalidade na rede a 
jusante do ponto em que estão instalados, garantindo que não haja maiores danos nas instalações 
Ex: Alguns desses equipamentos permitem a interrupção de energia (seccionamento), caso haja uma anormalidade na rede a 
jusante do ponto em que estão instalados, garantindo que não haja maiores danos nas instalações 
 
Ex: Para isso, foi tirado print screen da tela. 
Ex: Para isso, foi tirado print da tela. 
 
Ex: Para a realização do processo de registro de imagem, o protótipo aciona a iluminação responsável por tornar o recipiente de 
análise iluminado uniformemente, em seguida aciona o hardware que realiza o registro e por fim encaminha a imagem 
capturada para o laudo de registros. 
Ex: Para registrar a imagem, o protótipo mantém a iluminação uniforme e aciona o hardware que captura a imagem, enviando-a 
para o laudo de registros. 
 
Ex: Os microcontroladores, só puderam se desenvolver devido ao desenvolvimento dos circuitos integrados. 
Ex: Os microcontroladores são fruto do desenvolvimento dos circuitos integrados. 
 
Crase 
Nunca se usa crase: 
Antes de palavra masculina 
Ex: Ele foi marcado a ferro. / Ele estava a bordo. 
Ex: Ele resulta num menor custo com envio de equipes de manutenção a pontos distantes. 
Antes de números: 
Ex: Foi aquecido a 12 graus. / 
Um modo fácil de saber se usa ou não a crase é substituir por uma palavra masculina. Se o “a” virar “ao”, craseie. 
Ex: Agradeço à minha esposa . . . / Agradeço ao meu irmão . . 
 
Ex: Atrelado a evolução dos recursos disponíveis e atento as possibilidades de mercado, o . . . 
Ex: Atrelado à evolução dos recursos disponíveis e atento às possibilidades de mercado, o . . . 
 
Palavras em maiúsculo 
Internet, Ethernet, Arduino, Microsoft 
 
 
Marcas Registradas 
Algumas marcas são propriedade de alguma empresa. Para indicar isso, utilize o símbolo correto. 
Matlab ®, Microsoft ®, Apple ® 
 
Evite o Uso de “através” 
O “através” deve ser utilizado quando algo passa por dentro de alguma coisa. 
Ex: Ela passou através da porta. / A corrente passa através do transformador de corrente. 
Ex: Posteriormente, fecha a válvula V4 e abre V6 liberando o oxigênio concentrado, através da válvula V6. 
 
Nos outros casos, sempre existe uma maneira melhor de se escrever. 
Ex: A leitura foi realizada através do multímetro. 
Ex: A leitura foi realizada com o multímetro. 
 
Ex: O método de secagem direta através da estufa é simples. 
Ex: O método de secagem direta em estufa é simples. 
 
Ex: Através desta análise é possível prever situações que envolvem . . . . 
Ex: Esta análise permite prever situações que envolvem . . . . 
 
A melhor opção para substituir o “através” é o “por meio de”. 
Ex: O levantamento de informações ocorreu através de um microcontrolador . . . 
Ex: A aquisição de dados é realizada por meio de um microcontrolador . . . 
 
Ex: Só pode gerar conclusões finais depois de ser submetido a testes de desempenho através de simulações. 
Ex: Só pode gerar conclusões finais depois de ser submetido a testes de desempenho por meio de simulações. 
 
Unidades 
Separe o valor da unidade. 
Ex: 10 V / 25 MW 
 
Apenas unidades que homenageiam pessoas são em letra maiúscula (a maioria). 
Ex: 10 V / 40 A / 10 rad/s / 2.000 rpm 5 Ohms 10 kg 10 Volts 100 g 
Exceção: kB MB GB 
 
 
Siglas 
A sigla aparece por extenso, na primeira vez que é mencionada. Após isso, pode ser utilizada só a sigla. Sigla não tem plural. 
Ex: Os Controladores Lógicos Programáveis (CLP) são muito utilizados na indústria. CLP são baratos e confiáveis. 
 
Palavras em Itálico 
Palavras em língua estrangeira devem estar em itálico. 
Ex: hardware, software, open source 
 
Ilustrações 
São consideradas ilustrações: desenhos, gráficos, fluxogramas, fotografias, figuras, mapas, organogramas, enfim imagens que 
acompanhem um texto. 
As ilustrações devem ser inseridas o mais próximo possível do trecho a que se refere, conforme projeto gráfico do trabalho. 
A identificação das ilustrações deve aparecer na parte superior, precedida da palavra designativa,seguida de seu número de 
ordem de ocorrência no texto, em algarismos arábicos e do respectivo título, usando a mesma tipologia de fonte utilizada para 
as seções primárias do trabalho. Após a ilustração, na parte inferior, indicar obrigatoriamente a fonte (ainda que seja produção 
do próprio autor), utilizando fonte tamanho 10, estilo regular e espaçamento simples. 
As figuras devem ser referenciadas no texto. Uma figura que não é mencionada deve ser retirada do texto. 
As figuras devem ter o tamanho suficiente para serem lidas. Evite figuras de página interia desnecessariamente. 
Nunca inclua figuras ilegíveis. Elabore uma nova figura. 
Uma moldura ajuda a figura a ficar delimitada e não voar no meio do texto. 
Na figura, não deixe textos, legendas e partes de desenho que não contribuam com o entendimento da figura. Apague os 
excessos ou elabora uma nova figura. 
 
Tabelas e Quadros 
São dois tipos de ilustrações. Note a formatação completamente diferente. 
 
Centralize as figuras e tabelas, assim como seus títulos. 
A centralização é em relação às margens (esquerda e direita) e não em relação à marca de parágrafo e margem direita. 
 
Ao Itemizar 
Os itens devem ser listados da seguinte forma: 
- o item 1; 
- o item 2; e 
- o item final. 
 
Pense no que vai escrever para ver se tem sentido 
Ex: O sistema de leitura manual . . . (Ninguém lê com a mão) 
Ex: O sistema de registro manual . . . 
 
Ex: A eficiência do processo desejado está diretamente conectada a identificação das atividades que envolvem a construção do 
produto. (Não se conecta a eficiência a nada) 
Ex: A eficiência do processo desejado está diretamente relacionada à identificação das atividades que envolvem a produção. 
 
Ex: Na busca pela eficiência contínua de produção, as tecnologias voltadas às áreas de automação e controle surgiram como um 
facilitador, com o intuito de diminuir os erros gerados em uma linha de processos, visto que este é um dos setores com grande 
influência na economia do país. (Este quem?? Que setor) 
 
Ex: Como podemos analisar na Figura 28. (Ninguém analisa nada na figura! Você quer mostrar algo!) 
Ex: Como pode ser visto na Figura 28. 
 
Ex: Atento ao grande avanço de recursos disponíveis no mercado . . . (Recursos avançam??) 
Ex: Atento ao aumento de recursos disponíveis no mercado . . . 
 
Ex: O projeto tem como objetivo o desenvolvimento de um sistema capaz de levantar informações em tempo real em uma linha 
de processos, SYSTEMCONTROL, capaz de informar e armazenar leituras das amostras por ele analisadas, através de um micro 
controlador Arduino e sensores. (Longo, confuso e com palavras mal coclocadas) 
Ex: O projeto tem como objetivo o desenvolvimento de um sistema capaz de levantar informações em tempo real em uma linha 
de processos. O SYSTEMCONTROL é capaz de informar e armazenar leituras das amostras por ele analisadas, por meio de um 
micro controlador Arduino e sensores. 
 
Ex: O protótipo informou dois valores e uma imagem, sendo estes densidade e umidade da amostra. Em equipamentos 
comerciais está análise é feita independente uma da outra, por isso está comparação de resultados também ocorreu de maneira 
independente. (Estes deveriam se referir aos últimos mencionados. Mas quem foi mencionado foi a imagem) 
Ex: O protótipo fornece uma imagem e dois valores, sendo estes densidade e umidade da amostra. Em equipamentos comerciais 
está análise é feita independentemente uma da outra. Por isso, por isso esta comparação de resultados também ocorreu de 
maneira independente. 
Ex: No oitavo capítulo são tratadas as conclusões finais e os trabalhos futuros e por fim, as referências seguidas do apêndice A, 
onde está contemplado o firmware desenvolvido nesta pesquisa. (Confuso) 
Ex: No oitavo capítulo, são tratadas as conclusões finais e os trabalhos futuros. Após as referências, o Apêndice A apresenta o 
firmware desenvolvido nesta pesquisa. 
 
Ex: Todo processo não controlado está fadado à presença de impurezas. (Fadado é relacionado a destino!) 
Ex: Todo processo não controlado está sujeito à presença de impurezas. 
 
Ex: A amostra foi classificada em características de cor e textura. 
Ex: A amostra foi classificada quanto às características de cor e textura. A cor pode ser classificada em azul, branca ou preta. 
 
Ex: A necessidade de compactar os custos . . . . (O custo compactado não é reduzido, continua lá) 
Ex: A necessidade de reduzir os custos . . . . 
Ex: Ele deve garantir ações que tragam resultados seguros, mediante a situações adversas . . . (As situações adversas seriam um 
meio para trazer resultados. Errado!) 
Ex: Ele deve garantir ações que tragam resultados seguros perante situações adversas . . . 
 
Ex: Eles estão presentes no dia a dia de praticamente toda a população. 
Ex: Eles estão presentes no dia a dia de praticamente qualquer pessoa. 
 
Ex: O sistema está direcionado à análise de alimentos submetidos à extrusão, onde a principal função está a transformação da 
matéria-prima . . . . (Onde se refere à extrusão? Errado!) 
Ex: O sistema está direcionado à análise de alimentos submetidos à extrusão, que transformam a matéria-prima . . . . 
 
Ex: A medida de tensão ocorre. (Medida não ocorre!) 
Ex: A medida de tensão é realizada. 
 
Ex: Em contrapartida aos outros processos desenvolvidos neste projeto, . . . (Contrapartida é um “toma lá, dá cá”) 
Ex: Diferentemente dos aos outros processos desenvolvidos neste projeto, . . . 
 
Ex: A obtenção do oxigênio é alcançado através do processo de destilação fracionada. 
Ex: O oxigênio é obtido pelo processo de destilação fracionada. 
 
Ex: Cilindros de gases medicinais ou torpedos são geralmente empregados nos centros hospitalares para serem utilizados 
quando não se tem necessidade de grandes volumes de gás 
Ex: Cilindros de gases medicinais ou torpedos são geralmente empregados nos centros hospitalares quando não se tem 
necessidade de grandes volumes de gás 
 
Ex: O emprego do Arduino e do módulo GSM no projeto foi bastante facilitador para realização de construção do protótipo. 
Ex: O emprego do Arduino e do módulo GSM no projeto facilitou bastante a montagem do protótipo.