/ Documenta ML / Escribe mejor tu tesis

Cómo Escribir Mejor Tu Tesis en Machine Learning

Guía práctica de redacción y documentación para proyectos de IA

15 min de lectura Licenciatura · Maestría · Doctorado

¿Qué encontrarás en esta guía?

  • Cómo planear la redacción antes de escribir una sola línea
  • Qué errores de estilo arruinan documentos técnicos
  • Cómo citar fuentes y referenciar figuras correctamente
  • Qué debe ir en cada sección de tu documentación

Saber hacer Machine Learning no basta si no puedes comunicarlo.

Esta guía está basada en lineamientos reales usados en cursos de ingeniería. El objetivo es que tu documentación sea clara, estructurada y defendible.


Fase 1Antes de escribir: la importancia de planear

El error más común no es escribir mal. Es escribir sin saber qué se quiere decir.

Un buen programador no empieza a escribir código sin antes entender el problema. Lo mismo aplica a la redacción: escribir un documento debe venir después de pensar qué se va a escribir y en qué orden.

Como dice el refrán: ningún viento es favorable para el que no sabe a qué puerto se dirige.

El objetivo de tu documentación es comunicar con claridad cuál es tu proyecto, cómo lo desarrollaste y por qué tomaste las decisiones que tomaste.

Cómo planear el contenido paso a paso

  • Asegúrate de entender bien el tema. Si no estás seguro, investiga primero.
  • Escribe en una hoja el objetivo que quieres lograr al escribir esa sección.
  • Escribe todas las ideas que contribuyan a ese objetivo.
  • Selecciona solo las ideas que realmente aporten.
  • Elige el orden en que las presentarás: causa–efecto, problema–solución, cronológico.

Solo después de tener ese mapa mental estás en condición de empezar a escribir.

Hacer esto ahorra tiempo y frustraciones. No es burocracia: es evitar reescribir todo desde cero a mitad del proceso.


Fase 2Al momento de escribir: estilo, claridad y coherencia

Una vez que sabes qué vas a escribir y en qué orden, es importante hacerlo con claridad.

Aquí no se trata de escribir bonito. Se trata de escribir para que se entienda.

Sobre el estilo

El estilo tiene que ver con cómo agrupas las palabras para formar oraciones. Algunas reglas prácticas:

  • El documento debe ser claro y fluido. Una oración debe llevar a la siguiente; un párrafo debe llevar al siguiente.
  • Las oraciones largas son más difíciles de entender que las cortas. Mientras más larga, mayor la probabilidad de que el lector pierda el hilo.
  • Una oración tiene idealmente entre 8 y 15 palabras. Un párrafo puede tener hasta 14 líneas.
  • Evita anglicismos innecesarios: checar, parquear, cachar, troca y similares no pertenecen a un documento técnico.

Sobre semántica y lenguaje consistente

La semántica tiene que ver con el significado de las palabras. La pragmática con lo que se entiende de una frase completa.

Antes de escribir, asegúrate de saber exactamente qué significa cada palabra que usas. Por ejemplo: ¿sabes la diferencia entre éste, esté y este? ¿Entre qué, que, porqué y por qué?

Usa siempre la misma palabra para referirte a la misma idea.

Si en una sección llamas "función" a una capacidad del sistema, no la llames después "instrucción" o "comando" sin razón. El uso de sinónimos es válido para no hacer el texto monótono, pero no debe oscurecer el concepto central.

Cómo evitar el encabalgamiento

El encabalgamiento es el error más común entre quienes escriben como hablan: juntando dos ideas en una sola oración sin relación gramatical entre ellas.

Para evitarlo, recuerda:

  • No uses comas para separar ideas. Si tienes duda de si poner coma o no, haz dos oraciones.
  • El punto y coma se usa cuando dos ideas están tan relacionadas que no deben separarse por un punto.
  • Para separar ideas distintas, usa punto y seguido.

Sobre abreviaciones y acrónimos

Nunca asumas que el lector conoce un acrónimo.

La primera vez que aparezca en el texto, escribe la frase completa y el acrónimo entre paréntesis:

En la Programación Orientada a Objetos (POO) ...

A partir de ahí puedes usar el acrónimo libremente en el resto del documento.

Las abreviaciones en general es preferible evitarlas, a menos que sean estándar en el campo.


Fase 3Cómo citar fuentes y referenciar elementos

Formato APA

Las citas a fuentes de información se hacen en formato APA.

Hay dos formas de citar en el texto:

Con énfasis en el autor:

Kaku (2009) afirma que... (p.90)

Con énfasis en el texto:

"frase textual entre comillas" (Kaku, 2009, p.90)

