Guía Corta – Cómo Construir un Informe

Muchas veces tenemos que realizar distintos trabajos para distinto grupo de clientes (ojota, que el cliente no es solamente quien paga nuestro trabajo, sino también puede ser la Universidad, una Cátedra, el Colegio, etc). Siempre se realiza documentación, pero como buenos informáticos nuestros textos son duros, difíciles de seguir y muchas veces metido a golpes entre el código del mismo proyecto.

Una buena práctica que tengo hace años es adjuntar en las primeras etapas un informe corto con estos lineamientos.

 

 

El básico consta de tres secciones o capítulos:
A- RESUMEN EJECUTIVO
Se trata de la síntesis de un proyecto que se presenta en las primeras páginas de un plan. Debe describir en pocas palabras:
  1. Resultados Esperados
  2. Beneficiarios
  3. Responsable del Proyecto (si los hubiere)
  4. Necesidades de Financiamiento (si las hubiera)
  5. Conclusiones Generales
En el Resumen Ejecutivo se hace un breve análisis de los aspectos más importantes de un proyecto, que se ubica delante de la presentación. Es lo primero que lee el receptor del proyecto, y quizás, por falta de tiempo, lo único; así que es muy importante que sea claro y preciso.
Si bien éste se ubica al comienzo del proyecto, es conveniente realizarlo al final, después de haber analizado todos los puntos. Su extensión es clave: no más de dos páginas.
El objetivo de este resumen es captar la atención del lector y facilitar la comprensión de la información que todo el plan contiene, por lo que se debe prestar especial atención a su redacción y presentación.
B- DESARROLLO DEL PROYECTO
En este capitulo se describe en detalle el proyecto realizado según el siguiente índice.
  1. Nombre del Proyecto
  2. Introducción, marco teórico y motivación
  3. Objetivo y Alcances
  4. Plan de Trabajo
  5. Desarrollo del Proyecto:
    1. Análisis realizado del escenario elegido, describiendo las decisiones que se tomaron para acotar los alcances.
    2. La arquitectura planteada para la resolución del problema, indicando las componentes distribuidas y los módulos que incluyen.
    3. Justificación de las herramientas seleccionadas para el desarrollo
    4. Descripción del uso del/los Web Services
    5. Armado los casos uso
  6. Conclusiones
  7. Bibliografía utilizada

 

C- MATERIAL DE RESPALDO
En este capitulo se contendrá el material de respaldo utilizado para desarrollar el proyecto como por ejemplo, entrevistas, actas de relevamiento, estudios de casos, etc.
Este capitulo es opcional.
D- EXTRA: PRESENTACIÓN ORAL
En el 80% de los casos, la entrega de este informe viene acompañada por alguna presentación el proyecto, que de vez en cuando queda en nuestras manos (si trabajamos en una gran empresa, SIEMPRE queda en nuestras manos, ya que seremos la carne del cañón cuando algo no se entregue en tiempo y forma…)
Se debe tener en cuenta al realizar la presentación oral de proyecto, que contendrá componentes ejecutables en un entorno informático.
Así que además de las filminas deberemos:
  1. Al momento de la presentación se debe tener todo el ambiente configurado y funcionando correctamente (o simularlo, guiño, guiño)
  2. Se deben tener planificado los casos de usos que se van a mostrar, al menos dos, uno que termine en éxito y otro en fracaso.
  3. Se debe poder explicar claramente cuales fueron los pasos realizados para lograr la integración de todas las componentes y cuales fueron las decisiones tomadas al respecto.
  4. Considerar que la base de datos debe contener ejemplos legibles y consistentes con el problema elegido y con buen volumen de datos.

 

 

CONSEJO FINAL:
Una buena práctica es tener un esqueleto de informe que poder reutilizar, no lo digo por la parte visual, sino por la parte práctica. Y siempre que se dan presentaciones, practicarlas antes, no solamente para ver si se entienden, sino poder medir el tiempo que nos va a llevar (un presentación puede durar 5 minutos y ser muy aburrida o 30 y tener a todo el mundo muy enganchado).

Dejá un comentario