Documentación de Proyecto

Valor 5.0 pts del examen practico

1. Documento de requisitos: Este documento debe detallar los requisitos funcionales y no

funcionales del proyecto, incluyendo las características principales, las funcionalidades esperadas,
los casos de uso y cualquier restricción o limitación relevante.

2. Diagramas de clases: Los diagramas de clases UML deben representar la estructura del proyecto,
incluyendo todas las clases, interfaces, relaciones y atributos. Estos diagramas ayudan a evaluar el
diseño y la arquitectura del proyecto.

3. Documentación de diseño: Esta documentación debe incluir una descripción detallada de las
clases, interfaces y relaciones implementadas en el proyecto. Debe explicar la lógica detrás de las
decisiones de diseño y cómo se han aplicado los principios de la Programación Orientada a Objetos.

4. Documentación de APIs y bibliotecas utilizadas: Si se han utilizado APIs externas o bibliotecas de

terceros, se debe proporcionar documentación que explique cómo se han utilizado, incluyendo
ejemplos de código y descripciones de las funcionalidades relevantes.

5. Documentación de pruebas: Debe proporcionarse una descripción detallada de las pruebas

realizadas, incluyendo casos de prueba, resultados obtenidos y cualquier problema o error
encontrado durante las pruebas. Esta documentación debe mostrar un enfoque riguroso y
exhaustivo en la validación del proyecto.

6. Documentación de despliegue en GlassFish: Si se ha utilizado GlassFish como servidor de

aplicaciones, se debe proporcionar una guía detallada sobre cómo configurar y desplegar el proyecto
en el servidor. Esto puede incluir instrucciones paso a paso, archivos de configuración relevantes y
cualquier consideración especial para el entorno de ejecución.

7. Documentación del código: Es importante que el código esté debidamente documentado. Se debe
proporcionar una documentación interna dentro del código que explique la funcionalidad de las
clases y métodos, así como cualquier información relevante para los desarrolladores que trabajen
con el proyecto en el futuro.

Recuerda que la documentación debe ser clara, concisa y fácilmente comprensible. También es
recomendable que se incluyan ejemplos y capturas de pantalla cuando sea necesario para facilitar
la comprensión y evaluación del proyecto.