# 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.