guia

I Unidad: Calidad del Producto y Proceso Software
Tema Nº 5: Calidad de la documentación técnica en un entorno de desarrollo
Revisión de la calidad en la documentación técnica
Relevancia de lastécnicas y tecnologías para la documentación del software

Objetivos
Que el estudiante comprenda cómo tratar aspectos de calidad en la documentación técnica en un entorno de desarrollo centrado endocumentos,
Introducción
La calidad de la documentación técnica en el desarrollo de software puede medirse en base a varios atributos que van desde la usabilidad a la completitud y actualidad dela información contenida en los mismos. En cualquier caso, el mantenimiento de la documentación de un proyecto es una tarea que consume tiempo y que es difícil de mantener al día.

Otroelemento importante es la adecuación de la documentación generada y mantenida a los procesos reales del ciclo de vida que se llevan a cabo en una organización para un proyecto en particular. Enciertas ocasiones encontramos que el proceso definido exige unos niveles de documentación que no son los apropiados - los documentos resultantes quedan incompletos o no están al día, o elesfuerzo requerido para generar y mantener estos documentos no es aprovechado ya que no se utilizan realmente en el proceso. Este problema viene tratándose desde hace tiempo como uno de los elementosrecurrentes de la crisis del software, sin embargo, las soluciones propuestas han sido parciales: algunas centradas en algunas actividades del proceso, por ejemplo, JavaDoc y otras centradas enlos documentos (gestión documental) sin relación directa con el proceso definido.

Con esta aproximación se cubren dos aspectos importantes en la calidad de la documentación técnica:los documentos son siempre completos, ya que no existe ni se puede realizar, ninguna tarea que no dé lugar a algún tipo de documentación y, la documentación está siempre actualizada, ya que...