GUIA PARA DOCUMENTAR PROGRAMAS

- Portada

- Tabla de contenidos e índice
     
- Introducción
  - Dirección Internet en dónde está la documentación

- Descripción del problema a resolver
  - Planteo (problema ==> solución ==> objetivos ==> plan)
  - Objetivos
  - Requerimientos

- Abstracción
  - Especificación de la clase
  - Operaciones / métodos
  - Eficiencia
  - Especificación del programa
  - Arquitectura del programa

- Implementación
  - Modelo de la clase (dibujo)
  - Invariante de la clase
  - Arquitectura interna del programa
  - Compilador usado
  - ¿Cómo compilar el programa?

- Guía de uso del programa

- Datos de prueba del programa
  - Formato de los datos de prueba
  - Entradas vs Salidas esperadas

- Código fuente
  - Programa
  - Clases
  - Programa de prueba

- Reconocimientos
  - Gracias

- Bibliografía


Adolfo Di Mare
    "Convenciones de Programación para Pascal", Revisión 2.0, 
     Reporte Técnico ECCI-01-88, Proyecto 326-86-053, Escuela de 
     Ciencias de la Computación e Informática, Universidad de 
     Costa Rica, 1988.
         http://www.di-mare.com/adolfo/p/convpas.htm
         http://www.di-mare.com/adolfo/p/convpas.htm#sec04

Ricardo Villalón:
http://profesores.ecci.ucr.ac.cr/Ricardo%20Villalon/ci1201/Guia%20para%20Documentacion%20de%20Tareas.doc

Edgar Casasola:
    http://zafiro.ecci.ucr.ac.cr/ci1201/tarea1/


Java Code Conventionsn (Sun Microsystems, Inc., 1997):
- http://java.sun.com/docs/codeconv/CodeConventions.pdf

Los alumnos ya saben que si no están conformes con la calificación de la tarea 
deben hacer su reclamo por escrito al asistente, quien también por escrito les 
indicará si procede hacer una corrección en la calificación. Los alumnos 
tienen también derecho a que el profesfor revise su reclamo si no están 
conformes con la decisión del asistente; para eso es necesario que la 
respuesta del asistente también quede escrita.

Los asistentes ya saben que no es necesario seguir a ciegas la "Guía para 
Documentar Programas" y saben que en algunos casos no se aplican algunas 
cosas, mientras que en otros la guía se queda corta. De todas formas, les 
recuerdo la importancia de acatar las "Políticas de Corrección de Tareas":

=================================
Políticas de Corrección de Tareas
=================================

* Es muy importante que el programa esté correctamente indentado y que las 
  instrucciones estén debidamante espaciadas.
* Es muy importante que en todo el programa haya buena documentación interna.
* Uso de Doxygen para la especificación de todos los métodos, funciones y 
  campos de clase.
* http://www.di-mare.com/adolfo/p/convpas.htm
* http://java.sun.com/docs/codeconv/CodeConventions.pdf

 +-------------------------------------------------------------------------+
 | 1. La falta de cualquier especificación debe ser castigada fuertemente. |
 | 2. Correcta indentación del código fuente.                              |
 | 3. Correcto espaciado del código fuente.                                |
 | 4. Código fuente escrito de manera que sea legible y claro.             |
 | 5. Uso de indentificadores significativos.                              |
 +-------------------------------------------------------------------------+