Documentación del programa

El objetivo de la documentación de programas es familiarizar a analistas y programadores con lo que hace cada programa en particular.

La documentación de programas es una extensión de la documentación del sistema. El programador convierte las especificaciones de programas en lenguaje de la computadora. El programador deberá trabajar conjuntamente con las especificaciones de programas y comprobar que el programa cumpla con las mismas. Cualquier cambio que surja como resultado de la programación deberá ser expuesto y aceptado antes de aplicar el cambio.

La documentación detallada de cada programa deberá incluir los siguientes elementos que apliquen:

1. Nombre del Programa (código). Indicará código que identifica el programa y el título del programa.
2. Descripción. Indicará la función que realiza el programador.
3. Frecuencia de Procesamiento. Diaria, semanal, quincenal, mensual, etcétera.
4. Fecha de Vigencia. Fecha a partir de la cual se comienza a ejecutar en producción la versión modificada o desarrollada del programa.
5. Archivos de Entrada.
6. Lista de Archivos de Salida: Indicará el nombre y copia y descripción de los archivos.
7. Lista de Informes y/o Totales de Control. Se indicará el nombre de los informes y se incluirá ejemplo de los informes y/o totales de control producidos por el programa, utilizando los datos de prueba.
8. Datos de Prueba. Se incluirá una copia de los datos usados para prueba.
9. Mensajes al Operador – Pantallas la definición de todos los mensajes al operador por consola y las posibles contestaciones con una breve explicación de cada una de ellas.
10. Datos de Control para ejecutar el programa (parámetros).
11. Transacciones.
12. Nombre del Programador Deberá indicar el nombre del programador que escribió el programa o que efectuó el cambio, según sea el caso.
13. Fecha. Indicará fecha en que se escribió el programa o que se efectuó el cambio, según sea el caso.
14. Diccionario de datos. En caso que aplique, se incluirá detalle de las diferentes tablas y códigos usados; con los valores, explicaciones y su uso en el programa.
15. Lista de Programas. Deberá incluir copia de la última compilación del programa con todas las opciones.

Fuente: Apunte Análisis, diseño e implantación de algoritmos de la facultad de contaduría y administración, UNAM

Publicado en Programación

Suscríbete:

who's online