Guía para la realización de memorias de prácticas e informes en general
(Aplicable a los
laboratorios del profesor Fernando Pardo Carpio)
Ingeniería Informática
Fernando Pardo Carpio
20 de febrero de 2001
Guía en formato PostScript
Guía en formato PDF
Guía en formato Word
Índice de contenidos
2 Parte sobre el desarrollo del trabajo
2.3 Descripción del trabajo realizado
4.1 Presentación general de un informe
4.2 Directrices particulares para las memorias de laboratorio
4.3 Directrices particulares para los listados de programas
4.4 Algunas reglas mecanográficas
4.5 Otras sugerencias interesantes
La presente guía está dividida en partes y pretende emular de alguna manera la estructura que tendría una memoria o informe sobre un trabajo. Esta primera parte es la de introducción.
La realización de memorias sobre las prácticas realizadas en el laboratorio tiene una utilidad doble: por un lado le sirve al alumno para repasar los contenidos vistos en la sesión práctica completando así la parte teórica de la clase práctica; por otro lado la realización de informes sobre trabajos técnicos es parte de la actividad profesional del ingeniero superior, por lo que el aprendizaje en la realización de estos trabajos debe estar incorporado en su formación.
Los informes y memorias son el mecanismo que tiene el ingeniero para presentar el trabajo realizado. La comunicación entre ingenieros es fundamental para el desarrollo tecnológico actual. No sirve para nada que un ingeniero desarrolle un trabajo fantástico si no lo da a conocer de forma que sea útil para otros profesionales. El objetivo de un informe o proyecto es dar a conocer a la comunidad científica un determinado trabajo realizado, de manera que pueda ser utilizado y/o juzgado por otros profesionales.
El presente documento pretende ser una guía de realización de informes y memorias para el estudiante. En esta guía se dan algunas líneas generales de cómo debe escribirse y estructurarse un informe o memoria para los trabajos que se piden en algunos laboratorios de Ingeniería Informática.
Esta guía no pretende dar unas directrices estrictas de cómo hacer las memorias, tampoco todas las memorias de todas las asignaturas tienen por qué seguir estas guías; dependiendo del tipo de trabajo realizado o de la extensión del informe a realizar, habrán unas directrices que serán más interesantes que otras.
Estas directrices, sin embargo, serán de obligado cumplimiento para aquellas asignaturas de laboratorio impartidas por el profesor Fernando Pardo.
Esta guía, además de dar unas pautas para la realización de informes, se ha desarrollado de manera que el propio texto sea un ejemplo de lo que se está explicando. Se observará que la estructura y los contenidos siguen las mismas directrices que se explican en el propio texto. Naturalmente esta guía no es un informe sobre un trabajo práctico llevado a cabo, por lo que en algunos casos la estructura y contenidos puede diferir.
Los objetivos de un trabajo de innovación, desarrollo o investigación forman una de las partes fundamentales en la presentación del mismo. Normalmente los objetivos suelen colocarse delante o detrás de una breve introducción al trabajo realizado.
Los objetivos deben quedar claros. Antes de dar una explicación del alcance, motivación y justificación de los objetivos, resulta conveniente enumerarlos de forma clara mediante ítems o en forma de tabla, posteriormente se pueden comentar brevemente.
En el caso de esta guía se podrían poner como objetivos los siguientes:
· Presentación de una estructura para la realización de informes.
· Particularización al caso de las memorias de prácticas.
· Que el alumno tenga una guía sobre la que basarse para realizar las memorias.
· Que esta guía sea útil tanto para las memorias de las prácticas como para la realización de informes en general.
A continuación se podría dar una breve explicación sobre cada uno de estos objetivos. La explicación y justificación de estos objetivos deben ser tanto más elaboradas como extenso haya sido el trabajo realizado o importantes hayan sido los objetivos. Para ello se puede incluir también el siguiente punto, que no es necesario para las memorias normales, pero que puede ser interesante para trabajos de investigación y desarrollo más elaborados.
En los trabajos de investigación sobre todo debe justificarse la razón por la que se ha emprendido el trabajo y deben justificarse los objetivos del trabajo. Los trabajos realizados en el laboratorio no suelen ser de mucha envergadura por lo que tampoco es necesario que se incluya una parte de motivación en las memorias presentadas.
En el caso de la presente guía la motivación es bastante clara; a partir de la experiencia de varios años de corregir prácticas se llega a las siguientes conclusiones:
· No existe uniformidad a la hora de redactar las memorias.
· El alumno anda muchas veces perdido porque no sabe cómo exponer por escrito el trabajo realizado, a pesar de haber llevado a cabo con éxito la práctica que se pedía.
· Existe la idea equivocada de que cuanto más rollo o páginas contenga la memoria más alta será la puntuación obtenida, cuando en realidad depende únicamente de los contenidos clave del trabajo realizado.
Estos problemas son debidos a que el alumno desconoce cómo se debe realizar un informe sobre un trabajo, por lo que acaba cometiendo los errores típicos comentados anteriormente.
Teniendo una guía el alumno sabe perfectamente qué debe hacer exactamente para obtener una mayor puntuación y aprende cómo se debe presentar un trabajo para que otros ingenieros puedan utilizarlo.
Un trabajo de investigación y desarrollo tiene unos antecedentes que es necesario conocer. A esta parte se le llama también “estado del arte” o mejor, estado de la investigación. El término “estado del arte” parece tener su origen en el término inglés “state of the art” donde art no se refiere a bellas artes sino a una determinada destreza, en nuestro caso destreza científica y técnica.
Los antecedentes son especialmente importantes en un trabajo de investigación, ya que permiten conocer los desarrollos que tienen algo que ver con lo que se está presentando. Sirve por tanto para presentar un mapa con las tecnologías y conocimientos relacionados con el trabajo presentado y permite situar nuestro trabajo en este mapa del conocimiento.
En el caso de las memorias para prácticas este punto no es tan importante, pero también es interesante puesto que es el lugar donde se explica el entorno del trabajo desarrollado, su relación con otras sesiones prácticas, etc.
La segunda parte del informe trata sobre la realización del trabajo en sí. En esta parte se describe lo que se ha hecho, cómo se ha llevado a cabo, por qué se ha hecho así y no de otra manera, qué materiales o herramientas ha sido necesario utilizar, qué metodología de trabajo y validación se ha utilizado, etc.
En todo trabajo es necesario el uso de unos materiales y herramientas. En el caso de la labor del informático estas herramientas suelen ser básicamente el ordenador y las herramientas de programación necesarias (compiladores, herramientas de diseño, etc). En las asignaturas más de hardware pueden ser necesarias herramientas adicionales como osciloscopios, placas de pruebas, cables, circuitos integrados, etc.
Normalmente esta parte suele ser breve siendo suficiente una enumeración del material y herramientas utilizadas. En el caso de utilizar un material poco común se suele realizar una descripción más detallada del mismo.
La metodología consiste en el procedimiento que se ha seguido para realizar el trabajo. Se debe justificar el por qué de ese método y no otro.
Este punto no es necesario que conste de forma explícita como aquí, pero sí que hay que tenerlo presente en la explicación que se haga del trabajo realizado, los pasos, etc. Si el método resulta clave en la consecución de los objetivos entonces resulta recomendable dedicarle al menos un punto.
Se deben describir aquí los pasos que se han realizado para llevar a cabo los objetivos del trabajo.
Estos pasos deben incluir también todos aquellos cálculos previos que ha sido necesario realizar, preparación del material y herramientas, etc.
Muchas veces, si el trabajo no es muy extenso, la parte de metodología se junta con la de descripción del trabajo para formar un sólo punto.
En informes técnicos y comerciales es necesario muchas veces incluir un análisis de los costes en la realización del proyecto. Estos costes se traducen tanto en económicos (coste de los materiales y equipos empleados) como en recursos (personal, subcontratación de servicios, etc).
En esta última parte se deben presentar los resultados obtenidos del trabajo. Si el trabajo consistía en hacer un programa se comentará su funcionamiento, lo que tarda en ejecutarse, lo bien que va, los problemas que tiene, etc.
Sobre todo también hay que presentar los resultados de las simulaciones o ejecuciones que se hayan realizado. Si se ha hecho un programa es normal probar que funciona, en este caso se comentarán las condiciones en las que se ha probado, las entradas que se han utilizado, por qué creemos que funciona bien, etc. Esto mismo es aplicable a la realización de un circuito.
Normalmente el listado del programa o el esquema del circuito se adjuntan en un apéndice al final, salvo que el programa sea realmente breve y se desee comentar aquí mismo. Ver los apéndices al final de esta guía para ver cómo presentar correctamente los listados.
Cuando los resultados contengan variables numéricas o estadísticas es necesario hacer una análisis de los errores de los valores obtenidos. Este análisis debe incluir tanto la exactitud como la precisión de las medidas obtenidas.
En esta parte de resultados debe incluirse un estudio detallado de los resultados obtenidos junto con sus implicaciones. Un resumen de este estudio se debe incluir en la parte final de conclusiones.
En esta parte se exponen las conclusiones finales sobre el trabajo realizado. Para las memorias de prácticas suele ser suficiente con un apartado, pero para trabajos más elaborados, o simplemente para tener un guión de las cosas a comentar, se recomienda seguir los siguientes puntos:
Son las conclusiones propiamente dichas del trabajo realizado. Se comenta si se han conseguido los objetivos, si se recomienda el método utilizado o cualquier otro, si el resultado es fiable o no, si son necesarias nuevas pruebas; es decir, se hace un resumen breve de los principales puntos del trabajo realizado y los resultados obtenidos.
También en este apartado se debe incluir un resumen de las conclusiones a las que se ha llegado después del estudio de los resultados obtenidos, teniendo en cuenta su posible error y la fiabilidad de los datos obtenidos.
En este apartado se deben destacar aquellos aspectos novedosos que aporta la realización del trabajo. Resulta interesante evaluar el impacto que puede tener cada una de las aportaciones realizadas.
En las aportaciones resulta interesante también comentar la relación de los resultados obtenidos con los trabajos previos que existan sobre el tema.
En el caso de las memorias de prácticas las aportaciones del trabajo serán personales: la principal aportación del trabajo es que el alumno haya aprendido de la práctica realizada. No obstante resulta interesante que el alumno comente las aportaciones que la realización de la práctica le han supuesto para el progreso de su conocimiento en la materia. Puede ser que un trabajo no aporte nada y eso sería una muy buena conclusión del trabajo realizado (conclusión que por supuesto se debe justificar y razonar).
En los trabajos de investigación extensos con objetivos ambiciosos conviene enumerar aquellos puntos del trabajo sobre los que se debe hacer énfasis. También se deben destacar aquellas líneas que el trabajo abre y que pueden dar resultados interesantes.
En las memorias no es necesario indicar un trabajo futuro puesto que el estudiante no se dedicará a hacer prácticas toda su vida, sin embargo, es interesante que el alumno proponga posibles mejoras al trabajo realizado en clase, o sugiera ideas sobre posibles prácticas que pudieran continuar el trabajo empezado en esa sesión.
En los apéndices se recoge información técnica subsidiaria al trabajo realizado y que no tiene cabida directa en el esquema presentado hasta ahora. Es el lugar ideal para los listados de programas, esquemas de circuitos, demostración de teoremas, etc.
En el caso particular de esta guía se ha optado por poner en los apéndices las líneas generales sobre determinados temas particulares que se presentan a la hora de hacer las memorias, demostrando de esta manera que los temas importantes también tienen cabida en la parte de apéndices.
Lo más importante de un trabajo es sin duda el trabajo en sí y sus resultados, sin embargo, un buen trabajo mal presentado arrojará dudas sobre lo allí expuesto y sobre la persona que ha realizado el trabajo y la memoria. Por lo tanto resulta conveniente cuidar la presentación del mismo:
· Hay que evitar en lo posible las faltas de ortografía y de mecanografía. Con los procesadores modernos de texto es cada vez más difícil cometer este tipo de faltas. Hay que aprender a usar y utilizar las herramientas de corrección ortográfica. Las herramientas de revisión sintáctica son también aconsejables, aunque todavía están en proceso de mejora. Un trabajo presentado con faltas de ortografía, aunque sea bueno, dará una impresión lamentable. Al final de los apéndices se dan unas reglas mecanográficas básicas.
· Los trabajos profesionales se deben presentar mecanografiados siempre.
· Es mejor utilizar un tipo de letra estándar y un tamaño también estándar. El tamaño de letra debe estar entre 10 y 12 pt., y la fuente puede ser Times, Arial o similar. Por lo general la letra Times de 12 pt. suele ser la más utilizada. Nunca hay que usar tipos raros o poco legibles y nunca tamaños inferiores a 10 pt. (10 pt. ya es realmente pequeño) ni superiores a 12 pt.
· Los listados de los programas se hacen con una fuente que tenga espaciado fijo (Courier por ejemplo). Estas fuentes suelen ser más grandes que las normales por lo que puede ser interesante cambiar también el tamaño de letra y dejarlo entre 8 y 10 pt.
· El interlineado debe ser simple y nunca menor de una línea. En algunos casos se puede agrandar algo pero sin sobrepasar la mitad del interlineado simple (1.5 líneas).
· En trabajos extensos resulta interesante incluir un índice con los capítulos, secciones y subsecciones que contenga, así como la página en la que se encuentra.
· Una buena presentación no significa que haya que utilizar todos los tipos de letra posibles, ni todos los tamaños, ni todos los colores; la utilización de estos recursos (color, enfatizado, tamaño, etc.) sólo es interesante siempre que quede justificado, siendo la regla general no alterar el texto estándar a no ser que se esté seguro de querer hacerlo.
· La inclusión de esquemas y figuras ayudan a la claridad y mejoran la presentación de un trabajo.
· Es aconsejable utilizar hojas blancas A4 (210 x 297 mm) por ser un formato estándar y el más utilizado en Europa. Se pueden incluir otro tipo de hojas (milimetradas, cuadriculadas,...) siempre que exista una buena razón para ello (gráficos, esquemas, etc.) y siempre que el tamaño no sobresalga del resto.
· La memoria se debe encuadernar de forma que su consulta sea lo más cómoda posible.
Los consejos anteriores son válidos para la realización de un informe en general. Para las memorias de las prácticas del laboratorio es aconsejable su aplicación, si bien se pueden relajar algunas restricciones y acentuar otras dado el tipo de trabajo que es:
· La presentación sigue siendo muy importante, pero en este caso son más importantes los contenidos. Por tanto no hay que perder el tiempo en hacer rótulos bonitos a todo color ni buscar dibujos de ordenadores por la red para incluirlos en la portada. Una portada sencilla y clara es lo ideal y lo que menos trabajo cuesta.
· Incluir una portada en la que aparezca el número de la práctica, el título de la misma (si tiene), nombre del profesor, el grupo y el curso y, lo más importante, vuestros nombres. Otros datos como la fecha y la titulación son igualmente aconsejables.
· No dejar hojas completas en blanco como separación, no sirven para nada y son un gasto inútil.
· A poder ser se presentarán las hojas escritas tanto por delante como por detrás. La portada es la única hoja cuyo reverso puede quedar en blanco.
· No hay que abrir una nueva página por el hecho de comenzar una nueva sección, salvo para evitar que un título quede suelto. Sólo en memorias muy extensas se puede hacer un salto de página para empezar una nueva sección.
· La memoria se encuaderna colocando una simple grapa en la parte superior izquierda. Si la memoria es tan grande que la grapa no la atraviesa entonces esto significa que hemos escrito demasiado y hay que sintetizar algo más, imprimir a doble cara, o compactar algo más el texto. Si aun así no se puede grapar entonces colocar un simple clip. No utilizar ningún otro método de encuadernación que no sea la grapa (sólo una) o el clip.
· La extensión de la memoria debe ser tal que incluya todo el trabajo realizado en la sesión práctica, con las conclusiones, etc., pero sin extenderse en detalles superfluos. Por ejemplo, con el tipo de trabajos que se realizan en los laboratorios es bastante raro pasar de las 16 páginas (siguiendo las reglas descritas en esta guía). Naturalmente esto depende de la sesión en particular, de que el trabajo corresponda a una o más sesiones y de que la memoria la presenten una o dos personas.
En informática es bastante común la realización de memorias sobre la creación de algún programa, da igual el lenguaje, que haga alguna cosa. En estos casos las directrices dadas en los puntos anteriores son de obligada aplicación, aunque resulta conveniente resaltar los siguientes aspectos:
· El listado del programa debe estar comentado siempre. Si un programa no tiene comentarios casi es mejor no incluirlo.
· Un listado del programa, por muy bien comentado que esté, no es por sí solo la memoria de la práctica, de hecho debería ser una de las partes menos importantes.
· Si se incluye el listado completo del programa se pondrá en los apéndices al final de la memoria. Sólo en el caso de que el programa sea muy pequeño (apenas una rutina) se puede poner en la parte de desarrollo o resultados.
· Si el listado es muy grande (más de 3 ó 4 páginas) es mejor no incluirlo o ponerlo aparte en un disquete. También se puede intentar reducir el tamaño de letra, los espaciados, etc.
· En la parte de desarrollo o resultados se describe el funcionamiento del programa, por qué se ha hecho así, se explicará si funciona bien o no, bajo qué casos, etc. En estos apartados se pueden incluir trozos del listado del programa, pero sólo aquellas partes significativas para la explicación. Si el trozo que se incluye ocupa una página o más entonces no es aconsejable ponerlo.
· Los listados, tanto si son fragmentos como si es el listado global, se deben hacer con un tipo de letra de tamaño fijo (por ejemplo Courier). Por otro lado, el tamaño debe ser lo menor posible para que ocupe poco espacio. Los tamaños 8 y 10 son los aconsejables puesto que además la fuente Courier tiene un aspecto más grande.
Estas reglas son casi tan importantes como las ortográficas y su incumplimiento produce una mala impresión del trabajo que se está realizando. Se listan a continuación algunas de las más importantes o utilizadas:
· Los signos de puntuación como los puntos, comas, dos puntos, etc., van siempre unidos a la palabra que preceda; es decir, nunca hay que poner un espacio delante de cualquiera de estos signos.
· En cuanto a los signos que se abren y cierran como las comillas, los paréntesis, las llaves, etc., el signo que abre debe ir unido a la palabra que sigue, y el signo que cierra debe ir unido a la palabra precedente; es decir, detrás de un signo que abre nunca va un espacio al igual que delante de un símbolo de cierre donde tampoco se pone espacio.
· Los títulos de las secciones o subsecciones no deben ir sueltos. Si no hay espacio en la página para empezar una sección se debe empezar en página nueva.
Se han llamado sugerencias más que reglas puesto que suelen ser de uso común, aunque su incumplimiento no supone necesariamente un menoscabo del trabajo presentado. Son más bien reglas de estilo que se pueden seguir o no aunque la mayoría resultan interesantes:
· Es buena práctica intentar eludir en lo posible los términos anglosajones y utilizar el equivalente en castellano. Si no hay más remedio se puede utilizar el término en inglés poniéndolo en cursiva, dando alguna pista sobre su significado en castellano.
· Los parámetros de las fórmulas matemáticas se escriben habitualmente en cursiva, de manera que cuando se hace referencia a un parámetro en un texto hay que ponerlo en cursiva. Los números y los nombres de funciones se escriben sin cursiva.
· La separación entre los párrafos de un texto es aconsejable, ya que hace que sea más claro. No conviene sin embargo poner un espacio demasiado grande que en ningún caso debe ser mayor que una línea. Si no se espacian los párrafos por lo menos se puede hacer una sangría al principio de cada uno de ellos, siempre con el objetivo de distinguir unos párrafos de otros.
· La letra cursiva se utiliza para resaltar levemente algunas palabras o frases. Por ejemplo resulta interesante para introducir un término nuevo o poco común o utilizado en contextos diferentes.
· La letra negrita sirve para resaltar palabras o frases de forma más brusca que la cursiva. Se utiliza en mensajes de advertencia o en lugares donde sea necesario resaltar mucho un concepto. Conviene no abusar de la letra negrita y de este tipo de recursos en general.
· Subrayado. Con la cursiva y la negrita es suficiente para resaltar cualquier palabra o frase en un texto por lo que el subrayado no es realmente necesario.
· Las líneas huérfanas son líneas simples de texto que pueden quedar sueltas al inicio o al final de una página. No es un error grave pero es fácil de evitar.
· La mayoría de los procesadores de texto actuales tienen mecanismos para automatizar la estructura general de un texto y su estilo. Utilizando estas herramientas conseguiremos evitar la falta de uniformidad en el estilo.
Al final del informe es necesario añadir la bibliografía general con las referencias que se hayan hecho a lo largo del texto. Un trabajo de investigación y desarrollo sin referencias es un trabajo muy poco documentado y demuestra una falta del estudio de los antecedentes y entorno del trabajo, por lo tanto tiene poca credibilidad como tal.
En el caso de las memorias de laboratorio no es imprescindible incluir bibliografía aunque siempre resulta interesante, especialmente si el alumno ha encontrado algún libro o libros de referencia útiles para la realización del informe.