La importacia de la documentación en el proceso de desarrollo

Imaginamos una nueva clase de martillo, este trae botones, palancas, y casi es independiente de ti. Ese CASI es la diferencia entre lo convencional y lo innovador ¿No? Ahora te llega a tu casa, en un hermoso paquete, lo abres y decides que para tu hermano es más útil que para ti, se lo regalas. Vas a su casa y olvidaste el paquete que le contenia, sin embargo el martilloGPT le encanta. Se lo entregas hablas un rato y te retiras. Sabes de que forma lo empezaría a usar? A los golpes. Esto podría evitarse en cualquier sistema nuevo que haya sido desarrollado sobre ideas antiguas con nuevas caracteristicas de una forma simple, DOCUMENTANDO.(Manual para el martillo)

Lo entedí en uno de los primeros proyectos ajenos a mi de los que formé parte, la falta de documentación, de flujo de trabajo, aún con el proyecto mejor pensado, es casi-imposible de llevar a cabo correctamente.

Casi porque podrías hacerlo individualmente y no explicar tu código a nadie mientras funcione.

Pero si trabajas con equipos debes ser consciente de tu mortalidad, tu posible ausencia en un momento clave y la mejor forma de estar presente sin estarlo, es documentando.

Desde funciones simples, a la estructura de tu código, la estructura de tu negocio, de tu flujo de trabajo.

Aplicalo en tus side-projects, en tus personal projects y notarás como no solo evitas olvidarte, si no que estableces el flujo ágil que puedes usar a futuro. Y más que nada tu equipo te lo agredecerá.

También recuerda, tu documentación debe tener también una estructura, un orden, una lógica.