Marcio Cunha

Cómo citar códigos y diagramas de software en ABNT

Aprenda a adaptar bloques de código, diagramas de arquitectura y tablas de sistemas a las normas ABNT para proyectos académicos.

Marcio Cunha•3 min
También disponible en:PortuguêsEnglish
Resumen
  • Los bloques extensos de código deben insertarse como ilustraciones o apéndices según su extensión total.
  • La fuente y la nota explicativa deben aparecer obligatoriamente debajo de cualquier figura o tabla técnica.
  • El uso de fuentes monoespaciadas preserva la indentación original y evita rupturas visuales en editores.
  • Los diagramas arquitectónicos requieren un etiquetado estandarizado con numeración secuencial vinculada al tipo.
  • Los fragmentos cortos integrados al párrafo no requieren formato especial de figura si se destacan bien.

El reto de documentar sistemas en las normas académicas

Escribir un trabajo de conclusión de curso o artículo científico en tecnología trae una fricción clásica: cómo encajar estructuras puramente técnicas, como fragmentos de código, diagramas de arquitectura y tablas de bases de datos, en las rígidas reglas de la ABNT. En la práctica, esto significa traducir el lenguaje visual y sintáctico del software al estándar formal de papel, márgenes y fuentes. El gran error que comete la mayoría de los estudiantes es intentar pegar capturas de pantalla o scripts enteros de cualquier manera, generando problemas graves de formato que comprometen la nota final y el rigor metodológico. La ABNT no fue diseñada originalmente para la ingeniería de software moderna, pero con la adaptación correcta de figuras, ilustraciones y tablas, es perfectamente posible mantener la elegancia técnica sin infringir ninguna norma institucional.

Cuándo el código se convierte en figura, cuadro o tabla en ABNT

La primera gran duda al redactar documentación técnica es decidir si un fragmento de software debe tratarse como ilustración, tabla o cuadro. En la taxonomía de ABNT, las ilustraciones engloban gráficos, diagramas de flujo y mapas, categoría donde los diagramas de arquitectura entran perfectamente. El código fuente en lenguajes como Python, JavaScript o SQL genera una zona gris: si el bloque es corto, puede incorporarse directamente en el flujo del párrafo usando fuentes monoespaciadas, pero si es un script funcional extenso, la mejor práctica es tratarlo como un elemento gráfico o colocarlo en los apéndices. Si necesitas organizar datos estructurados de una API, el uso de tablas abiertas en los laterales y con encabezados claros resuelve la demanda con precisión, dialogando directamente con guías sobre cómo estructurar índices y listas automáticas en ABNT.

Regras de oro para formatear bloques de código y scripts

Formatar un fragmento de código dentro de un trabajo académico exige cuidados estéticos y funcionales rigurosos para garantizar la legibilidad. El código nunca debe insertarse como imagen estática de baja resolución, ya que esto impide la lectura por lectores de pantalla y destruye la calidad visual al generar el PDF. Prefiere siempre escribir el texto usando una fuente monoespaciada estándar, manteniendo un tamaño de fuente menor que el texto corrido y un interlineado simple. Además, la indentación debe conservarse rigurosamente con espacios o tabulaciones consistentes para que la lógica del algoritmo permanezca comprensible para el comité evaluador. Para evitar que errores de margen o paginación arruinen tu documento, revisa las orientaciones en por qué los márgenes y la paginación de ABNT causan errores recurrentes.

Cómo etiquetar y referenciar diagramas e ilustraciones técnicas

Todo diagrama técnico, ya sea un flujo de autenticación o un modelo entidad-relación, debe ir precedido por una identificación clara en la parte superior, conteniendo la palabra 'Figura', seguida del número de orden y el título descriptivo. Debajo de la ilustración, es obligatorio insertar la fuente consultada, incluso si el diagrama fue desarrollado por el autor, usando la expresión 'Fuente: Elaborado por el autor (2025)'. Esta trazabilidad es fundamental para evitar acusaciones de plagio y garantizar la integridad académica. Si el diagrama fue extraído de una documentación oficial de terceros, la cita completa debe seguir rigurosamente las normas de autoría, complementando procesos de escritura automatizados como los discutidos en cómo formatear referencias de ABNT en Word automáticamente.

Cuidados esenciales al finalizar el documento para entrega

Antes de exportar tu proyecto académico al formato final de entrega, haz una revisión exhaustiva en todos los elementos gráficos y bloques de código insertados. Verifica que ninguna línea de código haya sido cortada en los márgenes laterales debido al exceso de caracteres, ajustando el tamaño de la fuente o rompiendo comandos largos de forma controlada. Asegúrate también de que la numeración de figuras y tablas esté perfectamente sincronizada con el texto, evitando referencias cruzadas rotas que confunden al evaluador. La consistencia visual y el respeto a las normas demuestran el profesionalismo del ingeniero o desarrollador, probando que domina tanto la construcción de software como la comunicación técnica formal exigida por la academia.