Recuerda: la cita debe aparecer en el texto, no solo en la sección de Referencias al final. Son dos cosas distintas.

Referencia a figuras, tablas y algoritmos

Ninguna figura, tabla o algoritmo debe aparecer en la documentación sin ser referenciado en el texto.

No estás escribiendo una novela de misterio. Si incluyes un elemento visual, explica en el texto para qué sirve y cuándo mirarlo.

Formato estándar:

  • Las figuras van numeradas y con pie de figura: Figura 1. Descripción breve.
  • Las tablas van numeradas y con título: Tabla 1. Descripción breve.
  • Los algoritmos se nombran y se explica su función antes de presentarlos.

Fase 4Después de escribir: qué revisar

Terminar el borrador no es terminar el documento. Siempre hay que revisar.

Errores tipográficos

  • El tipo de fuente es el mismo en todo el documento
  • El texto está justificado
  • Se cumplen todos los formatos de edición acordados
  • Los números de página en el índice coinciden con el documento

Errores ortográficos

  • Ninguna palabra está mal escrita
  • Todos los signos de puntuación están justificados
  • Se hace uso correcto de mayúsculas

Errores de estilo

  • Las oraciones se entienden de forma autónoma
  • Cada párrafo explica adecuadamente lo que quería exponer
  • Cada sección contiene la información que le corresponde
  • Se citan todas las fuentes consultadas
  • Se referencian todas las figuras, tablas, ecuaciones y algoritmos

ReferenciaEstructura de la documentación del proyecto

Una documentación de proyecto de ingeniería o tesis en ML tiene secciones bien definidas. Aquí está qué va en cada una.

Portada

Su propósito es informar de forma rápida. No la sobrecargues con imágenes grandes o innecesarias.

Debe incluir:

  • Logotipo de la institución
  • Título — no debe ser ambiguo; debe describir el proyecto con precisión
  • Nombre de los integrantes del equipo
  • Un solo correo de contacto
  • Fecha actualizada

Resumen

Un párrafo de aproximadamente 250 palabras que condensa todo el documento.

Debe explicar el problema, los métodos propuestos y los resultados obtenidos.

Es lo primero que se lee a conciencia, así que resalta la relevancia del proyecto.

Escríbelo con el menor tecnicismo posible para que lectores no especializados también lo entiendan.

Índice

Proporciona al lector el orden del documento y los números de página para encontrar cada sección.

Verifica que los números coincidan con el documento final antes de entregar.

Introducción

Presenta el protocolo del proyecto. El lector debe ser capaz de responder estas preguntas después de leerla:

  • ¿Cuál es el problema que se quiere resolver?
  • ¿Cómo se ha intentado resolver antes? ¿Qué soluciones similares existen?
  • ¿Qué hace necesario este proyecto?
  • ¿Qué se pretende lograr?

No respondas las preguntas una por una. Redáctalas como un texto fluido que las responda implícitamente.

Análisis de factibilidad

Una sección breve que responde dos preguntas concretas:

  • Factibilidad comercial: descripción del mercado, competidores directos e indirectos, riesgos asociados
  • Factibilidad técnica: ¿se pueden conseguir los elementos necesarios? ¿es posible hacer un prototipo? ¿se tienen las habilidades para ejecutarlo?

Marco teórico

Explica el conocimiento necesario para entender la sección de Materiales y Metodología.

Incluye información sobre los componentes o tecnologías que usarás, y contexto técnico del problema que estás resolviendo.

No incluyas información de relleno. El objetivo es que el lector entienda el documento, no demostrar que leíste mucho.

Materiales y Metodología

Esta es la sección más importante.

Su propósito es describir con precisión cada algoritmo, modelo, sistema y método que se implementó en el proyecto.

Debe ser suficientemente detallada para que alguien pueda reproducir tu trabajo. Si no está aquí, no existe.

Resultados

Presenta los logros obtenidos en la implementación.

Cada resultado debe estar acompañado de métricas, figuras o tablas que lo respalden — y referenciados en el texto, no simplemente adjuntados.

Conclusiones

Describe la relevancia de los resultados obtenidos y el trabajo que queda pendiente a futuro.

No repitas lo que ya dijiste en Resultados. Interpreta. Conecta los hallazgos con el problema original.

Apéndices y Glosario

Los apéndices incluyen material relacionado con el proyecto que no es estrictamente necesario para entenderlo: investigaciones adicionales, código complementario, anexos.

El glosario define los términos técnicos relevantes que el lector podría desconocer.

Referencias

Incluye todas las fuentes consultadas en formato APA.

Recuerda: una fuente que no está citada en el texto no debería estar en Referencias. Y una fuente citada en el texto debe aparecer aquí, sin excepción.