Los diferentes tipos de documentos de software pueden clasificarse a grandes rasgos en los siguientes:
- Documentación interna
- Documentación externa
La documentación interna son las características de comprensión del código que se proporcionan como parte del propio código fuente. La documentación interna se proporciona a través de las cabeceras de los módulos y los comentarios adecuados incrustados en el código fuente. La documentación interna también se proporciona a través de los nombres útiles de las variables, las cabeceras de los módulos y las funciones, la sangría del código, la estructuración del código, el uso de tipos enumerados e identificadores constantes, el uso de tipos de datos definidos por el usuario, etc. Los experimentos cuidadosos sugieren que, de todos los tipos de documentación interna, los nombres de las variables útiles son los más útiles para entender el código. Por supuesto, esto contrasta con la expectativa común de que los comentarios del código sean los más útiles. El hallazgo de la investigación es obviamente cierto cuando los comentarios se escriben sin pensar. Por ejemplo, el siguiente estilo de comentario de código no ayuda en absoluto a entender el código.
a = 10; /* a hizo 10 */
Pero incluso cuando el código se comenta cuidadosamente, los nombres de las variables con significado siguen siendo más útiles para entender un trozo de código. Las buenas organizaciones de desarrollo de software suelen garantizar una buena documentación interna mediante la formulación adecuada de sus normas de codificación y directrices de codificación.
La documentación externa se proporciona a través de varios tipos de documentos de apoyo, como el manual de usuarios, el documento de especificación de requisitos de software, el documento de diseño, los documentos de prueba, etc. Un estilo de desarrollo de software sistemático garantiza que todos estos documentos se produzcan de forma ordenada.
Archivo PDF:
http://www.vssut.ac.in/lecture_notes/lecture1428551142.pdf