CI-1402 Artículo #1


  Universidad de Costa Rica 

  Escuela de Ciencias de la 

  Computación e Informática

Profesor Adolfo Di Mare
CI-1402
I Semestre 1999

$[\/]$

CI-1402 Organización de Lenguajes de Programación

Lista de temas de Artículos

Documentación de programas

Los artículos que aquí se muestran han sido escritos por estudiantes. Salvo en contadas excepciones, no han sido corregidos editorialmente, por lo que pueden contener algunas inexactitudes.

Cada semestre los estudiantes del curso escriben un artículo que involucre la comparación o el análisis de lenguajes de programación:

Artículos escritos por estudiantes el I Semestre 1998:
http://www.ecci.ucr.ac.cr/~ci1402/1998-1/ol-art.htm
Artículos escritos por estudiantes el II Semestre 1998:
http://www.ecci.ucr.ac.cr/~ci1402/1998-2/ol-art.htm

Este semestre el trabajo será un poco diferente, pues lo que se busca es aprovechar la madurez de los estudiantes para que definan con suficiente detalle cómo documentar programas.

A lo largo de la carrera todos los estudiantes toman varios cursos, y en cada uno de ellos es usual que tenga que escribir programas. Sin embargo, la documentación el tipo de documentación que estudiante debe entregar en cada curso debe ser diferente, pues los objetivos de cada curso son muy diferentes.

Por ejemplo, en el curso en que se analizan estructuras de datos, en cada tarea el estudiante debe definir con gran claridad y detalle el "modelo". Sin embargo, en el curos de bases de datos lo que importa es incluir los diseños de pantallas y relaciones, pues los algoritmos usados siempre son muy simples. Los estudiants escribirán el manual de documentación para los siguientes cursos:

CI1101 Programación I
CI1201 Programación II
CI1302 Sistemas Operativos y Arquitectura de Computadores I
CI1303 Estructuras de Datos y Análisis de Algoritmos
CI1306 Organización de Bases de Datos
CI1401 Análisis y Diseño de Sistemas Computacionales
CI1402 Organización de Lenguajes de Programación
CI1403 Sistemas Operativos y Arquitectura de Computadores II
CI1414 Proyecto

Es importante incluir un ejemplo de documentación en el artículo. Por ejemplo, los estudiantes pueden tomar el enunciado de una tarea programada que ya resolvieron en un curso que tomaron antes, juntarlo con la solución que en su momento entregaron, para usarlo como ejemplo de cómo debe escribirse la documentación. Además de aportar una serie de reglas para documentar programas, como las descritas en [DiM88a], en la sección 4, los estudiantes deben incluir un ejemplo de la aplicación de las reglas que definen en su artículo.

Posiblemente cada equipo de estudiantes descubra que la documentación que usaron en el proyecto que desean usar de ejemplo para su artículo debe ser revisada y mejorada. Esto es normal, pues no se puede hacer un buen trabajo de otra forma.

Cada equipo de estudiantes debe entregar su artículo impreso en papel. Además, deben enviar por correo electrónico todos los archivos a los asistentes del curso, empacados en un único archivo ".zip". Todos los artículos debe ser escritos usando el formato HTML, y deben ser entregados antes de terminar el ciclo lectivo. Además, cada artículo debe cumplir con las siguientes reglas:

Extención mínima: 3,000 palabras.
Extención máxima: 6,000 palabras.
Debe indicarse con gran claridad los puntos que debe incluir la documentación del programa, al menos como se explica en la sección 4 del artículo "Convenciones de programación para Pascal [DiM88a].
Debe incluirse el enunciado de la tarea o proyecto que se usa como ejemplo.
Debe incluirse la documentación completa de la tarea o proyecto que se usa como ejemplo.
El formato del artículo debe seguir los lineamientos descritos en el artículo "Tipografía de artículos en Internet [DiM96d].
Todo el contenido del artículo debe quedar en un directorio, sin subdirectorios.
Además del disquete, cada grupo de estudiantes debe entregar el artículo impreso.
Si el artículo contiene programas, estos deben haber sido probados adecuadamete.

[mailto:] Hilda Pineda y Mario Tenorio

Tiempo de entrega: Antes de terminar el ciclo lectivo

Modalidad: En parejas

[DiM88a] Di Mare, Adolfo: Convenciones de Programación para Pascal, Revisión 2, Reporte técnico ECCI0188, ECCIUCR, 1988.
http://www.di-mare.com/adolfo/p/convpas.htm.

[DiM96d] Di Mare, Adolfo: Tipografía de artículos en Internet, Revista Ingeniería, Facultad de Ingeniería, Universidad de Costa Rica, Volumen 6, Número 2, pp [5570], 1996.
http://www.di-mare.com/adolfo/p/typeset0.htm.

$[/\]$

[DiM88a]	Di Mare, Adolfo: Convenciones de Programación para Pascal, Revisión 2, Reporte técnico ECCI0188, ECCIUCR, 1988. `http://www.di-mare.com/adolfo/p/convpas.htm`.
[DiM96d]	Di Mare, Adolfo: Tipografía de artículos en Internet, Revista Ingeniería, Facultad de Ingeniería, Universidad de Costa Rica, Volumen 6, Número 2, pp [5570], 1996. `http://www.di-mare.com/adolfo/p/typeset0.htm`.