documentacion y artefactos

Es una de las actividades de importancia aparentemente secundaria dentro del oficio de desarrollo de software. Los equipos de desarrollo se concentran principalmente en las tareas de directo impacto al sistema final, tales como el diseño de bases de datos o construcción. Sin embargo, los proyectos de software inevitablemente llegan al punto en el cual se debe documentar lo construido.

Gracias a la documentación de sistema, los analistas y diseñadores pueden transmitir sus ideas a los programadores; el equipo puede comunicar su entendimiento a los clientes; el soporte técnico puede encontrar y corregir los errores; los ingenieros recién llegados pueden familiarizarse con su ámbito de trabajo. Por otro lado, los usuarios pueden aprender a usar el sistema y también aclarar sus dudas puntuales. Finalmente, los clientes potenciales o interesados en adquisición, pueden informarse sobre los beneficios y los propósitos del sistema, sin que esto demande una revisión engorrosa de lo realizado.

La documentación de software muchas veces se convierte en el “cuello de botella” de los proyectos, siendo una tarea engorrosa que desgasta los esfuerzos de los mejores recursos. Aparte de esto, si no se realiza de forma bien planificada y coordinada, la documentación tiende a perder su relación con el sistema, termina desactualizada y errónea. Con la gestión de documentación ligeramente mejorada, esta importante preocupación se puede transformar en una tarea creativa, eficaz e interesante, que a su vez genere un producto propio (manuales, ayudas, presentaciones), siempre sincronizado con el sistema y agradable para sus consumidores.

Artefactos

Son el resultado de trabajo parcial o final que es producido y usado durante un proyecto. Los artefactos son usados para capturar y llevar la información del proyecto.

Un artefacto puede ser:

Un documento: como un Caso de Negocio o un documento de la arquitectura del Software.
Un modelo: como un modelo de caso de uso.
Un elemento de un modelo: como una sola clase de todo el Diagrama de Clases.

Los modelos y elementos de modelos, tienen reportes asociados a ellos. Un reporte saca información acerca de los modelos y sus elementos mediante una herramienta. Un reporte presenta un artefacto o un conjunto de artefactos. La mayoría de los artefactos tienen directrices, las cuales describen los artefactos con más detalle.

Para hacer el desarrollo de un sistema de Software manejable completo, los artefactos están organizados en conjuntos correspondientes a las disciplinas. Muchos artefactos son usados en varias disciplinas; por ejemplo, la Lista de Riesgos, el Documento de Arquitectura del Software y el Plan de iteración. Este tipo de artefactos pertenecen al conjunto de artefactos donde ellos fueron originalmente creados.