Los grandes dilemas de los desarrolladores (2): ¿Cuánta documentación es suficiente?
A la hora de desarrollar el código siempre existe la duda de cuántos datos se deben incluir en él para que después sean interpretados de forma correcta y muchos desarrolladores tienden a incluir documentaciones más extensas de lo realmente necesario.
Imaginen esta situación: un gerente de proyecto extremadamente agresivo que realmente quería incorporar a un director de proyectos de la competencia. Este administrador prometió que el código que resultara de su trabajo estaría perfectamente documentado (explicado y con detalles sobre todos los comandos que ejecuta) antes de detenerse y decir tal que James Bond, "la documentación completa".
La única cosa peor que no tener la documentación que una aplicación necesita para sus procesos es contar con es una estantería llena de carpetas rellenas con una extensa documentación. Nadie tiene un acrónimo de muy poca información, sin embargo, todo el mundo en Facebook sabe lo que significan las iniciales TMI (Too much information).
No hay una respuesta fácil para el programador. Lo ideal sería que el código fuera lo bastante limpio y contara con la auto-documentación suficiente para evitar la necesidad de largos párrafos que explicaran lo que el código está haciendo.
Pese a ello, aún queda esperanza de que las futuras generaciones de depuradores y compiladores sean capaces de llevar a cabo una mayor simplificación y comprensión de nuestro código. Así, las últimas versiones de las máquinas virtuales ya permiten llevar un registro abundante de las cuales cuando se ejecutan rutinas. Y cuando se ponga la mayor parte del énfasis en el funcionamiento de la aplicación y no en su desarrollo inicial, el tipo de metadatos que generará la aplicación podrán ser más útiles que la documentación real incluida en el propio código de inicio.
Sin embargo, pasarán años antes de que podamos beber una CocaCola mientras esperamos que una inteligencia artificial comprenda nuestro código. Por ahora, nos quedamos con el problema de cómo crear suficiente documentación o información para mantener a todos contentos sin reventar el conjunto de características de la herramienta.
Comenta este artículo en nuestros Twitter y Facebook
Cada día, una nueva entrega de este serial. Las próximas entregas las podréis ver aquí.
