Cómo asegurar la longevidad del software: claves para su desarrollo y documentación

Si tienes la suerte de encontrarte con Werner Vogels, CTO de Amazon, en un tranquilo domingo por la tarde en Ámsterdam, es posible que hagas lo que esta persona hizo y le preguntes: "¿Cómo debemos pensar de manera diferente sobre el desarrollo de software?"

A lo que Vogels respondió: "Tu software necesita ser operado durante décadas más de lo que te toma escribirlo".

Si bien esto significa que el software podría considerarse como legado, eso solo indica que has creado algo que las personas todavía quieren usar años o décadas después. Sin embargo, no siempre es fácil lograr la longevidad que Vogels sugiere que los desarrolladores deberían aspirar a alcanzar.

Las cosas están a punto de volverse aburridas

Ya he escrito antes sobre por qué ser aburrido es algo bueno cuando se trata de elegir tecnología empresarial, como las bases de datos. La primera consideración de una empresa es mantenerse en funcionamiento, mantener las aplicaciones en ejecución, etc. Por lo tanto, es importante elegir soluciones con capacidades bien comprendidas y modos de fallo bien conocidos.

Pero hay otro aspecto de ser "aburrido" en las aplicaciones, y eso implica adoptar un enfoque básico para resolver un problema empresarial en particular. Como señaló el desarrollador Manuel Odendahl, logra "crear consistentemente productos de gran valor" con código que es "muy simple" y sin "matemáticas locas" o inteligencia artificial extravagante. En cambio, su secreto es "hacer muchas preguntas" para comprender qué información necesita el negocio, en contraposición a los datos que realmente procesa.

Al hacer preguntas para determinar exactamente qué información necesita la aplicación para consumir y distribuir de manera que satisfaga una necesidad empresarial, se logra mantener la aplicación simple.

Cómo solucionar el error de apt-key en Linux

"Cuanto más simple sea el camino que la información recorre para llegar de A a B, mejor se vuelve el sistema. Como hicimos las preguntas correctas, el software apunta directamente al blanco, resolviendo los problemas empresariales reales", explica Odendahl.

Este es un principio sumamente valioso y a menudo pasado por alto que es clave para el soporte a largo plazo del software. Esto se vuelve aún más importante porque, como señaló correctamente el ejecutivo de ingeniería de AWS, Matt Wilson, a Vogels: "Rara vez se termina de escribir el software que se ejecuta en un sistema operativo".

Al mantener el código lo más limpio y sencillo posible, los desarrolladores facilitan su mejora en los meses, años o décadas posteriores. Aquí es donde también entra en juego la buena documentación.

Si no lo documentaste, no sucedió

El defensor de los desarrolladores, Mason Egger, enfatizó la importancia de una buena documentación (como se capturó en PyCon 2022) siguiendo el mismo principio básico destacado por Odendahl: mantener las cosas simples. En el caso de la documentación, Egger señaló que los desarrolladores deben articular claramente el objetivo que la documentación ayudará a los lectores a lograr. No es necesario abrumar al lector con verborrea; el desarrollador está en los documentos para lograr algo, así que proporciona todo lo necesario para lograr ese objetivo y no desperdicies su tiempo con información adicional innecesaria.

Según Egger, lo más probable es que un desarrollador salte directamente al código de ejemplo en lugar de leer la explicación, por lo que argumentó a favor del uso de ejemplos del mundo real. También destacó la necesidad de que los documentos sean fácilmente buscables, para que el lector pueda encontrar rápidamente la información que necesita. Además, es importante escribir de la manera más sencilla posible, sin utilizar jerga o palabras innecesariamente complicadas. Siempre se busca la simplicidad y la brevedad.

Con ejemplos de código y texto explicativo, también es importante verificar que no se hayan dejado errores involuntarios en los documentos.

openSUSE Micro: La nueva distribución de Linux optimizada para cargas de trabajo en contenedores

"Lo único peor que no tener documentación es tener documentación incorrecta", advierte Egger. "Porque la falta de documentación significa que busco en otro lugar para encontrar lo que necesito. La documentación incorrecta desperdicia mi tiempo".

Estos (y otros) consejos de documentación ayudan a asegurarse de que alguien que encuentre un código de ejemplo días, semanas o años después pueda comprenderlo más fácilmente, lo que a su vez aumenta la probabilidad de que lo utilice. Por lo tanto, tanto el software en sí como la documentación deben ser lo más directos posible hoy para que sean legibles y utilizables durante muchos años venideros.

En Newsmatic nos especializamos en tecnología de vanguardia, contamos con los artículos mas novedosos sobre Desarrollo, allí encontraras muchos artículos similares a Cómo asegurar la longevidad del software: claves para su desarrollo y documentación , tenemos lo ultimo en tecnología 2023.