La documentación en el desarrollo de software

A menudo nos encontramos con los siguientes problemas:

• Falta de documentación.
• Exceso de documentación.
• La persona que ha escrito la documentación no está disponible.
• Contenido erróneo de documentación.
• Documentación desactualizada.
• La documentación no sigue el formato establecido según las normas de calidad.
• No contiene control de cambios.
• La documentación se contradice.
• No hay una norma establecida para la gestión de la documentación.
• La documentación no tiene las referencias ni fuentes que corresponden.
• Cada equipo de trabajo gestiona de forma diferente la documentación.
• La documentación fue elaborada con un software que ya no tenemos.

Debemos realizar una documentación de calidad. Debe ser un instrumento que sirva como herramienta para un desarrollo debiendo estar ajustada a las posibilidades y contexto del proyecto.

La documentación debe ser la precisa, ni más ni menos y por ese motivo debe ser el proyecto el que determine la que resulta necesaria.

Debemos distinguir entre varios tipos de documentación a la hora de elegir el tipo y la profundidad de la documentación:

• La documentación que se utiliza a lo largo del desarrollo del proyecto pero que no forma parte de la versión definitiva del producto software.
• La documentación que se utiliza como contrato con el cliente de lo que se va a realizar en el proyecto.
• La documentación que forma parte de los entregables del proyecto.

Respecto del formalismo en la documentación, aunque se puede ser flexible es importante que se siga homogeneidad. Se puede partir de un conjunto de plantillas estándar y negociarlas con el cliente con el fin de que se encuentre cómodo con lo que recibirá.

Una documentación de alta calidad no es el resultado de los formalismos que se establezcan sobre la misma sino por la adecuación de sus contenidos a los propósitos del proyecto. Tener una documentación de un proyecto perfecta a nivel formal no asegura que el producto final satisfaga las expectativas que se tenían puestas en él, lo único que asegura es la inversión de un esfuerzo que se podría haber utilizado para entregar un producto más depurado.

Publicado con Blogsy