# 3. Escrita Científica
Este livro reúne orientações gerais de escrita científica e apresentação que devem ser observadas em todo o Trabalho de Conclusão de Curso.
As regras apresentadas aqui não pertencem a um capítulo específico. Elas se aplicam à Introdução, Fundamentação Teórica, Trabalhos Relacionados, Metodologia, Descrição da Proposta, Análise da Proposta, Conclusões e demais partes do documento.
São abordados aspectos como construção de parágrafos, utilização de figuras, tabelas, quadros, algoritmos e equações, citações e referências bibliográficas, siglas, termos em outros idiomas e procedimentos de autorrevisão.
Vale ressaltar que o Trabalho de Conclusão de Curso deve seguir as **normas da ABNT adotadas pela instituição**, tanto para a formatação do documento quanto para citações e referências bibliográficas.
O template LaTeX disponibilizado no Overleaf já contempla as principais configurações necessárias. Portanto, o aluno deve evitar alterações manuais de formatação que possam entrar em conflito com o padrão institucional.
**Link do template:** [https://www.overleaf.com/read/xtkthsrvjyph#ea4](https://www.overleaf.com/read/xtkthsrvjyph#ea4)
Sempre que houver dúvida sobre formatação, citações ou referências, deve-se priorizar:
1. as regras institucionais;
2. o template oficial do curso;
3. as normas da ABNT aplicáveis.
**Importante:** antes de solicitar a revisão do orientador, o aluno deve verificar se as regras deste livro foram aplicadas ao texto produzido.
# PÁGINA INICIAL — Como utilizar este livro
O Livro 2 explica **o que deve ser escrito em cada parte do TCC**.
Este livro explica **como determinados elementos devem ser apresentados ao longo de todo o documento**.
Por exemplo:
Se você deseja saber:
> O que deve aparecer na Fundamentação Teórica?
consulte:
**Livro 2 → Fundamentação Teórica.**
Se a dúvida for:
> Como devo apresentar e descrever uma figura?
consulte:
**Livro 3 → Figuras.**
A separação evita que as mesmas regras apareçam repetidas em vários locais do Guia.
# CAPÍTULO 1 — PRINCÍPIOS DE ESCRITA CIENTÍFICA
# PÁGINA 1.1 — Características da escrita científica
A escrita científica deve permitir que outra pessoa compreenda claramente:
- o que está sendo discutido;
- em quais evidências as afirmações se baseiam;
- quais decisões foram tomadas;
- como o trabalho foi desenvolvido;
- quais resultados foram obtidos;
- quais conclusões podem ser sustentadas.
Um texto científico deve buscar principalmente:
**clareza, precisão, objetividade, coerência e rastreabilidade das informações.**
---
## Clareza
O leitor não deve precisar adivinhar o significado de uma frase.
Evite construções excessivamente complexas ou ambíguas.
❌
> A utilização da abordagem, em função dos diversos elementos envolvidos no processo que está relacionado às características anteriormente apresentadas, apresenta melhores possibilidades.
Não está claro:
- qual abordagem;
- quais elementos;
- qual processo;
- melhores possibilidades em relação a quê.
---
## Precisão
Utilize termos que representem exatamente aquilo que deseja afirmar.
❌
> O sistema ficou muito mais rápido.
✅
> O tempo médio de resposta diminuiu de 320 ms para 210 ms.
Sempre que houver uma medida disponível, prefira evidências objetivas.
---
## Objetividade
Evite informações que não contribuam para a compreensão do trabalho.
Isso não significa escrever de forma superficial.
Significa apresentar **o nível de detalhe necessário**.
---
## Coerência
As diferentes partes do texto não podem se contradizer.
Por exemplo:
Na Introdução:
> Serão avaliados três algoritmos.
Na Metodologia:
> Foram selecionados quatro algoritmos.
Na Análise:
> Foram avaliados cinco algoritmos.
Se o planejamento mudou, atualize o documento para manter consistência.
# PÁGINA 1.2 — Organização de parágrafos
O parágrafo deve representar uma **unidade de ideia**.
Evite construir parágrafos que tratam simultaneamente de vários assuntos sem conexão clara.
Uma estrutura útil é:
**Ideia principal → Explicação → Evidência/Detalhamento → Ligação**
---
## Exemplo
> Sistemas de detecção de intrusão podem ser utilizados para identificar atividades potencialmente maliciosas em redes de computadores. Esses sistemas analisam eventos ou tráfego buscando padrões associados a comportamentos anômalos ou ataques conhecidos \[REFERÊNCIA\]. Dependendo da estratégia adotada, a detecção pode ser baseada em assinaturas ou anomalias. Essa distinção é relevante para este trabalho porque \[...\]
Existe uma progressão.
---
## Primeira frase
Sempre que possível, a primeira frase deve indicar qual ideia será discutida.
Isso ajuda o leitor a compreender o propósito do parágrafo.
---
## Evite parágrafos muito curtos
Um parágrafo composto por uma única frase pode indicar que uma ideia não foi suficientemente desenvolvida.
Também evite sequências de pequenos parágrafos que poderiam formar uma argumentação única.
---
## Evite parágrafos excessivamente longos
Se um parágrafo ocupa grande parte da página, verifique se existem várias ideias misturadas.
Pergunte:
> Este parágrafo possui apenas uma ideia central?
# PÁGINA 1.3 — Clareza, precisão e objetividade
Evite expressões vagas.
❌
> Vários pesquisadores utilizam essa abordagem.
Pergunte:
> Quais pesquisadores?
Utilize referências.
---
❌
> Os resultados foram bons.
Pergunte:
> Bons segundo qual critério?
Prefira:
> O modelo apresentou F1-score médio de 0,91.
---
❌
> O sistema possui alta escalabilidade.
Pergunte:
> Qual evidência demonstra isso?
Uma característica não deve ser declarada sem evidência quando ela constitui resultado ou propriedade que precisa ser demonstrada.
---
## Evite superlativos
Expressões como:
- extremamente eficiente;
- excelente;
- muito superior;
- revolucionário;
- altamente inovador;
normalmente devem ser substituídas por descrições ou evidências objetivas.
# PÁGINA 1.4 — Coesão e continuidade do texto
As frases, parágrafos e seções devem possuir conexão.
O leitor deve entender por que o texto está passando de uma ideia para outra.
Utilize conectores quando apropriado:
- entretanto;
- portanto;
- além disso;
- nesse contexto;
- por outro lado;
- consequentemente;
- dessa forma;
- conforme apresentado anteriormente.
Mas evite utilizar conectores apenas para tornar o texto artificialmente formal.
---
## Evite mudanças abruptas
❌
> IoT permite conectar dispositivos. Random Forest é um algoritmo de classificação.
As frases podem ser corretas individualmente, mas não existe uma relação explícita.
Prefira estabelecer a conexão.
---
## Transição entre seções
O final de uma seção pode preparar o leitor para a seguinte.
Por exemplo:
> Diante das limitações apresentadas, diferentes mecanismos de detecção de intrusão têm sido investigados. Esses mecanismos são discutidos na seção seguinte.
Isso ajuda a construir continuidade.
# PÁGINA 1.5 — Afirmações e evidências
Uma regra fundamental da escrita científica é:
> **Quanto mais forte a afirmação, mais forte deve ser a evidência que a sustenta.**
Considere:
> Kubernetes é amplamente utilizado em ambientes de nuvem.
Essa afirmação pode precisar de fonte.
Já:
> Neste trabalho, foi utilizado Kubernetes 1.X.
é uma informação sobre sua própria metodologia e não precisa de referência para provar que você fez isso.
---
## Diferencie três tipos de afirmações
### Conhecimento proveniente da literatura
Precisa de referência.
### Decisão do seu trabalho
Precisa de justificativa quando relevante.
### Resultado do seu trabalho
Precisa de evidência obtida na metodologia ou análise.
---
## Exemplo
> O algoritmo X é superior ao algoritmo Y.
Essa afirmação é problemática sem contexto.
Superior:
- em qual métrica?
- em qual cenário?
- segundo qual estudo?
- em seus experimentos ou na literatura?
Prefira:
> Nos experimentos realizados neste trabalho, o algoritmo X apresentou F1-score médio superior ao algoritmo Y nos dois datasets avaliados.
Agora a conclusão está limitada às evidências disponíveis.
---
# PÁGINA 1.6 — Erros frequentes de escrita
## Frases vagas
> Isso melhora bastante o sistema.
Explique o que melhora e como isso foi observado.
## Repetição excessiva
Evite repetir a mesma ideia em vários parágrafos apenas com palavras diferentes.
---
## Afirmações sem fonte
Especialmente:
- definições;
- números;
- tendências;
- características de tecnologias;
- conclusões de outros estudos.
---
## Conclusões antecipadas
Não afirme na Fundamentação ou Metodologia resultados que somente serão demonstrados na Análise.
---
## Texto gerado sem revisão
Ferramentas de apoio à escrita podem produzir:
- informações incorretas;
- referências inexistentes;
- frases genéricas;
- repetições;
- inconsistências;
- termos inadequados ao contexto.
O aluno é responsável por todo o conteúdo entregue, independentemente das ferramentas utilizadas durante sua produção.
# CAPÍTULO 2 — FIGURAS
# PÁGINA 2.1 — Quando utilizar figuras
Figuras devem ser utilizadas quando ajudam o leitor a compreender uma informação melhor do que apenas com texto.
Exemplos:
- arquiteturas;
- fluxos;
- processos;
- topologias;
- relacionamentos;
- modelos;
- diagramas;
- gráficos;
- capturas de tela, quando realmente necessárias;
- taxonomias.
---
## ⚠️ Figura não é decoração
Não inclua uma figura apenas para aumentar o tamanho do documento ou tornar uma seção visualmente mais atraente.
Pergunte:
> O que esta figura ajuda o leitor a compreender?
Se não houver uma boa resposta, considere removê-la.
---
# PÁGINA 2.2 — Como inserir e apresentar uma figura
Toda figura precisa ser **introduzida no texto antes de aparecer**.
❌ Evite:
Parágrafo termina.
**Figura 4**
Novo parágrafo.
---
✅ Prefira:
> A Figura 4 apresenta a arquitetura da proposta, composta pelos módulos de coleta, processamento e análise.
**\[FIGURA 4\]**
Depois, continue explicando seu conteúdo.
---
## Ordem recomendada
**Texto apresenta a figura**
↓
**Figura**
↓
**Texto explica/interpreta a figura**
A figura faz parte da narrativa.
---
## Legenda
A legenda deve permitir identificar claramente o conteúdo apresentado.
Evite:
> Figura 4 — Arquitetura.
Prefira:
> Figura 4 — Arquitetura da abordagem proposta para detecção de tráfego malicioso.
# PÁGINA 2.3 — Como descrever uma figura no texto
Esta é uma regra obrigatória:
> **Toda figura precisa ser mencionada e descrita no texto.**
Não basta escrever:
> A Figura 5 apresenta o sistema.
Explique o que o leitor deve observar.
Por exemplo:
> A Figura 5 apresenta a arquitetura do sistema proposto. O componente de coleta recebe o tráfego proveniente dos dispositivos e encaminha os dados ao módulo de pré-processamento. Em seguida, as características extraídas são enviadas ao módulo de classificação \[...\]
---
## Não descreva apenas visualmente
❌
> Na esquerda existe uma caixa azul e na direita existem três caixas.
Explique o significado.
✅
> O fluxo inicia no módulo de coleta, que recebe os dados dos dispositivos. Em seguida \[...\]
---
## Gráficos
Em gráficos, descreva:
- eixos;
- variáveis;
- unidade;
- tendências;
- diferenças relevantes;
- relação com a análise.
Não leia todos os números para o leitor.
Interprete.
# PÁGINA 2.4 — Fonte, adaptação e autoria
Toda figura precisa indicar sua origem de acordo com as regras adotadas pelo curso.
Existem três situações principais.
## Figura reproduzida
A figura foi retirada diretamente de outra fonte.
A fonte original deve ser indicada.
---
## Figura adaptada
Você modificou, traduziu, reorganizou ou redesenhou uma figura baseada em outra.
Indique que houve adaptação e referencie a fonte original.
---
## Figura elaborada pelo autor
A figura foi criada especificamente para o TCC.
Utilize a forma indicada pelo template ou pelas normas do curso para identificar sua autoria.
---
## ⚠️ Redesenhar não transforma automaticamente em autoria própria
Se a estrutura conceitual da figura veio de outra fonte, ela continua sendo baseada naquela fonte.
---
## Direitos de uso
Ao utilizar imagens de terceiros, observe também eventuais restrições de direitos autorais e licenciamento.
Sempre que possível, prefira:
- produzir seus próprios diagramas;
- utilizar imagens com licença adequada;
- utilizar figuras de fontes acadêmicas dentro das práticas permitidas de citação e uso.
# PÁGINA 2.5 — Checklist de figuras
Para **cada figura**, verifique:
- [ ] A figura realmente contribui para compreender o texto.
- [ ] Foi mencionada antes de aparecer.
- [ ] Utilizei seu número no texto.
- [ ] Expliquei seu conteúdo.
- [ ] A legenda é clara.
- [ ] A fonte está indicada.
- [ ] Se foi adaptada, a adaptação está identificada.
- [ ] O texto da figura possui tamanho legível.
- [ ] A resolução é adequada.
- [ ] Siglas e símbolos utilizados são compreensíveis.
- [ ] A figura é citada em uma parte relevante do texto.
- [ ] Não existe figura "solta" no documento.
# CAPÍTULO 3 — TABELAS E QUADROS
# PÁGINA 3.1 — Tabela ou quadro?
Tabelas e quadros organizam informações de forma estruturada, mas podem possuir funções diferentes conforme as normas adotadas pela instituição.
Como orientação geral:
**Tabela**
É normalmente utilizada para apresentação de dados predominantemente numéricos ou resultados.
**Quadro**
É frequentemente utilizado para organizar informações textuais ou classificações.
Consulte as definições adotadas no template e nas normas institucionais.
---
## Exemplos
**Tabela**
Resultados de tempo de resposta:
Configuração
Tempo médio
A
120 ms
B
95 ms
**Quadro**
Comparação qualitativa:
Característica
Abordagem A
Abordagem B
Código disponível
Sim
Não
Suporte a IoT
Sim
Sim
---
# PÁGINA 3.2 — Como apresentar tabelas e quadros
Assim como figuras:
> **Toda tabela e todo quadro devem ser apresentados no texto antes de aparecer.**
Por exemplo:
> A Tabela 6 apresenta os resultados obtidos para as quatro configurações avaliadas.
Depois, apresente a tabela.
---
## Cabeçalhos
Os cabeçalhos precisam ser claros.
❌
| X | Y | Z |
✅
| Número de réplicas | Tempo médio de resposta (ms) | Utilização média de CPU (%) |
---
## Unidades
Sempre que houver valores quantitativos, informe as unidades.
---
## Casas decimais
Mantenha consistência.
Evite:
| A | 0,9 |
| B | 0,843221 |
| C | 0,87 |
Defina precisão coerente com o tipo de dado.
---
# PÁGINA 3.3 — Como analisar tabelas no texto
Não repita todos os valores.
❌
> Na configuração A o resultado foi 10, na B foi 12, na C foi 14 e na D foi 17.
O leitor pode ler isso na tabela.
---
✅ Prefira interpretar:
> Conforme apresentado na Tabela 6, o tempo de resposta aumentou progressivamente à medida que a carga foi elevada. A maior variação ocorreu entre as configurações C e D, com aumento de aproximadamente \[...\]
---
## Para tabelas comparativas
Como nos Trabalhos Relacionados:
> **A tabela sintetiza; o texto analisa.**
Identifique:
- padrões;
- diferenças;
- semelhanças;
- exceções;
- informações relevantes para a argumentação.
# PÁGINA 3.4 — Checklist de tabelas e quadros
- [ ] Foram mencionados antes de aparecer.
- [ ] Possuem título/identificação clara.
- [ ] Possuem fonte quando necessário.
- [ ] Cabeçalhos são compreensíveis.
- [ ] Unidades estão indicadas.
- [ ] A precisão dos números é consistente.
- [ ] Não existem colunas desnecessárias.
- [ ] Foram explicados ou analisados no texto.
- [ ] Evitei repetir no texto todos os valores.
- [ ] O tamanho permite leitura adequada.
# CAPÍTULO 4 — ALGORITMOS, CÓDIGOS E EQUAÇÕES
# PÁGINA 4.1 — Algoritmos
Um algoritmo deve ser apresentado quando a lógica de um procedimento é relevante para compreender ou reproduzir o trabalho.
Assim como qualquer elemento visual:
> **Todo algoritmo deve ser mencionado e explicado no texto.**
Não insira um algoritmo sem contextualização.
---
## Antes do algoritmo
Explique:
- objetivo;
- entradas;
- saída;
- contexto de utilização.
---
## Depois
Explique os passos relevantes, principalmente decisões, laços ou condições importantes.
Não é necessário traduzir linha por linha se o algoritmo for autoexplicativo.
# PÁGINA 4.2 — Código-fonte
Trechos de código devem ser utilizados com parcimônia.
O TCC não deve funcionar como documentação completa da implementação.
Inclua código quando ele for necessário para:
- demonstrar uma técnica;
- explicar uma configuração relevante;
- apresentar uma implementação essencial;
- apoiar a reprodutibilidade.
---
## Evite grandes blocos
Se dezenas ou centenas de linhas forem necessárias, considere disponibilizá-las como:
- apêndice;
- repositório;
- artefato complementar.
No texto principal, apresente apenas o trecho necessário para a discussão.
# PÁGINA 4.3 — Equações
Toda equação relevante deve ser explicada.
Ao apresentar uma equação:
1. introduza sua finalidade;
2. apresente a equação;
3. defina todas as variáveis;
4. informe unidades quando aplicável;
5. explique como ela será utilizada.
---
## Exemplo
> A precisão é calculada conforme a Equação X:
**\[EQUAÇÃO\]**
em que:
- TP representa verdadeiros positivos;
- FP representa falsos positivos.
Depois, explique a importância da métrica para o trabalho.
---
## Não suponha que símbolos são óbvios
Mesmo símbolos comuns podem assumir significados diferentes em contextos distintos.
Defina-os.
# PÁGINA 4.4 — Checklist
- [ ] Todo algoritmo foi mencionado no texto.
- [ ] A função do algoritmo foi explicada.
- [ ] Entradas e saídas estão claras.
- [ ] Trechos de código são realmente necessários.
- [ ] Código extenso foi movido para local apropriado.
- [ ] Toda equação foi introduzida.
- [ ] Todas as variáveis foram definidas.
- [ ] Unidades estão indicadas quando aplicável.
- [ ] Está claro como cada equação é utilizada no trabalho.
# CAPÍTULO 5 — CITAÇÕES E REFERÊNCIAS
# PÁGINA 5.1 — Quando uma afirmação precisa de referência?
Uma referência deve permitir identificar **de onde veio determinada informação**.
Normalmente precisam de referência:
- definições;
- conceitos;
- características técnicas;
- resultados de estudos anteriores;
- números;
- estatísticas;
- afirmações sobre tendências;
- classificações;
- métodos propostos por terceiros;
- informações históricas;
- comparações oriundas da literatura.
---
## Exemplo
> MQTT utiliza um modelo de comunicação baseado em publicação e assinatura.
Essa é uma característica técnica do protocolo e deve ser sustentada por uma fonte adequada.
---
## O que normalmente não precisa?
Informações produzidas pelo próprio trabalho.
Exemplo:
> Neste trabalho, o broker foi configurado com 4 GB de memória.
Essa é uma decisão experimental sua.
Entretanto, a **justificativa** da escolha pode precisar de evidência ou argumentação.
# PÁGINA 5.2 — Citações no Texto
As citações no texto devem seguir o padrão utilizado pelo template LaTeX e pelas normas da ABNT adotadas pela instituição.
O template disponibiliza comandos específicos para citações.
## Citação entre parênteses
Quando o autor não faz parte diretamente da construção da frase, utilize:
```
\cite{chave-da-referencia}
```
Exemplo:
```
Sistemas de detecção de intrusão podem ser utilizados para
identificar atividades maliciosas em redes de computadores
\cite{silva2025intrusion}.
```
O resultado será apresentado conforme a configuração ABNT do template.
---
## Citação com o autor no texto
Quando o nome do autor fizer parte da construção da frase, utilize:
```
\citeonline{chave-da-referencia}
```
Exemplo:
```
Segundo \citeonline{silva2025intrusion}, sistemas de detecção
baseados em anomalias podem identificar comportamentos que
diferem dos padrões considerados normais.
```
---
## Qual comando utilizar?
Utilize:
```
\cite{}
```
quando a referência aparece como complemento da afirmação.
Utilize:
```
\citeonline{}
```
quando o autor participa diretamente da frase.
### Exemplo
Com `\cite`:
> Técnicas de aprendizado de máquina têm sido investigadas para detecção de ataques em ambientes IoT \\cite{autor2025}.
Com `\citeonline`:
> \\citeonline{autor2025} investigaram técnicas de aprendizado de máquina para detecção de ataques em ambientes IoT.
---
## ⚠️ Não escreva citações manualmente
Evite escrever diretamente:
> (SILVA, 2025)
ou:
> Silva (2025)
O LaTeX deve gerar essas informações automaticamente.
Isso evita inconsistências quando:
- autores mudam;
- o ano é corrigido;
- a referência é substituída;
- existem múltiplos autores;
- o estilo bibliográfico é alterado.
---
## Citação direta
Quando for necessária uma citação direta, siga também as regras da ABNT adotadas pela instituição, incluindo indicação de página quando aplicável.
Entretanto, em textos técnicos e científicos, priorize citações indiretas sempre que possível.
O aluno deve demonstrar que compreendeu a fonte e é capaz de integrar suas ideias ao texto.
---
## ⚠️ Parafrasear continua exigindo citação
Modificar as palavras de uma ideia não transforma essa ideia em autoria própria.
Se a informação veio de outra fonte, utilize `\cite` ou `\citeonline`, conforme a estrutura da frase.
# PÁGINA 5.3 — Escolha das fontes
Nem todas as fontes possuem a mesma qualidade ou função.
Priorize, dependendo do assunto:
- artigos científicos;
- livros;
- normas;
- RFCs e padrões;
- documentação oficial;
- especificações;
- relatórios técnicos confiáveis.
---
## Evite como fonte principal
- blogs pessoais;
- Wikipédia;
- sites de conteúdo genérico;
- material promocional;
- respostas de fóruns;
- textos sem autor ou origem clara.
Essas fontes podem ser úteis para descobrir um assunto, mas normalmente não devem fundamentar afirmações científicas centrais.
# PÁGINA 5.4 — Fontes primárias e secundárias
Sempre que possível, consulte a fonte original.
Exemplo:
Um artigo afirma:
> O protocolo X foi definido em determinado RFC.
Não cite apenas o artigo para explicar o protocolo se o próprio RFC está disponível.
Consulte e cite a especificação original.
---
## Exemplos de fontes primárias
- artigo que propôs determinado método;
- RFC que especifica um protocolo;
- padrão técnico;
- documentação oficial de uma tecnologia;
- dataset original;
- relatório original que produziu determinado dado.
---
## Fontes secundárias
- surveys;
- revisões;
- livros que resumem estudos;
- artigos que citam outro trabalho.
São úteis para contextualização e descoberta, mas não substituem automaticamente a fonte original.
# PÁGINA 5.5 — Como citar tecnologias, padrões e documentação
Nem toda informação técnica precisa vir de artigo científico.
Para características de uma tecnologia, muitas vezes a fonte mais adequada é sua documentação oficial.
Exemplos:
- Kubernetes → documentação oficial;
- protocolo MQTT → especificação oficial;
- HTTP → RFC correspondente;
- linguagem → documentação oficial;
- API → documentação oficial.
---
## ⚠️ Não confunda documentação com evidência científica
Documentação pode comprovar:
> "Esta API possui este recurso."
Mas não necessariamente:
> "Esta API possui melhor desempenho que outra."
A segunda afirmação exige avaliação ou estudo comparativo.
# PÁGINA 5.6 — Gerenciamento de Referências no LaTeX/Overleaf
As referências bibliográficas devem ser cadastradas no arquivo de referências utilizado pelo template.
Não escreva manualmente a bibliografia no final do documento.
Cada referência deve possuir uma chave única.
Exemplo:
```
@article{silva2025intrusion,
author = {Silva, João and Souza, Maria},
title = {Intrusion Detection in IoT Environments},
journal = {Journal of Network Security},
year = {2025}
}
```
Depois, utilize essa chave no texto:
```
\cite{silva2025intrusion}
```
ou:
```
\citeonline{silva2025intrusion}
```
---
## Revise cada entrada bibliográfica
Não confie automaticamente no BibTeX exportado por Google Scholar, editoras ou outros sistemas.
Verifique:
- autores;
- título;
- ano;
- veículo de publicação;
- volume;
- número;
- páginas;
- DOI;
- URL, quando necessária;
- data de acesso, quando exigida;
- tipo correto da entrada.
---
## Preserve capitalização quando necessário
Alguns mecanismos bibliográficos podem alterar letras maiúsculas em títulos.
Termos que precisam manter sua capitalização podem exigir proteção no BibTeX.
Exemplo:
```
title = {Performance Analysis of {Kubernetes} in {IoT} Environments}
```
Isso ajuda a preservar nomes como:
- Kubernetes;
- IoT;
- MQTT;
- HTTP;
- TCP.
---
## Regra de consistência
Toda referência utilizada no texto deve possuir uma entrada válida no arquivo bibliográfico.
Antes da entrega, verifique se:
- não existem citações não resolvidas;
- não existem referências bibliográficas incompletas;
- os dados bibliográficos estão corretos;
- o padrão final está de acordo com a ABNT configurada no template.
---
# PÁGINA 5.7 — Checklist de citações e referências
- [ ] Afirmações provenientes da literatura possuem referências.
- [ ] Dados e números possuem fonte.
- [ ] Definições possuem fonte.
- [ ] Priorizei fontes primárias quando disponíveis.
- [ ] Utilizei documentação oficial para características técnicas quando apropriado.
- [ ] Evitei depender de blogs e fontes genéricas.
- [ ] Citações indiretas representam corretamente a ideia da fonte.
- [ ] Citações diretas foram utilizadas apenas quando justificadas.
- [ ] Todas as entradas bibliográficas foram revisadas.
- [ ] Não existem citações quebradas no PDF.
- [ ] Não existem referências sem utilização.
- [ ] Não existem afirmações fortes sustentadas por fontes inadequadas.
# CAPÍTULO 6 — SIGLAS, TERMOS E ELEMENTOS TEXTUAIS
# PÁGINA 6.1 — Siglas e abreviaturas
As siglas e abreviaturas do TCC devem ser gerenciadas utilizando o mecanismo de glossário disponibilizado no template LaTeX.
Evite escrever e controlar manualmente as siglas ao longo do documento.
---
## Defina a sigla no glossário
Cada sigla deve ser cadastrada uma única vez no arquivo ou local utilizado pelo template para gerenciamento do glossário.
Um exemplo de definição, dependendo da configuração utilizada, é:
```
\newacronym{iot}{IoT}{Internet of Things}
```
ou a estrutura equivalente definida pelo template institucional.
A forma exata de cadastro deve seguir a configuração já existente no projeto.
---
## Utilize `\gls`
Para utilizar uma sigla no texto, utilize:
```
\gls{iot}
```
O mecanismo de glossário poderá controlar automaticamente a apresentação da primeira ocorrência e das ocorrências seguintes, conforme a configuração do template.
---
## Utilize `\glspl` para plural
Quando a sigla estiver no plural, utilize:
```
\glspl{iot}
```
quando essa forma estiver corretamente configurada no glossário.
Evite construir plural manualmente, como:
```
\gls{iot}s
```
quando o mecanismo de glossário já oferece suporte ao plural.
---
## Por que utilizar o glossário?
O gerenciamento centralizado de siglas ajuda a:
- manter consistência;
- evitar redefinições;
- controlar a primeira ocorrência;
- gerar a lista de siglas;
- controlar formas no singular e plural;
- corrigir uma definição em apenas um local.
---
## ⚠️ Não escreva siglas manualmente quando elas estiverem cadastradas
Evite alternar entre:
```
IoT
```
e:
```
\gls{iot}
```
para a mesma sigla.
Se a sigla foi cadastrada no glossário, utilize os comandos correspondentes de forma consistente.
---
## Primeira ocorrência
O mecanismo do glossário deve ser utilizado para controlar a primeira ocorrência da sigla.
Isso evita situações como:
> Internet das Coisas (IoT) ...
em uma seção e posteriormente:
> Internet das Coisas (IoT) ...
novamente em outro capítulo.
A definição deve ser centralizada.
---
## Lista de siglas
A lista de abreviaturas e siglas deve ser gerada a partir das entradas efetivamente cadastradas e utilizadas no glossário, conforme os comandos já existentes no template.
Evite manter siglas:
- cadastradas mas nunca utilizadas;
- utilizadas mas não cadastradas;
- duplicadas com chaves diferentes.
# PÁGINA 6.2 — Termos em outra língua
Termos e expressões em outra língua utilizados ao longo do TCC devem ser apresentados em *itálico*.
No LaTeX, utilize:
```latex
\textit{termo}
```
## Exemplos
Para escrever *dataset*:
```latex
\textit{dataset}
```
Para escrever *framework*:
```latex
\textit{framework}
```
Para escrever *machine learning*:
```latex
\textit{machine learning}
```
Assim, sempre que uma palavra ou expressão estrangeira for utilizada no texto, verifique se ela deve ser apresentada em itálico.
---
## Prefira termos em português quando apropriado
Quando existir uma tradução consolidada e adequada para o contexto acadêmico, prefira o termo em português.
Por exemplo:
Em vez de:
> técnicas de *machine learning*
pode-se utilizar:
> técnicas de aprendizado de máquina
Da mesma forma:
> *network traffic*
pode ser escrito como:
> tráfego de rede
Entretanto, determinados termos técnicos são amplamente utilizados na área em sua forma original. Nesses casos, o termo estrangeiro pode ser mantido, devendo ser apresentado em *itálico*.
---
## Termo original junto à tradução
Em alguns casos, pode ser útil apresentar o termo original na primeira ocorrência para deixar clara a terminologia utilizada na literatura.
Exemplo:
> O aprendizado de máquina (*machine learning*) compreende técnicas que permitem \[...\]
Depois disso, utilize preferencialmente apenas:
> aprendizado de máquina
Não é necessário repetir a expressão estrangeira a cada ocorrência.
---
## ⚠️ Siglas são tratadas separadamente
Não confunda termos estrangeiros com siglas.
Por exemplo, **IoT** é uma sigla para *Internet of Things*. As siglas devem ser cadastradas no glossário e utilizadas por meio dos comandos:
```latex
\gls{iot}
```
e, quando aplicável:
```latex
\glspl{iot}
```
Consulte a **Página 6.1 — Siglas e abreviaturas** para as regras de gerenciamento de siglas.
---
## Nomes próprios, produtos e tecnologias
Nomes próprios de tecnologias, produtos, organizações e ferramentas **não devem ser colocados automaticamente em itálico apenas por serem estrangeiros**.
Por exemplo:
> Kubernetes
> Docker
> PostgreSQL
> GitLab
> Overleaf
> Linux
Esses nomes devem respeitar sua grafia oficial.
Portanto:
❌ *Kubernetes*
✅ Kubernetes
❌ *PostgreSQL*
✅ PostgreSQL
---
## Comandos, nomes de arquivos e elementos de código
Comandos, nomes de arquivos, parâmetros, funções e outros elementos computacionais devem utilizar a formatação apropriada definida pelo template, e não simplesmente itálico.
Por exemplo, um comando Linux pode ser apresentado como:
```latex
\texttt{grep}
```
resultando em:
`grep`
O mesmo princípio pode ser utilizado para nomes de arquivos, parâmetros e elementos semelhantes, conforme o contexto.
---
# Regra prática
Ao encontrar um termo em outro idioma, pergunte:
**É uma palavra ou expressão estrangeira?**
→ Utilize *itálico*.
**É uma sigla?**
→ Utilize `\gls{}` ou `\glspl{}`.
**É nome próprio de produto, tecnologia ou organização?**
→ Preserve a grafia oficial.
**É comando, código, nome de arquivo ou parâmetro?**
→ Utilize a formatação apropriada para código, como `\texttt{}`, quando aplicável.
# PÁGINA 6.3 — Nomes de tecnologias e produtos
Respeite a grafia oficial.
Por exemplo, não altere arbitrariamente:
- Kubernetes;
- PostgreSQL;
- GitLab;
- Overleaf;
- JavaScript.
Evite grafias inconsistentes ao longo do trabalho.
---
## Tecnologias não precisam ser exaltadas
Evite:
> O poderoso Kubernetes...
Prefira uma descrição técnica objetiva.
# PÁGINA 6.4 — Números, unidades e símbolos
Mantenha consistência na apresentação de medidas.
Exemplos:
- ms;
- s;
- MB;
- GB;
- Mbps;
- %.
Verifique as regras institucionais aplicáveis para espaçamento e formatação.
---
## Não misture unidades sem necessidade
Evite comparar:
> 500 ms e 1,2 s
sem considerar se uma unidade comum melhoraria a interpretação.
---
## Símbolos
Quando utilizar símbolos não triviais, explique seu significado na primeira ocorrência e inclua na lista de símbolos quando exigido.
# PÁGINA 6.5 - Uso correto dos comandos LaTeX do template
O template LaTeX foi criado para automatizar a formatação do TCC segundo as regras adotadas pela instituição.
Sempre que existir um comando próprio para determinado elemento, utilize-o em vez de tentar reproduzir manualmente a formatação.
## Exemplos
### Citações
Utilize:
```
\cite{referencia}
```
ou:
```
\citeonline{referencia}
```
### Referências cruzadas
Quando possível, utilize mecanismos de referência cruzada do LaTeX para figuras, tabelas, seções, equações e algoritmos, evitando escrever números manualmente.
Por exemplo:
```
Figura~\ref{fig:arquitetura}
```
em vez de:
```
Figura 4
```
Isso evita referências incorretas quando novos elementos são inseridos no documento.
---
## ⚠️ Evite formatação manual
Evite usar comandos apenas para "forçar" o documento a parecer correto, como:
- espaços manuais;
- várias quebras de linha;
- numeração digitada manualmente;
- referências digitadas manualmente;
- siglas controladas manualmente;
- títulos formatados individualmente.
O template deve controlar a apresentação.
> **Princípio geral:** informe ao LaTeX o significado do elemento e deixe o template controlar sua aparência.
# REGRA GERAL — NÃO LUTE CONTRA O TEMPLATE
O template LaTeX já foi configurado para automatizar grande parte da formatação acadêmica.
Portanto:
> **Evite corrigir visualmente o documento utilizando soluções manuais.**
Se algo não estiver sendo apresentado corretamente:
1. verifique se o comando correto está sendo utilizado;
2. verifique se o elemento foi cadastrado corretamente;
3. consulte o Guia;
4. consulte a documentação do template;
5. somente depois avalie se realmente existe necessidade de alterar a configuração.
Isso vale especialmente para:
- citações;
- referências;
- siglas;
- listas;
- figuras;
- tabelas;
- numeração;
- referências cruzadas;
- títulos;
- elementos pré e pós-textuais.
O aluno deve concentrar seu esforço no **conteúdo do TCC**, deixando para o template aquilo que pode ser automatizado.
# PÁGINA 6.6 — Checklist de siglas, termos e unidades
Antes de solicitar a revisão do texto, verifique os itens a seguir.
## Siglas e abreviaturas
- [ ] Todas as siglas utilizadas no texto estão cadastradas no glossário.
- [ ] Utilizei `\gls{}` para inserir as siglas no texto.
- [ ] Utilizei `\glspl{}` quando necessária a forma plural.
- [ ] Não escrevi manualmente uma sigla que está cadastrada no glossário.
- [ ] Não controlei manualmente a primeira ocorrência das siglas.
- [ ] Não existem siglas duplicadas no glossário.
- [ ] Não existem siglas utilizadas no texto sem cadastro no glossário.
- [ ] Não existem siglas cadastradas que não são utilizadas no documento.
- [ ] A lista de abreviaturas e siglas está sendo gerada corretamente pelo template.
## Termos em outra língua
- [ ] Termos e expressões em outra língua estão em *itálico*.
- [ ] Utilizei `\textit{}` para formatar termos estrangeiros quando necessário.
- [ ] Preferi termos consolidados em português quando apropriado.
- [ ] Quando necessário, apresentei o termo original junto à tradução na primeira ocorrência.
- [ ] Evitei alternar desnecessariamente entre o termo em português e o termo estrangeiro ao longo do documento.
## Nomes de tecnologias e produtos
- [ ] Respeitei a grafia oficial dos nomes de tecnologias, produtos e ferramentas.
- [ ] Não coloquei nomes próprios de tecnologias ou produtos em itálico apenas por serem estrangeiros.
- [ ] Utilizei a mesma grafia para cada tecnologia em todo o documento.
## Comandos e elementos de código
- [ ] Comandos, nomes de arquivos, parâmetros e elementos de código estão claramente diferenciados do texto normal.
- [ ] Utilizei a formatação apropriada, como `\texttt{}`, quando aplicável.
- [ ] Não utilizei itálico para representar código apenas por ele estar em inglês.
## Números, unidades e símbolos
- [ ] As unidades de medida estão identificadas.
- [ ] Mantive consistência na utilização das unidades ao longo do documento.
- [ ] Evitei misturar unidades diferentes desnecessariamente.
- [ ] Símbolos não triviais foram definidos na primeira ocorrência.
- [ ] Os símbolos que precisam constar na Lista de Símbolos foram cadastrados conforme o mecanismo definido pelo template.
- [ ] A precisão e o número de casas decimais estão consistentes quando aplicável.
## Verificação final
Antes de considerar a revisão concluída, procure especificamente no documento por:
**Siglas** → estão sendo gerenciadas com `\gls{}` e `\glspl{}`?
**Termos estrangeiros** → estão em `\textit{}`?
**Tecnologias e produtos** → estão com a grafia oficial?
**Comandos e código** → estão formatados adequadamente, como com `\texttt{}`?
**Unidades e símbolos** → estão definidos e utilizados de forma consistente?
> **Regra prática:** não formate todos os termos técnicos da mesma maneira. Siglas, palavras estrangeiras, nomes próprios, código e unidades são elementos diferentes e devem ser tratados de acordo com sua função no texto.
# CAPÍTULO 7 — REVISÃO ANTES DE ENTREGAR
# PÁGINA 7.1 — Como revisar seu próprio texto
Não envie uma seção imediatamente depois de escrevê-la.
A primeira revisão deve ser realizada pelo próprio aluno.
Um processo recomendado é:
**Escrever → Pausar → Reler → Corrigir → Aplicar checklist → Solicitar revisão**
---
## Faça mais de uma leitura
Cada leitura pode ter um objetivo diferente.
### Primeira leitura — Conteúdo
O argumento está correto?
### Segunda — Estrutura
Existe sequência lógica?
### Terceira — Escrita
Existem frases confusas ou erros?
### Quarta — Elementos
Figuras, tabelas, referências e siglas estão corretas?
Essa estratégia costuma ser mais eficiente do que tentar verificar tudo ao mesmo tempo.
# PÁGINA 7.2 — Revisão técnica
Pergunte:
- Os conceitos estão tecnicamente corretos?
- Todas as tecnologias estão corretamente descritas?
- As versões estão corretas?
- Os parâmetros estão corretos?
- Os métodos foram descritos corretamente?
- Os objetivos estão consistentes?
- A metodologia corresponde ao que realmente foi realizado?
- As conclusões são sustentadas pelos resultados?
# PÁGINA 7.3 — Revisão textual
Verifique:
- ortografia;
- concordância;
- pontuação;
- repetição;
- frases excessivamente longas;
- parágrafos excessivamente longos;
- termos vagos;
- mudanças abruptas;
- linguagem informal.
---
## Leia como se não conhecesse o trabalho
Você já conhece seu TCC.
O leitor não.
Informações que parecem óbvias para você podem não estar explícitas no texto.
Pergunte:
> Uma pessoa da área, mas que não participou do projeto, conseguiria compreender este parágrafo?
# PÁGINA 7.4 — Revisão de referências e elementos visuais
Para cada figura, tabela, quadro e algoritmo:
- localize sua ocorrência;
- verifique se foi citado antes;
- verifique se foi explicado;
- verifique legenda;
- verifique fonte;
- verifique legibilidade.
---
## Referências
Procure no PDF:
> ??
Esse símbolo pode indicar referências cruzadas ou citações não resolvidas no LaTeX.
Também verifique avisos de compilação relevantes.
# PÁGINA 7.5 — Checklist geral de autorrevisão
Antes de solicitar revisão ao orientador:
## Texto
- [ ] Reli integralmente a seção.
- [ ] Corrigi erros ortográficos identificados.
- [ ] Revisei frases confusas.
- [ ] Revisei parágrafos muito longos.
- [ ] Removi repetições desnecessárias.
- [ ] Evitei linguagem informal.
- [ ] Evitei afirmações vagas.
## Literatura
- [ ] Definições possuem referências.
- [ ] Afirmações provenientes de terceiros possuem fontes.
- [ ] Números e estatísticas possuem fontes.
- [ ] Referências utilizadas são adequadas.
- [ ] Priorizei fontes primárias quando possível.
## Elementos visuais
- [ ] Toda figura foi mencionada e descrita.
- [ ] Toda tabela foi mencionada e analisada.
- [ ] Todo quadro foi mencionado e explicado.
- [ ] Todo algoritmo foi mencionado e explicado.
- [ ] Todas as fontes estão indicadas.
- [ ] Todos os elementos estão legíveis.
## Terminologia
- [ ] Termos em outra língua estão em itálico.
- [ ] Siglas foram definidas.
- [ ] Terminologia está consistente.
- [ ] Unidades estão corretas.
## Documento
- [ ] O PDF compila sem erros relevantes.
- [ ] Não existem citações não resolvidas.
- [ ] Não existem referências cruzadas quebradas.
- [ ] Não existem figuras ausentes.
- [ ] Não existem seções vazias.
- [ ] Não existem listas vazias desnecessárias.
# REGRA FINAL DE AUTORREVISÃO
Antes de solicitar que outra pessoa encontre problemas no seu texto, procure você mesmo os problemas que já consegue identificar.
A revisão do orientador deve se concentrar prioritariamente em:
- conteúdo;
- coerência científica;
- metodologia;
- argumentação;
- interpretação;
- decisões relevantes.
Não utilize o tempo de orientação para corrigir repetidamente problemas mecânicos que podem ser identificados por meio deste Guia e dos checklists.
> **Autorrevisão não elimina a revisão do orientador. Ela torna a revisão do orientador mais útil.**