DAW06.- Documentación y control de versiones.

Orientaciones para el alumnado

En esta unidad en primer lugar se pretende demostrar la necesidad de la existencia de una documentación actualizada, de las aplicaciones de software, tanto para el futuro mantenimiento de la aplicación como para facilitar la legibilidad del código a todas y cada una de las personas que forman el grupo de desarrollo de la aplicación. Se muestra el funcionamiento de dos herramientas que permiten la documentación automática del código (PhpDocumentor y Javadoc). Por otra parte se destaca el importante papel realizado por los sistemas de control de versiones, que se encarga de controlar los diversos cambios que se realizan sobre los elementos de algún producto o una configuración del mismo. Los sistemas de control de versiones facilitan la administración de las distintas versiones de cada producto desarrollado, así como las posibles especializaciones realizadas. Utilización de la herramienta GIT como sistema de control de versiones.
Datos generales de la Unidad de Trabajo
Nombre completo del MP Desarrollo de aplicaciones web. Siglas MP DAW
y título de la UT 06.- Documentación y control de versiones.
Índice o tabla de contenidos
  1. Documentación de aplicaciones web.
  2. PHPDocumentor.
    1. Funcionamiento de PHPDocumentor.
    2. Instalación de PHPDocumentor.
    3. Configuración de PHPDocumentor.
  3. JavaDoc.
    1. Instalación JavaDoc.
    2. Documentando con JavaDoc.
    3. Creación y uso de plantillas de código.
  4. Sistemas de control de versiones.
    1. Conceptos básicos de sistemas de control de versiones.
    2. Procedimiento de uso habitual de un sistema de control de versiones.
    3. Sistemas de control de versiones centralizados y distribuidos.
    4. GIT como sistema de control de versiones.
    5. Funcionamiento de GIT.
    6. Instalación de GIT.
    7. Configuración de GIT(I).
      1. Configuración de GIT(II).
    8. Trabajando con GIT(I).
      1. Trabajando con GIT(II).
    9. Seguridad documentación en GIT.
Objetivos

Conseguir realizar la documentación durante el desarrollo de las aplicaciones web. Saber administrar y utilizar una herramienta de generación de código. Comprender el funcionamiento de los sistemas de control de versiones. Administrar un sistema de control de versiones. Integrar un sistema de control de versiones en el proceso de desarrollo de software.

Temporalización
(estimación)
Tiempo necesario para estudiar los contenidos (h) 25
Tiempo necesario para completar la tarea (h) 2
Tiempo necesario para completar el examen (h) 1
de días que se recomienda dedicar a esta unidad 22
La temporalización anterior no deja de ser una estimación media, ya que el tiempo a invertir va a depender mucho de las circunstancias personales de cada cual.
Consejos y recomendaciones

Esta unidad contiene requerimientos teóricos básicos que son imprescindibles para poder desarrollar las actividades prácticas requeridas. Parte del desarrollo práctico que se realiza en esta unidad se ha hecho empleando máquinas virtuales en las cuales se empleaba el sistema operativo Debian o Ubuntu.