Redacción de Textos Científicos

Las siguientes recomendaciones son aplicables a la redacción de los resultados obtenidos luego de desarrollar un proyecto de tesis en el ámbito de las disciplinas de la computación (ciencias de la computación, ingeniería de computadores, ingeniería de software y sistemas de información).

No existe una forma estricta y única de escribir un reporte, el estilo particular, la claridad de expresión de las ideas y la coherencia de redacción se depuran con el tiempo, por medio del ejercicio y de la adquisición de la disciplina de escritura.

El formato de composición que describiremos enseguida deberá ser tomado solamente como una recomendación. La descripción pretende orientar a aquellas personas, que carezcan de formación acerca de la elaboración de reportes, con el ﬁn de que tengan una base sobre la cual realizar su redacción. Nuestro interés es motivar principalmente a los alumnos a desarrollar sus propios reportes técnicos, con objeto de que sean enseguida sometidos al proceso de evaluación.

Un aspecto importante de los reportes técnicos es la amplitud de los mismos, este deberá de ceñirse estrictamente a los estándares proporcionados por el docente, asesor o comité de evaluación.

Un reporte técnico estándar se estructura bajo el siguiente formato:

Título y encabezados. El reporte debe tener un título referente al contenido del trabajo. El título debe evitar en lo posible el uso de nombres propios y debe de expresar el objetivo de su trabajo. Por otro lado se incluirá acerca de los autores, sus adscripciones y la fecha de redacción del documento.

Resumen. El resumen se describe, de manera breve y general, el contenido global del reporte. El promedio de longitud para un resumen es de entre 200 y 300 palabras. El resumen debe de informar al lector en forma breve el objetivo, el método usado y el sujeto de la investigación, así como el procedimiento usado y las conclusiones a las que se ha llegado.

Se aconseja la declaración de las palabras claves usadas en el reporte, para facilitar la clasificación y establecer mecanismos de consulta al documento. En lo posible se debe de incluir la definición de las palabras claves.

Introducción. La introducción forma en sí parte del cuerpo del documento. En esta sección se establecen los antecedentes necesarios para el tratamiento del tema (revisión de la bibliografía). Se especifica el problema que motiva el análisis y se describe el objetivo del documento (i.e. dado un problema se pretende establecer una teoría, una metodología de análisis o bien formular una solución particular). Opcionalmente se describe el contenido del documento, describiendo su contenido temático sección por sección.

Marco Teórico. Esta parte del documento se puede estructurar en varias secciones. En ella se presenta el planteamiento formal del problema y de la metodología de análisis. Enseguida se realiza el desarrollo analítico requerido, con el ﬁn de obtener los resultados planteados como objetivo. Para situar la relevancia del trabajo, se incluye un breve análisis bibliográfico sobre el estado del arte, en relación al avance de trabajos similares a nivel local, nacional e internacional. Se debe de tener en consideración que el desarrollo teórico sustenta los conceptos y métodos a ser usados en el desarrollo experimental y no constituye el trabajo propiamente dicho.

Es importante que no o abulte esta parte del documento, explicando todos los detalles, exponga sólo los conceptos que usará más adelante.

Metodología de trabajo o modelo de solución. Esta parte del documento se describe los pasos metodológicos para abordar el problema a resolver, estos pasos deben ser claros y precisos, la metodología aplicada corresponde a la estrategia usada por el investigador para resolver el problema.

Desarrollo del proyecto. En esta parte del documento, la cual también puede contener varias secciones, se describe detalladamente cada uno de los pasos metodológicos seguidos para resolver el problema, se trata de presentar mayor detalle de cada uno de los pasos indicados en la sección anterior. Es importante que al redactar esta(s) sección(es) se presente ejemplos. Se describe los módulos del sistema usado, la estructura del ﬂujo de trabajo, la estructura del ﬂujo de la información, etc. Se describen en detalle de los procedimientos implementados, utilizando ejemplos demostrativos de funcionamiento al tratar casos típicos.

