Explicación de Documentación

El sistema cuyo menú es el PSDCME sirve para hacer la documentación de los programas de un sistema y tiene además opciones para el mantenimiento del mismo. Así por ejemplo de un sistema documentado se puede saber en cuantos programas se usa un archivo permanente, de forma que si se necesita hacer un cambio, se conozca como afectará.

Los pasos para documentar un sistema ya existente son:

· Activar con el modulo CPS opción DO el sistema de documentación.

· Poner en la DBD la definición de DOCUMENTACION y luego con D1 definir los sistemas de la DBD y con D2 definir los grupos que tiene cada sistema. Así por ejemplo para un sistema de nomina se pondría:

DOCUMENTACION

D1 1 ‘Nominas’

D2 1 1 ‘Actualizadores’

D2 1 2 ‘Calculo’

…..

· Poner los nombres extendidos de archivos y tablas. Así por ejemplo:

ARCHIVO RHEMP 3 2 ‘ ‘ ‘Archivo de empleados’

RECURRENTE 0 1000 M 2 1 2 ‘Infomacion general’ *

…..

TABLA TMES 2 N1 0 X 12 ‘Tabla de meses’ 2

….

· Poner antes de cada archivo o tabla la explicación del mismo con comentarios que tengan *D en columna 1 y 2, ya que estos son tomados por el sistema como parte de la documentación.

· En los programas poner la instrucción de DOCUMENTACION con el numero del sistema a que pertenece y el numero del grupo de acuerdo a lo definido en la DBD

· Poner también al principio de cada programa una explicación del mismo usando *D.

· Compilar la DBD y los programas.

· Ejecutar el menú de este sistema y agregar a DOCSIS la DBD y los programas.

· Consultar archivos, tablas, la documentación, …. Recorriendo las opciones del menú.

Como se ve la forma de documentar para tener su "Documentación de programación" es muy sencilla. Si el sistema ya esta hecho agregarla puede ser muy rápido.