En la Industria del Desarrollo de Software existen distintos tipos de tareas a la hora de desarrollar un proyecto, y una de ellas es la construcción de la documentación. Existen diversas medidas para cuantificar la calidad de la documentación de un proyecto software, aunque bien pocas veces se habla de esta importante tarea cuando lo tratamos. Generalmente la calidad suele venir medida (vagamente) en función de parámetros como la comprensión de los textos y la adecuación a lo que el cliente está buscando.
Existe una palabreja que habla de calidad, de una forma un poco más profunda y mesurable. La palabra viene de un acrónimo anglosajón y viene a significar el grado de calidad de la documentación de un proyecto: CRUFT.
Y, ¿Cómo se calcula este grado de calidad? El artículo de Scott Ambler, How crufty is your documentation? nos da la clave:
* C = El porcentaje del documento que actualmente es correcto (Correct).
* R = La probabilidad de que el documento sea leído (Read) por el público objetivo.
* U = El porcentaje del documento que el público objetivo puede entender (Understand).
* F = La probabilidad de que el material contenido en el documento sea continuado (Follow).
* T = La probabilidad de que el documento sea fiable (Trusted).
Tened en cuenta que cuanto más crufty sea la documentación, peor calidad tiene. Es inversamente proporcional:
CRUFTY = 1 - C * R * U * F * T
Hay que buscar entonces el valor más cercano a cero posible.
En este mismo artículo, también nos muestra alguna de las formas en que se puede conseguir que nuestra documentación sea lo menos crufty posible. Una de las más importantes porque consigue tener efectos en varias de las variables, es que la documentación sea desarrollada de forma colaborativa, no sólo entre personal interno de la empresa desarrolladora, sino también junto al personal de la empresa cliente.
Disponer de herramientas de trabajo colaborativo en una compañía es una gran ayuda para las tareas de desarrollo de las habituales tareas que rigen su día a día. ¡¡Incluso a la hora de redactar su propia documentación!!
Siempre es de agradecer la implicación de nuestros clientes en el desarrollo de sus proyectos. Al fin y al cabo del resultado va a depender la mejora en la ejecución de los procesos comunes de la empresa. Y el desarrollo de la documentación no debe ser una tarea aparte. La implicación de todos los interesados (stakeholders) en la documentación del proyecto mejorará el factor CRUFT... y así con el proyecto global.
muy interesante el artículo.
ResponderEliminarAdemás no sabía el significado de la palabra "stakeholder".
como dice el refrán, nunca te acostarás sin saber una cosa más.