Consideraciones a la hora de escribir un informe técnico o memoria

Durante las prácticas, ya sea en Informática o en Teleco, se requiere la entrega de informes técnicos, o memorias, en los que se exponen los resultados de la práctica realizada. A continuación os dejo una serie (incompleta) de consideraciones a tener en cuenta en la elaboración de la misma.

Presentación

  • Tamaño Papel. DIN A4.
  • Papel reciclado. Dado el volumen de papel que se gasta es altamente recomendable presentar las memorias en papel reciclado. Ahora bien, en otros contexto (Proyectos Fin de Carrera, Informes en la empresa…), esta medida puede dejar de ser válida.
  • Doble cara. Imprimir, a ser posible, las prácticas en impresoras que permitan doble cara. De esta manera seguimos ahorrando papel.
  • Encuadernadas. Todas las hojas formarán un único documento. Al menos las hojas tendrán que ir grapadas. En ningún caso se entregará hojas sueltas o sujetas con un clip.
  • Filiación. El nombre de los autores, curso, grupo y pareja a la que pertenecen tienen que ser visible en la portada del documento.
  • Tipo de letra. Tamaño 12. Times New Roman, con párrafos justificado.
  • Tabla de contenidos. La tabla de contenido (incorretamente llamada índice) permite relacionar los apartados de la memoria con el número de página donde empiezan. Es necesario incluirlo al principio del documento.
  • Títulos en las secciones. Los títulos deben incluir una descripción concisa y clara del contenido del apartado, además de una referencia numérica. Por ejemplo, en vez de Ejercicio 2, queda más claro el título como 2. Diseño e implementación de un decodificador 3:8.
  • Subsecciones. Si la extensión de la sección lo requiere, se deberá estructurar.
  • Figuras
    • Las figuras tienen que ser claras y correctamente escaladas.
    • Deben tener un pie de figura que conste de la referencia de la figura y el título. Ej. 6.1. Implementación de un multiplexor 8:1 mediante puertas lógicas.
  • Encabezado. No es obligatorio. Se pueden incluir el nombre del apartado correspondiente a la página, de manera que sea fácil situarse en el documento.
  • Pie de páginas. Incluir, al menos, numeración de las mismas.
  • Referencias cruzadas. Cuando se quiere hacer referencia a una figura o a otro apartado se debe realizar empleando la referencia de la misma. Ej. véase la Figura 6.1 ó en el apartado 2.3.
  • Presentación de código fuente
    • Indentación. 2, 4 ó 8 espacios. Siempre emplear espacios en lugar de tabulaciones. La mayoría de los editores se pueden configurar para incluir es espacios cuando se pulsa la tecla de tabulación.
    • Tamaño líneas. 80 caracteres m‡áximo por lí’nea.
    • TIpo de letra. fuente monoespaciada (courier o similar).
  • Otros: incluir los núœmero de l’ínea, resaltado (a ser posible).

Redacción

  • Ortografía. El informe debe estar libre de faltas de ortografía. Se recomienda emplear correctores ortográficos automáticos.

Contenido

  • Para cada sección/apartado de la memoría hay que intentar responder implícitamente a las siguientes tres preguntas:
    • Qué. Describir cuál es el problema que se pretende resolver. En el caso de las memorias de laboratorio, este apartado debe ser breve, ya que el enunciado del problema viene dado ya en la propia práctica. En ningún caso se debe realizar cortar y pegar del enunciado.
    • Cómo. Realizar un análisis de la solución propuesta.
    • Porqué. Es importante que la memoria no resulte en una mera descripción de lo que se ha realizado, sino que, también, se tien que justificar todas las decisiones que se han tomado. Las valoraciones pueden ser tanto cuantitativas (Ej. Tiempo de ejecución, memoria ocupada, puertas lógicas empleadas…) como cualitativas (Ej. Claridad del código, sencillez del algoritmo, utilización de estándares…).