domingo, 14 de marzo de 2010

¡Cuidado con los informes Frankenstein!


    - Buff, tenemos que redactar el informe…
    - Venga, no hay problema, María hace las secciones 1 y 2, Juan las secciones 3 y 4, y yo la 5 y la 6. Lo juntamos tal cual y listo; ya tenemos el informe… ¿vale?

Os suena esa situación, ¿verdad? ¡Pues no! ¡Eso no es un informe! ... 

... ¡ES UN FRANKENSTEIN!

En la empresa y, también mientras se cursa la carrera, es muy frecuente tener que redactar informes en colaboración con otras personas. Cada persona tiene su forma de pensar y de escribir, de modo que si no andamos con cuidado podemos terminar con un informe totalmente heterogéneo, donde cualquier relación de una sección con la siguiente es pura coincidencia, esto es, un informe Frankenstein.

¿Cuáles son las características típicas de un informe Frankenstein?
  • Falta de conexiones entre las partes. De las características de los informes Frankenstein, esta es quizás la que más daño hace a un informe. Un informe, en general, debe contar una historia, o al menos debe existir una historia conductora que guíe al lector a través de dicho informe. Por lo tanto, sus secciones deben de estar ligadas. Si no, queda una historia inconexa. De repente entras en una sección y no sabes qué pinta ahí ni cómo se relaciona con las demás.
  • Cambios de notación y nomenclatura. Hay que ser coherentes a lo largo del documento y evitar que en una sección se hable de WiFi, en otra de Wi-Fi y en otra de WIFI. Esto también es importante al emplear ecuaciones. Por ejemplo, si un autor utiliza la letra d para denotar la distancia y f para denotar la fuerza, y otro autor usa en el mismo documento pero más adelante la letra l para denotar la distancia y f para denotar la frecuencia, el lector se acabará haciendo un lío.
  • Falta de homogeneidad en el formato del texto. Imaginad que la primera sección del informe resalta con negrita las ideas importantes, la segunda lo hace con cursiva, y la tercera no resalta nada y reserva la cursiva para palabras en otro idioma. ¿Quiere decir eso que en la tercera sección no hay realmente nada importante? Hay que intentar no confundir al lector. Por otro lado, desde un punto de vista estético no queda nada bien que cada título de sección, por ejemplo, tenga un formato distinto. De nuevo, además, puede confundir al lector.
  • Falta de homogeneidad en el estilo de escritura. Puesto que cada autor tiene su estilo de escritura, podemos tener una sección escrita con un lenguaje muy formal mientras que la siguiente emplea un lenguaje informal, o una sección en la que se utilizan en exceso las listas (como la que ahora estás leyendo) mientras que las demás no utilizan en absoluto este recurso.
  • Ausencias y duplicaciones de material. Dos personas piensan que un cierto aspecto encaja mejor en la otra parte del documento y al final... la una por la otra, la casa sin barrer; es decir, dicho aspecto no se incluye, aun siendo de gran importancia. O a la inversa: dos personas duplican la información sin saberlo en dos partes del documento (¡y a veces incluso dando información contradictoria!).
Quizás esas son las características más comunes de un informe Frankenstein, pero si el informe es en otro idioma, por ejemplo, en inglés, hay que tener en cuenta algo más. En general, los distintos autores del informe tendrán distintos niveles de inglés, ¡y eso se nota!

Es importante no cometer los errores anteriores. Puedes haber hecho un trabajo previo maravilloso, pero reflejarlo en un informe Frankenstein puede arruinar ese trabajo. Ten en cuenta que un mal informe puede suponer no conseguir una mejor nota, o no conseguir una renovación de un contrato para tu empresa con un cliente, o no conseguir una subvención de millones de euros, ¡y un buen informe puede conseguir lo contrario!

Tienes que entrenarte para escribir buenos informes y en la carrera vas a hacerlo. Además, debes ser capaz de escribir informes en colaboración con otras personas. A modo de ejemplo, tanto Pablo como Óscar (las dos últimas entradas de la serie Telecos en el Mundo) han tenido que hacer muchos informes en TID, y en el caso de Óscar, al trabajar en muchos proyectos de investigación europeos, ha tenido que escribirlos en inglés y colaborando con mucha gente de distintos países.

¿Cómo evitar hacer informes Frankenstein?

El objetivo es conseguir que un informe escrito por varias personas parezca que ha sido escrito por una sola, es decir, que tenga una apariencia lo más homogénea posible, tanto en la forma como en el fondo. Para ello es fundamental coordinar el trabajo de elaboración del informe desde el primer momento hasta el último. Aquí os doy algunas ideas que os pueden ser útiles.

Antes de empezar, conviene realizar las siguientes acciones:
  • Si el informe va a tener más de dos autores es conveniente que uno de ellos se encargue de realizar tareas de coordinación y edición. Por lo tanto, hay que designar quién va a encargarse de dicha tarea.
  • Determinar qué herramienta se va a utilizar para elaborar el documento (Word, Google Docs, Zoho, …). Haré algún comentario sobre este aspecto un poco más adelante.
  • Definir la plantilla del documento desde el primer momento. Así, se asegura que todos los autores emplean el mismo formato para los títulos, los pies de figura, la bibliografía, etc.
  • Definir el enfoque que se va a dar. Dependiendo de a quién vaya dirigido el informe así se requiere un estilo más o menos formal.
  • Determinar cómo se va a organizar el documento y quién se va a encargar de cada parte.
  • Establecer una fecha límite para tener una primera versión de cada sección para integrarlas y homogeneizar (¡y con un margen suficiente para poder pulir y mejorar el documento!). El coordinador deberá asegurarse de que se respeta esa fecha límite.
