La mejor documentacion, un código limpio
Todos los programadores nos hemos quejado, y lo seguiremos haciendo, de la falta de documentación del código fuente que heredamos. Casi con toda seguridad, otro programador, se quejará exactamente de lo mismo si revisa nuestro código, y un tercero del del segundo, y otro y otro ...
Documentación puede haber mucha: del API, del diseño y arquitectura, comentarios en el propio fuente ... pero seamos sinceros, cuesta mucho trabajo programar y hacer la documentación a la vez. Alguien podría decir, "pues programa, y luego dedicas una fase a documentación". Es posible, pero aun pasando por alto la falta de tiempo habitual, la calidad de la documentacion puede bajar debido a que ha pasado cierto tiempo desde la codificación.
El último handicap de la documentación es, lo rápidamente que se queda desfasada ante cambios del programa, volviéndose inservible.
Desde mi pundo de vista, no hay mejor documentación que un código limpio. Él hablará por si solo de las funcionalidades que implementa, siempre estará actualizado, y requiere un esfuerzo adicional menor.
Para ayudar a este código limpio, y a facilitar la herencia de fuentes de programadores de la misma empresa, toda la organización debe adoptar unos estándares de desarrollo comunes, de manera que una misma cosa, la hagan igual en todas partes, para que a simple vista pueda identificarse lo que se ve, y cada cual sepa buscar lo que necesita en el lugar adecuado.
