-
Notifications
You must be signed in to change notification settings - Fork 4
Documento del proyecto
El documento del proyecto debe ser un documento que sintetice los aspectos del proyecto elegido para su desarrollo con respecto a los temas vistos en clases.
Debe tener claramente identificados los nombres y apellidos de cada componente, grupo al que pertenecen (1, 2, o 3 mañana o tarde), curso académico, nombre del proyecto (seguir la política de nombres). Use este modelo de portada para el documento del proyecto y alójelo en su repositorio o en una página del wiki de la asignatura.
Debe ser un documento presentado de manera profesional guardando la forma en los estilos y contenidos y con el máximo nivel de rigor académico y profesional.
Este curso se recomienda que el documento se aloje o bien en el wiki de la asignatura o bien en el repositorio del proyecto usando para ello el lenguaje de markdown que ofrece github. En todo caso, debe ser un documento elaborado en formato [wiki].
Tenga en cuenta los siguientes comentarios generales:
- Siempre diferencie claramente las secciones y subsecciones y para ello use etiquetas de encabezado como las que se disponen en los lenguajes tipo markdown
El documento del proyecto tendrá (al menos) que sintetizar los siguientes apartados:
(debe dejar enlaces a evidencias que permitan de una forma sencilla analizar estos indicadores, con gráficas y/o con enlaces)
| Miembro del equipo | Horas | Commits | LoC | Test | Issues | Work Item |
|---|---|---|---|---|---|---|
| Apellidos, nombre | HH | XX | YY | ZZ | II | Descripción breve |
| Apellidos, nombre | HH | XX | YY | ZZ | II | Descripción breve |
| Apellidos, nombre | HH | XX | YY | ZZ | II | Descripción breve |
| TOTAL | tHH | tXX | tYY | tZZ | tII | Descripción breve |
La tabla contiene la información de cada miembro del proyecto y el total de la siguiente forma:
- Horas: número de horas empleadas en el proyecto
- Commits: solo contar los commits hechos por miembros del equipo, no lo commits previos
- LoC (líneas de código): solo contar las líneas producidas por el equipo y no las que ya existían o las que se producen al incluir código de terceros
- Test: solo contar los test realizados por el equipo nuevos
- Issues: solo contar las issues gestionadas dentro del proyecto y que hayan sido gestionadas por el equipo
- Work Item: principal WI del que se ha hecho cargo el miembro del proyecto
Equipos con los que se ha integrado y los motivos por lo que lo ha hecho y lugar en el que se ha dado la integración:
- Nombre-del-equipo: breve descripción de la integración
- Nombre-del-equipo: breve descripción de la integración
- Nombre-del-equipo: breve descripción de la integración
Se sintetizará de un vistazo lo hecho en el trabajo y los datos fundamentales. Se usarán palabras para resumir el proyecto presentado. Contendrá, al menos la siguiente información:
Se explicará el sistema desarrollado desde un punto de vista funcional y arquitectónico. Se hará una descripción tanto funcional como técnica de sus componentes y su relación con el resto de subsistemas. Habrá una sección que enumere explícitamente cuáles son los cambios que se han desarrollado para el proyecto.
Debe dar una visión general del proceso que ha seguido enlazándolo con las herramientas que ha utilizado. Ponga un ejemplo de un cambio que se proponga al sistema y cómo abordaría todo el ciclo hasta tener ese cambio en producción. Los detalles de cómo hacer el cambio vendrán en el apartado correspondiente.
Debe explicar cuál es el entorno de desarrollo que ha usado, cuáles son las versiones usadas y qué pasos hay que seguir para instalar tanto su sistema como los subsistemas relacionados para hacer funcionar el sistema al completo. Si se han usado distintos entornos de desarrollo por parte de distintos miembros del grupo, también debe referenciarlo aquí.
Se presentará un ejercicio con una propuesta concreta de cambio en la que a partir de un cambio que se requiera, se expliquen paso por paso (incluyendo comandos y uso de herramientas) lo que hay que hacer para realizar dicho cambio. Debe ser un ejercicio ilustrativo de todo el proceso de evolución y gestión de la configuración del proyecto.
Se enunciarán algunas conclusiones y se presentará un apartado sobre las mejoras que se proponen para el futuro (curso siguiente) y que no han sido desarrolladas en el sistema que se entrega