Saca tu almohada favorita porque es hora de discutir sobre el tema más aburrido de todos — la documentación. Creas que sí o creas que no, al principio de la época de desarrollo, esto era una verdadera y una importante entrega.
La documentación (y todavía lo es en algunas industrias) era una profesión separada. ¿Cuál es el propósito hoy en día? Por supuesto, facilitar que los desarrolladores comprendan cómo funciona la aplicación antes de cambiarla, y sin necesidad de pasar semanas intentando ingeniería inversa del código.
Voy a ser muy directo para ahorrarte tiempo. Realmente no hay necesidad de tener documentación detallada. Si estás usando frameworks estándar, estos ya están documentados por quienes los mantienen, y eso te lleva lejos. En segundo lugar, nadie lo leerá. Lo siento, no lo harán.
Por lo tanto, es una idea mucho mejor enfocarse en documentar partes del código que son complejas, que contienen lógica de negocio pesada y que realizan alguna función importante en tu aplicación.
Un documento de 3 a 5 páginas que describe la funcionalidad de manera general, con detalles sobre los estados o lo que puede ser, será leído porque es comprensible y fácil de asimilar rápidamente.
Toda la documentación necesita ser mantenida, por lo que una vez que hayas terminado de codificar alguna lógica compleja para una característica, es una buena idea descargar todo lo más importante sobre ella. Te lo agradecerás más adelante.
Lee más en "El Manual del CTO" disponible en Amazon/Kindle.
Ayudamos a las empresas con su tecnología, proporcionando servicios de CTO y gestión de productos. Confiados en nuestros servicios de CTO, trabajamos con tanto startups como empresas establecidas en los países nórdicos, Suiza y EE. UU.
Somos una Compañía Suiza (LLC) con sede en 
Suiza.