Esta sección es la más importante del reporte, dado que expone los aportes logrados por el investigador, todos los conceptos usados deben ser sustentados en la sección del marco teórico.

Desarrollo experimental. En esta parte del documento, que puede contener varias secciones, se describe los aspectos de implementación, experimentación e implantación realizadas para validar los planteamientos teóricos expuestos. Aquí se describen la configuración del equipo, los sistemas y los lenguajes de programación utilizados durante las etapas de implementación y experimentación.

Se describen las evaluaciones cuantitativas y cualitativas del comportamiento del sistema, en cuanto a tiempo, complejidad y espacio de memoria requeridos. Asimismo se describen ejemplos de los casos favorables y desfavorables para el sistema, haciéndose notar las características que provocan tales casos.

Conclusiones y Recomendaciones. En esta sección se establecen las conclusiones del estudio, sustentados por el trabajo experimental. Se puntualiza las ventajas del análisis, método o sistema descrito; en relación a los referidos en el análisis bibliográfico. Se describe las limitaciones del trabajo y en qué medida dichas restricciones condicionan el desempeño del sistema.

Trabajos Futuros. En esta sección se establecen recomendaciones para el desarrollo de trabajos futuros, en aspectos considerados dentro de las limitaciones del trabajo actual. Los trabajos futuros están encaminados a reducir o eliminar las limitaciones expuestas.

Reconocimientos. Se hace un reconocimiento explícito, en esta sección (no numerada) de los organismos que patrocinaron el estudio; mencionando el formato de la ayuda y en su caso el número de contrato. Se agradece igualmente a las personas que, no siendo autores, participaron en el desarrollo del proyecto o colaboraron en la redacción y corrección del documento (asesores, revisores, secretarias y dibujantes).

Bibliografía. El objetivo de la bibliografía es situar al lector dentro del contexto metodológico y técnico en el cual se realizó el trabajo. Por tal motivo, la bibliografía deberá contener todas las referencias enunciadas en el texto y exclusivamente estas. Deberá evitarse, a menos que el objetivo sea ese, la enumeración exhaustiva de documentos, que convierten al reporte en un compendio enciclopédico. Las referencias deberán relacionarse directamente con el trabajo desarrollado, evitándose las referencias redundantes o inútiles que confunden al lector. Evitará en lo posible colocar como referencias URLs, dado que estos pueden darse de baja.

El momento apropiado para situar las citas (referencias bibliográficas), es durante el análisis bibliográfico del estado del arte. Las citas pueden aparecer en el resto del texto de forma puntual, únicamente para soportar o subrayar una aseveración. Deberán evitarse las citas reiterativas y las citas textuales, las cuales entorpecen la ﬂuidez del discurso.

Anexos Técnicos. Los anexos tienen formato de secciones numeradas alfabéticamente y están constituidos por documentos técnicos complementarios. Deberán incluirse exclusivamente los documentos que ayuden a una comprensión detallada del reporte o que auxilien en el uso del sistema descrito. Los documentos inútiles (listados innecesarios, despliegues irrelevantes, listados de programas, etc.) que solo tienden a engrosar el volumen del documento, deberán evitarse.

Entre los documentos técnicos considerados importantes, podemos anotar:

El complemento del desarrollo de una prueba matemática.
Descripción de metodologías complementarias. Por ejemplo, la descripción del álgebra utilizada para resolver un problema particular (la descripción de quaterniones en un tratado de Robótica, los pasos aplicados en un método de resolución).
Manuales de uso, instalación o programación de un sistema, evitando innecesarias repeticiones de pantallas.
Formatos especiales requeridos para la descripción o funcionamiento del sistema. Por ejemplo: los formatos de captura de información o los diagramas de Ishikawa.
Listados de programas, cuando éstos contengan un alto nivel descriptivo. De preferencia deberán incluirse únicamente los programas y rutinas principales. En este caso se recomienda el uso de pseudocódigos.