Como hacer los Informes

Los informes resultan fundamentales para comprender lo que hicieron en cada uno de los laboratorios, porque simplemente es lo primero que leemos. El informe tiene que reflejar la estructura de la solución, yendo de lo general a lo específico, mostrando cuales fueron sus decisiones de diseño, problemas, herramientas utilizadas, etc.

No proponemos pautas rígidas para el informe, pero sin duda queremos que con sólo leerlo, tengamos una idea general y también detallada de la solución que se le dio al problema y cuanto ustedes trabajaron.

A manera de guía, se propone la siguente estructura para los informes:

• Introducción
• Modularización: diseño general y particular, diagrama de módulos, descripción general de los módulos, TADs internos a los módulos y los que comunican itermódulo, fucionalidades públicas y privadas, algoritmos destacables.
• TADs: consideraciones de diseño generales y particulares, interface o signatura, implementación interna.
• Técnicas de Programación: funciones de librería utilizadas (destacables), estilo de código, manejo de la memoria dinámica, programación defensiva, algoritmos interesantes.
• Herramientas de Programación: herramientas de desarrollo, compilación, debugging y profiling utilizadas.
• Desarrollo: proceso de desarrollo, problemas.
• Conclusiones

Además se pide:

• Número y nombre del laboratorio.
• Integrantes del grupo, con sus direcciones de email.
• Utilizar algun formato abierto para el informe, como por ejemplo txt, html, tex.
• Un castellano cuidado, tanto en gramática como en ortografía. Programas como aspell pueden ayudar.

Sigan este esquema o no proponemos una serie de preguntas que su documentación debería responder:

• ¿Por qué se eligió esta forma de modularizar?
• ¿Qué decisiones de diseño se tomaron respecto a modularización, TADs, técnicas de programación?
• ¿Refleja el documento todo lo que trabajaron?
• ¿Muestra el infome tanto una visión general, como ciertos aspectos específicos?
• ¿Cómo desarrollaron el programa?
• ¿Qué funcionalidades pedidas faltan?
• ¿Qué funcionalidades agregaron ustedes?
• ¿Qué TADs usan, cual es su interface y cómo estan implementados?
• ¿Qué funcionalidades destacables de bibliotecas externas utilizaron?
• ¿Utilizaron herramientas especiales para el desarrollo, edición, compilación, debugging y profiling?