¿Cuáles son las frustraciones comunes al escribir documentación para un proyecto de software?

La mayoría de los proyectos de software tradicionales tienen (erróneamente) documentación pesada. Antes, durante y después de los proyectos. Los documentos pueden ser útiles para aprender, pero no para desarrollarlos la mayor parte del tiempo.

Hay demasiada documentación que es un desperdicio. No es tanto que el acto de documentar sea un desperdicio inherente, solo que la cantidad de reprocesamiento que entra en los documentos es ridículamente alta y lo que se escribe es, en la mayoría de los casos, de muy baja calidad. Todo esto por algo que en sí mismo no deriva ningún valor por sí mismo, pero que puede costar una pequeña fortuna producir, sobre todo si se emplean grandes empresas para producirlos.

Es aún peor cuando tienes personal que nunca antes ha trabajado estrechamente con los desarrolladores. ¡En este caso los documentos que se producen son literalmente inútiles! Este ha sido el caso en algunas grandes empresas de TI muy sorprendentes. Es sorprendente lo mal que pueden ser. Como alguien que tiene un nivel de ética extremadamente alto cuando se trata de gastar el dinero de otras personas, esas compañías realmente me agradecen y me dan asco.

En primer lugar, si no eres bueno en la documentación, NO LO HAGAS.

En segundo lugar, la documentación requiere paciencia y claridad. Básicamente, si tiene todo en mente lo que quiere lograr, la documentación será el tiempo que se tarda en escribirla en un archivo de Word.

Pero, diciendo que el 90% del tiempo se asumen muchas cosas, no está claro desde la perspectiva del cliente o un simple malentendido entre las dos partes. Desde mi punto de vista, la parte más frustrante es la falta de claridad y la fijación de la documentación una y otra vez. Aunque es parte del proceso y continúa en los proyectos de software a menudo.

More Interesting

¿Qué es diferente en la educación en informática en Rusia, que hace que los programadores rusos estén en la cima en los concursos de programación? ¿Es consecuencia de la educación centrada en la ingeniería en la antigua URSS?

¿Cómo es ser ingeniero de software en el Broad Institute?

¿Es cierto que la programación de computadoras es 99% autodidacta?

¿Puede un estudiante de posgrado internacional de 23 años, sin experiencia previa en programación de computadoras, convertirse en un ingeniero de software exitoso en los Estados Unidos?

¿Cuáles son las opciones de carrera después de 3 años de experiencia en desarrollo de software en la industria de TI?

¿Puedo tener una startup o ser un desarrollador de software independiente mientras soy un oficial de IAS?

¿Es una mala idea adquirir habilidades de desarrollo de pila completa al tratar principalmente de ser un ingeniero de software calificado?

Cómo practicar patrones de diseño

¿Qué proyecto o empresa utiliza el modelo de cascada?

¿Es la Ley de Cookies de la UE una pérdida de tiempo?

¿Cuáles son los mejores teclados ergonómicos?

Como desarrollador de software, ¿son comunes los períodos inactivos y qué haces con ellos?

¿Qué tan válida es la declaración 'JavaScript perjudica su SEO, arquitectura de software, inversión de software y robustez'?

¿Alguien puede convertirse en ingeniero de software?

¿Por qué la leyenda urbana dice que Steve Jobs, Jeff Raskin y el resto del equipo 'robaron' de Xerox?