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: 
 
 introduza sua finalidade; 
 apresente a equação; 
 defina todas as variáveis; 
 informe unidades quando aplicável; 
 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.