Esta crónica es un intento por venderte la idea de que la documentación SÍ sirve; hacerla bien y a la primera, te ayudará en el presente, y por supuesto, en el futuro.
Antes de continuar, ¿cuál es tu postura cuando se trata de participar en las actividades de generar documentación?
Afrontémoslo: en el círculo de la informática, encontrar una persona que disfrute de hacer documentación es escasa, y en la mayoría de los casos, probablemente es producto de nuestra imaginación.
Para iniciar, veamos los argumentos frecuentes que he proferido o escuchado de mis pares para evadir el trabajo de generarla.
Nadie la lee
El argumento más fácil de memorizar y repetir. Una buena parte de la gente argumenta que generar documentación es una pérdida de tiempo, ya que se invierten horas de las personas asignadas en un proyecto a plasmar en un documento diseños y diagramas que nadie o prácticamente nadie utilizará. Esto es cierto, esta información será ignorada en general a lo largo del proyecto, o a corto plazo, una vez finalizado, porque en general, el equipo involucrado mantiene en la memoria qué hace cada parte del sistema, quién interviene, los flujos y demás. Durante la construcción del software y hacia su finalización, estos documentos servirán a lo más como guía, para saber que se está creando con base en lo solicitado/diseñado, y para verificar que el producto entregado cumple con los requisitos dados.
Para cobrar
La segunda frase clásica, sencilla e imposible de desmentir. En muchos de los proyectos, es un requisito de entrega y prueba de completitud del trabajo, proporcionar documentación del producto, que incluye sin ser excluyentes: diseño de alto o bajo nivel, componentes, diagramas de flujo, compendio de requerimientos, manual de instalación, manual técnico, manual de usuario, etc. De tal suerte que se antoja como un capricho más que una necesidad tanto del cliente, como del proveedor.
Si el código está bien escrito, no se necesita documentación
En opinión de quien prefiere generar el código por encima de escribir documentación, cuando el código fuente está bien estructurado y sigue las prácticas aceptadas de la industria, no es necesario documentarlo, ya que al consultaro queda claro lo que está ocurriendo. Nada qué discutir con este viejo, popular y poderoso proverbio de los profesionales de la programación.
Soy más productivo programando que documentando
Es claro que una persona pueda tener esa opinión de sí, considerando que su desempeño es superior al escribir código que al escribir documentación o generar diagramas. Si debemos sopesar entre tener documentos o tener un producto, la alternativa de la programación se antoja obvia.
Es que yo redacto muy mal
Si esta frase es corroborada por el interlocutor al examinar qué y cómo escribe quien la emite, probablemente no tiene caso destinar tiempo de este recurso a la documentación; terminará siendo trabajo doble: esperar a que la persona genere los documentos y posteriormente, revisar y ajustar la redacción y el orden del mismo, prácticamente reescribiendo todo en los casos más extremos. Tiempo y esfuerzo perdidos.
Las metodologías ágiles favorecen la entrega de valor, no la entrega de documentos
Si las demás razones podrían contra-argumentarse, esta se aprecia como un motivo de peso para no continuar discutiendo la necesidad de documentos. Claramente, lo importante es entregar software que funciona, que hace lo que el usuario desea y le entrega valor a su negocio. Si apoyas este punto en una buena programación y un diseño natural que incluso permita al usuario no requerir manuales para aprender a usar el software, asignar recursos a documentación escrita ya parece necedad administrativa. A no ser que se trate de una editorial, un periódico o un negocio cuya principal actividad sea precisamente la publicación de material escrito, dudosamente un documento tendrá la capacidad de generar el valor que el software funcional proporciona al negocio al que soporta.
Teniendo todas estas frases y razones sustentadas en la práctica, ¿cómo se le puede encontar el lado bueno al engorroso encargo de generar documentación?
En mi humilde e insolicitada opinión, la respuesta a esta pregunta se encuentra en el extremo opuesto del origen de estas frases y razones, es decir, cuando te encuentras en la necesidad de consultar dicha documentación.
En la parte 2 de esta crónica abordaré una a una estas frases para exponer la contraparte, encontrando el porqué vale la pena el esfuerzo, guste o no guste.
Deja un comentario