Desarrollo de software. La calidad de la documentación y su efecto en el producto final

Para empezar habría que definir qué se entiende cómo documentación de calidad. Para mi una documentación de calidad es un instrumento que sirve como herramienta para un desarrollo debiendo estar ajustada a las posibilidades y contexto del proyecto.

Por tanto, 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. ¿Formalismos? Puedo entender que una organización quiera una homogeneidad en la documentación de los proyectos pero las normas deben ser lo suficientemente flexibles para que cumpliendo ese objetivo no sobrecarguemos a los desarrollos con exceso de documentación (más documentos de los necesarios), con excesos en cada documento (que cada documento tenga más contenidos de los necesarios) y con exceso de formalismo.

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 y con menor deuda técnica.

Anuncios
2 comentarios
  1. Me interesa el tema, soy, podriamos decir, un seguidor y generador de y para el tema “documentación de sistemas”.
    En mi opinión hay preguntas básicas que para mí, tienen la respuesta que comparto aquí.

    ¿A que llamamos Documentación de Sistemas?
    En principio, a muchas cosas que no son Documentación, por ejemplo, Metodología, Diseño, Testeo, comentarios en fuentes de lenguajes de programación.

    La verdadera Documentación de Sistemas es la información organizada que le permite a un profesional idóneo tomar una decisión sin el buceo habitual por los fuentes, con la pérdida de tiempo y esfuerzo que ello implica.

    ¿Que abarca la Documentación de Sistemas?
    La evidencia concreta de decisiones y compromisos asumidos por los distintos roles existentes en IT y las áreas relacionadas.
    La relación necesaria con herramientas utilizadas por el personal de IT, por ejemplo Administrador de Proyectos, Change Management, Sistema para Testeo, etc.

    Gracias por la oportunidad de expresar mis ideas.

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: