Capítulo 10. Documentación Documentación
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
De las quejas que la mayoría de los ingenieros tienen sobre la escritura, el uso y el mantenimiento del código, una frustración común singular es la falta de documentación de calidad. "¿Cuáles son los efectos secundarios de este método?" "Tengo un error después del paso 3". "¿Qué significan estas siglas?". "¿Está actualizado este documento?" Todos los ingenieros de software han expresado quejas sobre la calidad, cantidad o pura falta de documentación a lo largo de su carrera, y los ingenieros de software de Google no son diferentes.
Los redactores técnicos y los gestores de proyectos pueden ayudar, pero los ingenieros de software siempre tendrán que escribir ellos mismos la mayor parte de la documentación. Por tanto, los ingenieros necesitan las herramientas y los incentivos adecuados para hacerlo con eficacia. La clave para facilitarles la redacción de documentación de calidad es introducir procesos y herramientas que se adapten a la organización y que se integren en su flujo de trabajo actual.
En general, el estado de la documentación de ingeniería a finales de la década de 2010 es similar al estado de las pruebas de software a finales de la década de 1980. Todo el mundo reconoce que hay que esforzarse más por mejorarla, pero aún no existe un reconocimiento organizativo ...
Get Ingeniería de software en Google now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
