Informatica
8. Documentación
Es la fase más ignorada por la mayoría de los programadores, por razones de tiempo, costos o simple pereza. Pero no documentar losprogramas es un mal hábito en programación y un gran error.
Será muy difícil a los usuarios entender un programa si no cuentan con un manual de operaciones (el Manual de Usuario). También para losprogramadores que necesiten darle mantenimiento o hacerle modificaciones si no existe ninguna documentación acerca de sus fases de desarrollo. Incluso será difícil de entender para el mismo autor,algún tiempo después.
La documentación es la guía o comunicación escrita en sus variadas formas, ya sea en enunciados, procedimientos, dibujos o diagramas y sirve para ayudar acomprender o usar un programa o para facilitar futuras modificaciones (mantenimiento). Recoge todos los elementos encontrados y material creado en las diferentes fases del desarrollo, además de las normas deinstalación o las recomendaciones para la ejecución del programa.
La documentación se divide en tres partes:
• Documentación Interna
• Documentación Externa
• Manual del UsuarioDocumentación Interna:
Son los comentarios que se añaden al código fuente para clarificarlo.
Documentación Externa:
Es todo el material creado y empleado en las diferentes fases deldesarrollo del programa. Incluye:
• Descripción del Problema
• Narrativo con la descripción de la solución
• Autor(s)
• Algoritmo (diagrama de flujo y/o pseudocódigo)
• CódigoFuente (programa)
• Relación de los elementos utilizados en el programa, cada uno con su respectiva función
• Limitaciones del programa
Manual del Usuario:
Describe paso a paso lamanera cómo funciona el programa, con el fin de que los usuarios puedan operarlo correctamente y obtener los resultados deseados.
9. Capacitación
Una vez que tenemos lo...
Regístrate para leer el documento completo.