Desarrollo de software. El valor de la documentación

Se documenta muchas veces “por imperativo legal”, es decir, porque nos lo pide el cliente y/o porque nos lo piden nuestros propios procesos.

Hacer la documentación de esa manera, con tan poco cariño, no suele dar buenos resultados ya que se hace para cubrir el expediente y no se cuida que realmente sea útil.

Documentar por documentar no sirve de nada, documentar tiene sentido si aporta un valor.

Como os he comentado en diversas ocasiones vengo de una formación en enfoques clásicos y de trabajar en proyectos con metodologías clásicas en los cuales la documentación es el elemento común en todas las fases del proyecto. De la documentación generada solo suele ser útil una porción de la misma (se sobredocumenta para justificar que se cumplen con los hitos y por otro lado la calidad deja mucho que desear y eso que en los enfoques clásicos la documentación no es un elemento extraño sino que de convivir con ella se considera parte esencial del proyecto) y de ella gran parte de su valor se va perdiendo conforme se evoluciona el producto (si con la misma no se actualiza la documentación).

En enfoques clásicos la documentación como engranaje en las distintas etapas del desarrollo tiene su utilidad, sin embargo otra cosa bien distinta es que realmente sea la base sobre la cual se desarrolla porque incluso en este tipo de enfoques los requisitos y las especificaciones cambian en etapas tardías y estos cambios no se suelen llevar aparejadas actualizaciones en la documentación (suelen quedar recogidos en actas de reunión en el mejor de los casos). A esto hay que sumar lo comentado en el párrafo anterior en donde la orientación a cumplir el proceso suele dar lugar a una documentación cuya calidad no suele ser proporcional al esfuerzo puesto en ella.

Cuando es el propio proceso el que sobredocumenta el proyecto, el desarrollador realizará ese trabajo adicional sin ganas, sin cariño (como decía al principio) e impacta sobre la calidad de la documentación que podría tener utilidad.

La documentación tiene valor cuando encuentra un lector que encuentra utilidad en la misma. Eso es importante. Muchas veces se documenta para un lector futuro que nunca llegará o que cuando llega es tan tarde y la aplicación habrá cambiado tanto (o lo suficiente) que no se amortizará el esfuerzo de haberlo realizado.

La documentación es un instrumento, también se utiliza en las metodologías ágiles, de hecho las historias de usuario, las pilas de producto, etc… son documentación (en las que los procesos y/o los desarrolladores le dan la formalidad que estiman conveniente) por tanto su valor o no va más allá del enfoque del proyecto y está relacionado, como decía antes, con la utilidad real que tenga y su alcance y estrategias de actualización dependerán de las características del sistema que se desarrolla y del contexto del proyecto (y estará muy condicionada por el proceso o procesos de desarrollo si se establecen directrices relacionadas con la documentación).

La comunicación entre las personas es una herramienta muy potente que siempre ha estado ahí y que los procesos se han encargado de dejar en un segundo plano por la visión formalista que se le ha dado tradicionalmente a los mismos. Ese formalismo situó a la documentación como elemento que dinamiza el desarrollo (engranaje lo llame antes) cuando la dinamización debe ser cosa de las personas que intervienen en el proyecto. Si la documentación se convierte en una herramienta más y no en el centro del proyecto es posible (y así es efectivamente) que cada documento se centre exclusivamente en sus objetivos (prescindiendo de contenido de escaso valor para el lector) y que haya documentos (de trámite) que sean innecesarios.

Anuncios

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: