Como citar códigos e diagramas de software na ABNT
Aprenda a adaptar blocos de código, diagramas e tabelas de sistemas nas normas da ABNT para projetos acadêmicos e TCCs sem erros.
Resumo
- Blocos extensos de código devem ser inseridos como ilustrações ou anexos conforme a extensão do script.
- A fonte e a nota explicativa precisam constar obrigatoriamente abaixo de qualquer figura ou tabela técnica.
- O uso de fontes monoespaçadas preserva a indentação original e evita quebras visuais em editores de texto.
- Diagramas arquiteturais exigem rotulagem padronizada com numeração sequencial vinculada ao tipo de elemento.
- Trechos curtos integrados ao parágrafo dispensam formatação especial de figura, desde que destacados com clareza.
O desafio de documentar sistemas nas normas acadêmicas
Escrever um trabalho de conclusão de curso ou artigo científico na área de tecnologia traz um atrito clássico: como encaixar estruturas puramente técnicas, como trechos de código-fonte, diagramas de arquitetura de microsserviços e tabelas de banco de dados, nas rígidas regras da ABNT (Associação Brasileira de Normas Técnicas). Na prática, isso significa traduzir a linguagem visual e sintática dos softwares para o padrão formal de papel, margens e fontes. O grande erro que a maioria dos estudantes comete é tentar colar capturas de tela ou scripts inteiros de qualquer maneira, gerando problemas graves de formatação que comprometem a nota final e o rigor metodológico. A ABNT não foi desenhada originalmente para a engenharia de software moderna, mas com a adaptação correta dos conceitos de figuras, ilustrações e tabelas, é perfeitamente possível manter a elegância técnica sem infringir nenhuma norma institucional.
Quando o código vira figura, quadro ou tabela na ABNT
A primeira grande dúvida ao redigir documentação técnica é decidir se um trecho de software deve ser tratado como ilustração, tabela ou quadro. Na taxonomia da ABNT, ilustrações englobam gráficos, fluxogramas, organogramas, mapas e desenhos, categoria onde os diagramas de arquitetura (como UML ou fluxos de nuvem) entram perfeitamente. Já o código-fonte em linguagens como Python, JavaScript ou SQL gera uma zona cinzenta: se o bloco for curto, ele pode ser incorporado diretamente no fluxo do parágrafo utilizando fontes monoespaçadas, mas se for um script funcional extenso, a melhor prática é tratá-lo como um elemento gráfico ou colocá-lo diretamente nos anexos e apêndices do documento. Se você precisa organizar dados estruturados de uma API ou migrações de banco de dados, o uso de tabelas abertas nas laterais e com cabeçalhos claros resolve a demanda com precisão, dialogando diretamente com orientações que já discutimos sobre como estruturar sumários e listas automáticas na ABNT.
Regras de ouro para formatar blocos de código e scripts
A formatação de um trecho de código dentro de um trabalho acadêmico exige cuidados estéticos e funcionais rigorosos para garantir a legibilidade. O código nunca deve ser inserido como imagem estática de baixa resolução, pois isso impede a leitura por leitores de tela e destrói a qualidade visual quando o PDF é gerado. Prefira sempre digitar o texto usando uma fonte monoespaçada padrão, como Courier New ou Consolas, mantendo o tamanho de fonte menor que o do texto corrido (geralmente tamanho 10) e espaçamento entrelinhas simples. Além disso, a indentação — que é o recuo lateral que organiza a hierarquia das funções e loops — deve ser rigorosamente preservada com espaços ou tabulações consistentes para que a lógica do algoritmo permaneça compreensível para a banca examinadora. Para evitar que erros estruturais de margem ou paginação derrubem a qualidade do seu documento, vale a pena conferir as orientações detalhadas em por que as margens e a paginação da ABNT causam erros recorrentes nos editores de texto.
Como rotular e referenciar diagramas e ilustrações técnicas
Todo diagrama técnico, seja um fluxo de autenticação OAuth2 ou um modelo entidade-relacionamento, deve ser precedido por uma identificação clara na parte superior, contendo a palavra 'Figura', seguida pelo número de ordem, travessão e o título descritivo. Por exemplo: 'Figura 1 — Arquitetura de mensageria assíncrona baseada em filas'. Abaixo da ilustração, é obrigatório inserir a fonte consultada, mesmo que o diagrama tenha sido desenvolvido pelo próprio autor do trabalho, situação em que se utiliza a expressão 'Fonte: Elaborado pelo autor (2025)'. Essa rastreabilidade é fundamental para evitar acusações de plágio e garantir a integridade acadêmica da pesquisa. Caso o diagrama tenha sido extraído de uma documentação oficial ou de um artigo científico de terceiros, a citação completa deve seguir rigorosamente as normas de autoria, garantindo que o leitor consiga rastrear a origem exata daquela decisão de arquitetura, complementando processos automatizados de escrita como os discutidos em como formatar referências da ABNT no Word automaticamente.
Cuidados essenciais na hora de fechar o documento para entrega
Antes de exportar o seu projeto acadêmico para o formato final de entrega, faça uma varredura minuciosa em todos os elementos gráficos e blocos de código inseridos. Verifique se nenhuma linha de código foi cortada nas margens laterais devido ao excesso de caracteres por linha, ajustando o tamanho da fonte ou quebrando os comandos longos de forma controlada. Certifique-se também de que a numeração das figuras e tabelas está perfeitamente sincronizada com o texto, evitando referências cruzadas quebradas que confundem o avaliador. A consistência visual e o respeito às normas demonstram o profissionalismo do engenheiro ou desenvolvedor, provando que ele domina tanto a construção do software quanto a comunicação técnica formal exigida pela academia.