Durante el proceso de escritura:
  • Si el informe está realizado por sólo dos autores quizás lo mejor es pasarse el documento múltiples veces, leyendo lo del otro y editando su parte. En el caso de utilizar Microsoft Word, es útil activar la herramienta de control de cambios para saber qué modificaciones se han hecho. Aunque sus características son más limitadas, otra opción muy interesante, en lugar de intercambiarse las distintas versiones por correo electrónico, es utilizar aplicaciones web como Google Docs o Zoho para trabajar sobre un documento único.
  • En el caso de que haya más de dos autores, el coordinador debe asegurarse de que los distintos autores completen a tiempo su parte. Una vez recibidas éstas, deberá:
    • Revisar el documento completo y darle coherencia, por ejemplo introduciendo nexos de unión (referencias cruzadas entre distintas secciones), creando la historia conductora en caso de ser necesario, asegurándose de que están contemplados todos los puntos y no hay duplicidades.
    • Dar realimentación a los autores por si tienen que reescribir algo.
    • Generar una versión final con margen de tiempo suficiente para que sea revisada por todos los autores y den el visto bueno (o propongan los cambios oportunos).
    Al igual que en el caso anterior, puede ser útil emplear la herramienta de control de cambios de Word, o alguna aplicación web para trabajar conjuntamente sobre una sola versión del documento.
Así pues, recordad:  

Cuando escribáis un informe, ¡no hagáis un Frankenstein!

4 comentarios:

Maxwell dijo...

Muy interesante la entrada de ayer. Coincido en que la redacción de un informe debe ser una competencia básica de cualquier ingeniero.

Por eso me parecería una buena idea que se incluyese una asignatura de libre elección sobre redacción de informes. En ella se podrían ver las plantillas empleadas en algunos organismos (e.g IEEE).

En otras universidades ya existen asignaturas semejantes (con una buena acogida, por cierto. Además es un gran complemento a la formación.

Ignacio de Miguel (Nacho) dijo...

Muchas gracias Maxwell. Coincido contigo en que una asignatura dedicada a la escritura de informes (y a la adquisición de otras competencias transversales) podría ser interesante, pero tampoco creo que sea estrictamente necesaria. Personalmente creo que escribir buenos informes (y/o artículos) es una competencia que se puede adquirir muy bien dentro de las propias asignaturas de la carrera. De hecho, esa forma de proceder se va a enfatizar aún más con la entrada de los nuevos planes de estudio acordes al Espacio Europeo de Educación Superior.

Por último, ya que mencionabas la plantilla del IEEE en tu comentario, ten en cuenta que ya hay algunas asignaturas de la carrera en las que hay que utilizar la plantilla del IEEE (o similar) para escribir un artículo mostrando los resultados de alguna práctica :)

jfracon dijo...

Si bien es cierto que se deberia adquirir la competencia para escribir buenos informes dentro de la asignaturas, no estaria de mas incluir, al menos de manera optativa, una introduccion al informe tecnico.
No me refiero unicamente a presentar que debe contener un informe y cual debe ser su formato, sino tambien a las diferentes herramientas existentes para crear buenos documentos: uso de LaTEX, uso avanzado de editores de texto, creacion de documentos .ps, etc.
Eso resultaria realmente util una vez acabada la carrera.

P.D: Perdon por la ausencia de tildes en mi comentario pero me encuentro en Francia y el teclado no me permite aacentuar como quisiera.

P.D2: Nacho, el trabajo que has hecho con este blog (el cual acabo de descubrir) me parece increible y de agradacer por los futuros y pasados alumnos de la escuela. Y lo dice un ex-alumno.

Ignacio de Miguel (Nacho) dijo...

Muchas gracias jfracon. El problema, como siempre, es que los recursos son limitados, por lo que no queda más remedio que hacer una selección de las asignaturas que se ofertan. Además, también hay que tener en cuenta cuántos alumnos realmente se matricularían de dicha asignatura... (por ejemplo, LaTeX es muy popular en ciertos entornos, pero en otros no tanto...). En cualquier caso, la Universidad sí oferta al menos una asignatura de libre configuración denominada "LaTeX: Procesamiento de textos científicos en alta calidad". La imparte la Facultad de Ciencias, pero suelen anunciarlo todos los años con carteles en la Escuela de Teleco, de modo que ahí tenéis una oportunidad si estáis interesados en ello. Al menos en el curso 09/10 la asistencia a clase no era obligatoria, pudiendo seguirse el curso a través del material disponible en la web del curso. Por otro lado, en principio, la redacción del Proyecto Fin de Carrera debería servir para adquirir al menos algunas de esas competencias que apuntas.

Muchas gracias por tu comentario sobre el blog, aunque también yo os tengo que agradecer a todos los que habéis colaborado en él (alumnos, ex-alumnos y otros visitantes), ya sea contribuyendo con entradas o con vuestros comentarios.

Publicar un comentario