Documentación del programa
Cualquier texto, ilustración o video escrito que describa un software o programa a sus usuarios se denomina program or software document. El usuario puede ser cualquier persona, desde un programador, analista de sistemas y administrador hasta un usuario final. En varias etapas de desarrollo, se pueden crear múltiples documentos para diferentes usuarios. De hecho,software documentation es un proceso crítico en el proceso general de desarrollo de software.
En la programación modular, la documentación se vuelve aún más importante porque los diferentes módulos del software son desarrollados por diferentes equipos. Si alguien que no sea el equipo de desarrollo quiere o necesita entender un módulo, una documentación buena y detallada facilitará la tarea.
Estas son algunas pautas para crear los documentos:
La documentación debe ser desde el punto de vista del lector.
El documento debe ser inequívoco
No debe haber repetición
Deben utilizarse los estándares de la industria
Los documentos siempre deben estar actualizados
Cualquier documento desactualizado debe eliminarse gradualmente después del debido registro de la eliminación.
Ventajas de la documentación
Estas son algunas de las ventajas de proporcionar documentación del programa:
Realiza un seguimiento de todas las partes de un software o programa
El mantenimiento es más fácil
Los programadores que no sean el desarrollador pueden comprender todos los aspectos del software
Mejora la calidad general del software.
Ayuda en la formación del usuario
Garantiza la descentralización del conocimiento, reduciendo costos y esfuerzos si las personas abandonan el sistema de forma abrupta
Documentos de ejemplo
Un software puede tener muchos tipos de documentos asociados. Algunos de los importantes incluyen:
User manual - Describe instrucciones y procedimientos para que los usuarios finales utilicen las diferentes funciones del software.
Operational manual - Enumera y describe todas las operaciones que se están realizando y sus interdependencias.
Design Document- Ofrece una descripción general del software y describe los elementos de diseño en detalle. Documenta detalles comodata flow diagrams, entity relationship diagramsetc.
Requirements Document- Tiene una lista de todos los requisitos del sistema así como un análisis de viabilidad de los requisitos. Puede tener casos de usuario, escenarios de la vida real, etc.
Technical Documentation - Es una documentación de componentes de programación reales como algoritmos, diagramas de flujo, códigos de programa, módulos funcionales, etc.
Testing Document - Registra el plan de prueba, los casos de prueba, el plan de validación, el plan de verificación, los resultados de las pruebas, etc. Las pruebas son una fase del desarrollo de software que necesita documentación intensiva.
List of Known Bugs- Todo software tiene fallos o errores que no se pueden eliminar porque se descubrieron muy tarde o son inofensivos o requerirán más esfuerzo y tiempo del necesario para corregirlos. Estos errores se enumeran con la documentación del programa para que puedan eliminarse en una fecha posterior. También ayudan a los usuarios, implementadores y personal de mantenimiento si se activa el error.