http://angelinthemoon4.blogspot.com/
Hace 14 años
Sistemas de Documentación.-
La documentación de sistemas es el conjunto de información que nos dice qué hacen los sistemas, cómo lo hacen y para quién lo hacen.
La documentación consiste en material que explica las características técnicas y la operación de un sistema. Es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar con el sistema y a los operandos como hacerlo funcionar.
Otra definición sería la de registro físico, generalmente por escrito que contiene los siguientes elementos:
Políticas y normas referentes al desarrollo del sistema, su implantación, operación y mantenimiento.
El diseño del sistema de información administrativo.
Procedimientos para instalar el sistema de información administrativo.Procedimientos para operar el sistema de información administrativo.Procedimientos para mantener el sistema de información administrativo.
Características que deben cumplir los Sistemas de Documentación.-
- Deben ser aprobados, firmados y fechados por las personas apropiadas y autorizadas, ningún documento puede ser cambiado sin autorización.
- El contenido de los mismos no puede ser ambiguo, el titulo, tipo y propósito deben estar establecidos claramente.
- Deben ser legibles.
- Sencillez, definir las especificaciones de todos los materiales, procesos tecnológicos, control y de las actividades relacionadas con la investigación.
- Seguridad, evitar errores.
- Eficiencia y efectividad, asegurar que todo el personal relacionado con la investigación sepa qué hacer y cuándo hacerlo.
- Los documentos deben estar donde se les necesita, usarse por lo quien los requiere sin modificaciones no autorizadas, y ser llenados veraz y oportunamente.
Importancia.-
La importancia de la documentación bien podría ser comparada con la importancia de la existencia de una Póliza de Seguro; mientras todo va bien no existe la precaución de confirmar si nuestra Póliza de Seguros está o no vigente.
La documentación adecuada y completa, de una aplicación que se desea implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema de Información, sin embargo, frecuentemente es la parte a la cual se dedica el menor tiempo y se le presta menos atención.
Siempre se debe documentar un sistema como si estuviera a punto de irse a Siberia el siguiente mes, para nunca volver. Si la documentación del sistema es incompleta el diseñador continuamente estará involucrado y no podrá moverse a otra asignación.
Ventajas.-
Un sistema bien documentado, es necesario para las nuevas personas interesadas en aprender sobre el sistema y sirve como recordatorio para aquellas que usan el sistema con poca frecuencia.
Una documentación consistente y bien conservada, nos traerá como ventaja; acortar la cantidad de horas o tiempo requerido por nuevas personas para aprender el sistema antes de realizar el mantenimiento.
La documentación consiste en material que explica las características técnicas y la operación de un sistema. Es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditoria del sistema y para enseñar a los usuarios como interactuar con el sistema y a los operandos como hacerlo funcionar.
Otra definición sería la de registro físico, generalmente por escrito que contiene los siguientes elementos:
Políticas y normas referentes al desarrollo del sistema, su implantación, operación y mantenimiento.
El diseño del sistema de información administrativo.
Procedimientos para instalar el sistema de información administrativo.Procedimientos para operar el sistema de información administrativo.Procedimientos para mantener el sistema de información administrativo.
Características que deben cumplir los Sistemas de Documentación.-
- Deben ser aprobados, firmados y fechados por las personas apropiadas y autorizadas, ningún documento puede ser cambiado sin autorización.
- El contenido de los mismos no puede ser ambiguo, el titulo, tipo y propósito deben estar establecidos claramente.
- Deben ser legibles.
- Sencillez, definir las especificaciones de todos los materiales, procesos tecnológicos, control y de las actividades relacionadas con la investigación.
- Seguridad, evitar errores.
- Eficiencia y efectividad, asegurar que todo el personal relacionado con la investigación sepa qué hacer y cuándo hacerlo.
- Los documentos deben estar donde se les necesita, usarse por lo quien los requiere sin modificaciones no autorizadas, y ser llenados veraz y oportunamente.
Importancia.-
La importancia de la documentación bien podría ser comparada con la importancia de la existencia de una Póliza de Seguro; mientras todo va bien no existe la precaución de confirmar si nuestra Póliza de Seguros está o no vigente.
La documentación adecuada y completa, de una aplicación que se desea implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier Sistema de Información, sin embargo, frecuentemente es la parte a la cual se dedica el menor tiempo y se le presta menos atención.
Siempre se debe documentar un sistema como si estuviera a punto de irse a Siberia el siguiente mes, para nunca volver. Si la documentación del sistema es incompleta el diseñador continuamente estará involucrado y no podrá moverse a otra asignación.
Ventajas.-
Un sistema bien documentado, es necesario para las nuevas personas interesadas en aprender sobre el sistema y sirve como recordatorio para aquellas que usan el sistema con poca frecuencia.
Una documentación consistente y bien conservada, nos traerá como ventaja; acortar la cantidad de horas o tiempo requerido por nuevas personas para aprender el sistema antes de realizar el mantenimiento.
NORMAS DE DOCUMENTACION Y MANTENIMIENTO DE PROGRAMAS
PROCEDIMIENTO PARA CREACIÓN O CAMBIOS
A PROGRAMAS EN PRODUCCIÓN
Antes de la creación de un nuevo programa o realizar cualquier cambio a alguno existente se deben llevar a cabo los siguientes pasos:
A. Haber recibido una petición directa del usuario u oficina interesada.
El usuario quien solicita el servicio deberá complementar la forma “Solicitud de Creación o Cambios en Programación” provista para estos propósitos por la Oficina de Sistemas de Información. En la misma el usuario explicará de qué consiste el cambio, resultado actual del programa y cuál debería ser el resultado luego del cambio, en caso de que se trate de un cambio de programación. La solicitud debe ser firmada por el director ó supervisor de la oficina pertinente.
B. Haber sido entregada al director de programación para su procesamiento.
El director a cargo del área de programación le asignará un número a la petición, establecerá prioridad y determinará el programador que llevará a cabo la tarea.
C. Solicitar la actualización de los datos del área de prueba al área de operaciones, de ser necesario.
El programador deberá complementar la forma “Solicitud de Trabajo” provista para estos propósitos por el área de operaciones. En la misma se proveerá el área de pruebas que será actualizada. Los datos copiados por el área de operaciones son del final del día anterior. De ser necesario el copiar los datos actuales del área de producción, la oficina peticionaria deberá coordinar con las demás áreas administrativas del colegio para proceder a quitar el sistema y poder llevar a cabo la actualización.
D. Luego de haber procesado la petición y haber realizado las pruebas pertinentes en el área de prueba, se procederá entonces a llevar los cambios a producción.
1
Para poder culminar este proceso el programador deberá llevar cabo lo siguiente:
1. Notificar al director de programación la culminación del cambio.
2. Solicitar del usuario el cumplimentar la forma “Aceptación del usuario” provista para estos propósitos por la Oficina de Sistemas de Información.
En la misma, el usuario determinará si los resultados fueron satisfactorios. De no serlo, el usuario deberá explicar la razón por la cual entiende no se llegó al resultado deseado.
3. El Especialista de Tecnologías de Información o programador llenará el formulario Solicitud para Pase de Programado a Ambiente de Producción.
4. El Director de Desarrollo de Tecnologías de Información supervisará el cambio y autorizará el pase a producción. De no estar disponible y tratarse de un pase de emergencia el Director de la Oficina de Sistemas de Información o en su lugar la Subdirectora podrá autorizar el pase a producción.
5. Una vez cumplimentado y aprobado el formulario, el Especialista de Tecnologías de Información o programador procederá a entregárselo a la Supervisora de Operaciones o funcionario autorizado para realizar el pase a producción.
6. La Supervisora de Operaciones organizará y realizará las gestiones necesarias para que este documento quede archivado el término de tiempo requerido por la reglamentación.
Se coordinará con el usuario la fecha en que la nueva programación se comenzará a utilizar. El formulario Solicitud para Pase de Programado a Ambiente de Producción está publicado en la página Web www.uprb.edu/formularios. En la solicitud se proveerá el nombre de cada uno de los archivos, el área de prueba y el directorio donde se encuentran, además del área donde van a residir en producción. El documento deberá ser firmado por el solicitante, Director de Desarrollo de Tecnologías de Información o en su lugar el Director de la OSI o su representante
2
A PROGRAMAS EN PRODUCCIÓN
Antes de la creación de un nuevo programa o realizar cualquier cambio a alguno existente se deben llevar a cabo los siguientes pasos:
A. Haber recibido una petición directa del usuario u oficina interesada.
El usuario quien solicita el servicio deberá complementar la forma “Solicitud de Creación o Cambios en Programación” provista para estos propósitos por la Oficina de Sistemas de Información. En la misma el usuario explicará de qué consiste el cambio, resultado actual del programa y cuál debería ser el resultado luego del cambio, en caso de que se trate de un cambio de programación. La solicitud debe ser firmada por el director ó supervisor de la oficina pertinente.
B. Haber sido entregada al director de programación para su procesamiento.
El director a cargo del área de programación le asignará un número a la petición, establecerá prioridad y determinará el programador que llevará a cabo la tarea.
C. Solicitar la actualización de los datos del área de prueba al área de operaciones, de ser necesario.
El programador deberá complementar la forma “Solicitud de Trabajo” provista para estos propósitos por el área de operaciones. En la misma se proveerá el área de pruebas que será actualizada. Los datos copiados por el área de operaciones son del final del día anterior. De ser necesario el copiar los datos actuales del área de producción, la oficina peticionaria deberá coordinar con las demás áreas administrativas del colegio para proceder a quitar el sistema y poder llevar a cabo la actualización.
D. Luego de haber procesado la petición y haber realizado las pruebas pertinentes en el área de prueba, se procederá entonces a llevar los cambios a producción.
1
Para poder culminar este proceso el programador deberá llevar cabo lo siguiente:
1. Notificar al director de programación la culminación del cambio.
2. Solicitar del usuario el cumplimentar la forma “Aceptación del usuario” provista para estos propósitos por la Oficina de Sistemas de Información.
En la misma, el usuario determinará si los resultados fueron satisfactorios. De no serlo, el usuario deberá explicar la razón por la cual entiende no se llegó al resultado deseado.
3. El Especialista de Tecnologías de Información o programador llenará el formulario Solicitud para Pase de Programado a Ambiente de Producción.
4. El Director de Desarrollo de Tecnologías de Información supervisará el cambio y autorizará el pase a producción. De no estar disponible y tratarse de un pase de emergencia el Director de la Oficina de Sistemas de Información o en su lugar la Subdirectora podrá autorizar el pase a producción.
5. Una vez cumplimentado y aprobado el formulario, el Especialista de Tecnologías de Información o programador procederá a entregárselo a la Supervisora de Operaciones o funcionario autorizado para realizar el pase a producción.
6. La Supervisora de Operaciones organizará y realizará las gestiones necesarias para que este documento quede archivado el término de tiempo requerido por la reglamentación.
Se coordinará con el usuario la fecha en que la nueva programación se comenzará a utilizar. El formulario Solicitud para Pase de Programado a Ambiente de Producción está publicado en la página Web www.uprb.edu/formularios. En la solicitud se proveerá el nombre de cada uno de los archivos, el área de prueba y el directorio donde se encuentran, además del área donde van a residir en producción. El documento deberá ser firmado por el solicitante, Director de Desarrollo de Tecnologías de Información o en su lugar el Director de la OSI o su representante
2
B. Definiciones de Contenido
1. Descripción General del Programa
Esta sección presentará brevemente la descripción del programa. Deberá ser escrita en el lenguaje propio del usuario, sin entrar en detalles ni tecnicismos.
2. Flujograma
Deberá contener un diagrama que describa gráficamente la actividad del programa incluyendo documentos producidos, datos de entrada y fuentes que la proveen, informes del sistema y la disposición final de los resultados de los mismos.
3. Mensajes y formatos de pantalla
Si el sistema es en línea, deberá incluir los formatos de las diferentes pantallas. También deberá incluir los diferentes tipos de mensajes, ya sean estos de error, notificación de una situación en específico o de requerimiento de alguna pantalla (CUB-OSI-P014). Si el sistema no es en línea, deberá incluir los diferentes tipos de mensajes y las posibles contestaciones a los mismos.
4. Elementos de Datos (Diccionario)
Deberán definirse todos los tipos de récords a ser utilizados por el programa.
La siguiente información deberá incluirse para cada elemento de datos incluído en cada archivo.
a. Copia de la librería
b. Definición del DBD
5. Planes de Resguardo (“Backup”)
En cada proceso se indicará los archivos de resguardo y su periodo prescriptivo.
8
6. Frecuencia
En la solicitud de desarrollo de programación se indicarán la fecha límite para completar el desarrollo. (UPRB-OSI-P001)
En la documentación operacional se indicará la frecuencia de procesamiento.
III DISEÑO DEL SISTEMA
A. Propósito
El objetivo primordial del manual de diseño del sistema es el de proveer a los programadores suficiente información para escribir los programas de aplicaciones en lenguaje de computador.
Este manual forma parte de las especificaciones funcionales, ya que convierte la definición orientada al usuario en una definición orientada a sistemas computadorizados.
El Analista que esté desarrollando el diseño del sistema deberá trabajar conjuntamente con las especificaciones funcionales y enmendarlas, si fuera necesario.
Cualquier cambio a las especificaciones funcionales, como resultado del diseño del sistema, debe ser aprobado antes de proceder a actualizar el documento original.
El Manual del sistema deberá contener la documentación de cada uno de los programas que lo componen.
B. Definiciones de Contenido
1. Introducción
Se incluirá una descripción breve de la situación que motivó la creación del sistema. Se acompañará, si aplica, la base legal que justifique dicho sistema.
9
2. Descripción General del Sistema
Deberá presentar descripción narrativa del sistema y sus funciones. Además, se incluirán todos los programas que componen el sistema y su respectiva documentación.
3. Flujograma
Se incluirá flujograma general del sistema, en el cual se identificarán los programas para usos, arvhicos e informes que componen el mismo.
4. Formato de Archivos, Bases de Datos y/o Bloques de Datos
Formato de Archivos, Bases de Datos a ser utilizados por el sistema, deberán ser definidos y debe incluirse una breve descripción de cada uno de ellos.
Se deberá incluir el nombre del archivo y extensión, así como la siguiente información para cada uno:
• Copia de la librería
• Definición de DBD
• Definición de los campos de aquellos archivos que no están configurados en librerías o que no están definidos en DBB (“Data Base Definition”)
5. Formato de Pantallas
Si el sistema es en línea, deberá incluir formato de las pantallas que serán utilizadas por el sistema.
6. Especificaciones de Programas
Serán establecidos en la solicitud de cambio/desarrollo de programación (UPRB-OSI-P001). Para cada programa se debe incluir lo siguiente:
a. Identificación del Programa (código)
* Descripción
* Tipo de Programa (“Batch” , en línea, etc.)
10
* Nombre de Archivos de Entrada
* Nombre de Archivos de Salida
* Base de Datos (cuando aplique)
* Nombre de Informes
b. Descripción del Programa (UPRB-OSI-P005)
Narrativa de las funciones del programa. Se incluirá la definición de lo que hace el programa. Deberá ser lo más clara, organizada y precisa posible, además de estar bien presentada.
c. Formato de Pantallas
Si el sistema es en línea, deberá incluir formato de las pantallas utilizadas por el programa.
d. Formato de Archivos de Entrada y/o Salida (librería, DBD o definición) y Definición de la Base de Datos (cuando aplique).
e. Formato de Informes
1. Descripción General del Programa
Esta sección presentará brevemente la descripción del programa. Deberá ser escrita en el lenguaje propio del usuario, sin entrar en detalles ni tecnicismos.
2. Flujograma
Deberá contener un diagrama que describa gráficamente la actividad del programa incluyendo documentos producidos, datos de entrada y fuentes que la proveen, informes del sistema y la disposición final de los resultados de los mismos.
3. Mensajes y formatos de pantalla
Si el sistema es en línea, deberá incluir los formatos de las diferentes pantallas. También deberá incluir los diferentes tipos de mensajes, ya sean estos de error, notificación de una situación en específico o de requerimiento de alguna pantalla (CUB-OSI-P014). Si el sistema no es en línea, deberá incluir los diferentes tipos de mensajes y las posibles contestaciones a los mismos.
4. Elementos de Datos (Diccionario)
Deberán definirse todos los tipos de récords a ser utilizados por el programa.
La siguiente información deberá incluirse para cada elemento de datos incluído en cada archivo.
a. Copia de la librería
b. Definición del DBD
5. Planes de Resguardo (“Backup”)
En cada proceso se indicará los archivos de resguardo y su periodo prescriptivo.
8
6. Frecuencia
En la solicitud de desarrollo de programación se indicarán la fecha límite para completar el desarrollo. (UPRB-OSI-P001)
En la documentación operacional se indicará la frecuencia de procesamiento.
III DISEÑO DEL SISTEMA
A. Propósito
El objetivo primordial del manual de diseño del sistema es el de proveer a los programadores suficiente información para escribir los programas de aplicaciones en lenguaje de computador.
Este manual forma parte de las especificaciones funcionales, ya que convierte la definición orientada al usuario en una definición orientada a sistemas computadorizados.
El Analista que esté desarrollando el diseño del sistema deberá trabajar conjuntamente con las especificaciones funcionales y enmendarlas, si fuera necesario.
Cualquier cambio a las especificaciones funcionales, como resultado del diseño del sistema, debe ser aprobado antes de proceder a actualizar el documento original.
El Manual del sistema deberá contener la documentación de cada uno de los programas que lo componen.
B. Definiciones de Contenido
1. Introducción
Se incluirá una descripción breve de la situación que motivó la creación del sistema. Se acompañará, si aplica, la base legal que justifique dicho sistema.
9
2. Descripción General del Sistema
Deberá presentar descripción narrativa del sistema y sus funciones. Además, se incluirán todos los programas que componen el sistema y su respectiva documentación.
3. Flujograma
Se incluirá flujograma general del sistema, en el cual se identificarán los programas para usos, arvhicos e informes que componen el mismo.
4. Formato de Archivos, Bases de Datos y/o Bloques de Datos
Formato de Archivos, Bases de Datos a ser utilizados por el sistema, deberán ser definidos y debe incluirse una breve descripción de cada uno de ellos.
Se deberá incluir el nombre del archivo y extensión, así como la siguiente información para cada uno:
• Copia de la librería
• Definición de DBD
• Definición de los campos de aquellos archivos que no están configurados en librerías o que no están definidos en DBB (“Data Base Definition”)
5. Formato de Pantallas
Si el sistema es en línea, deberá incluir formato de las pantallas que serán utilizadas por el sistema.
6. Especificaciones de Programas
Serán establecidos en la solicitud de cambio/desarrollo de programación (UPRB-OSI-P001). Para cada programa se debe incluir lo siguiente:
a. Identificación del Programa (código)
* Descripción
* Tipo de Programa (“Batch” , en línea, etc.)
10
* Nombre de Archivos de Entrada
* Nombre de Archivos de Salida
* Base de Datos (cuando aplique)
* Nombre de Informes
b. Descripción del Programa (UPRB-OSI-P005)
Narrativa de las funciones del programa. Se incluirá la definición de lo que hace el programa. Deberá ser lo más clara, organizada y precisa posible, además de estar bien presentada.
c. Formato de Pantallas
Si el sistema es en línea, deberá incluir formato de las pantallas utilizadas por el programa.
d. Formato de Archivos de Entrada y/o Salida (librería, DBD o definición) y Definición de la Base de Datos (cuando aplique).
e. Formato de Informes
Se incluirán formatos de los informes que producirá el programa.
IV DOCUMENTACION DE PROGRAMAS
A. Propósito
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 extension de la documentación del sistema. El programador convierte las especificaciones de programas en lenguaje de computador. El programador deberá trabajar conjuntamente con las especificaciones de programas y asegurarse que el programa
11
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 de programas es técnica y detallada y no necesita estar escrita en una manera entendible al usuario.
1. Pasos a seguir al codificar un programa
a. Programa Nuevo
* El programador leerá en detalle las especificaciones del programa y anotará las dudas que tenga.
* Concertará una cita con el usuario que solicita el cambio o desarrollo nuevo para aclarar dichas dudas o discutir alguna condición que él considere debe incluirse y no esté en las especificaciones.
* Codificará el programa en lenguaje de computador, conforme a las directrices definidas en las especificaciones. Deberá incluir dentro del programa una descripción breve del propósito del programa y comentarios que describan cada rutina o sección.
* Creará datos de prueba con suficientes casos para probar todas las alternativas que se han considerado en el programa. NOTA: Muchas veces los datos reales para una ejecución no contienen simultáneamente todas las condiciones que pueden suceder en diferentes ocasiones por separado. En esta fase es conveniente hacer un cotejo del contenido de los datos de prueba contra las especificaciones recibidas.
b. Datos de Prueba
* Presentará una colección de datos que se usarán en la verificación e la corrección de los programas y sistemas. Se incluirán datos de
12
prueba para todos los elementos de datos que se manejen en el programa o sistema. Los datos de prueba incluirán tanto datos correctos como incorrectos. Con cada dato incorrecto se especificará la acción que debe tomar el programa y el mensaje que se debe producir.
* Cotejará concienzudamente los resultados obtenidos en la prueba.
* Se asegurará de entregar los documentos incluídos en la lista de cotejo de documentación de programa.
* Luego que el analista haya cotejado y aprobado el programa, actualizará la documentación final del mismo.
c. Revisión y Cambios
* El programador deberá familiarizarse con el programa original antes de hacer modificaciones al mismo.
* Actualizará toda la documentación del programa a tenor con la revision.
* En el programa, a manera de comentario, indicará fecha del ultimo cambio y el nombre del programador, así como también un breve resumen del cambio.
2. Contenido
La documentación detallada de cada programa deberá incluir los siguientes elementos que apliquen:
• Nombre del Programa (código)
• Descripción
• Frecuencia de Procesamiento
13
• Fecha de Efectividad
• Archivos de Data
• Lista de Archivos de Salida
• Lista de Informes
• Datos de Prueba
• Mensajes al Operador - Pantallas (en caso que aplique)
• Datos de Control para ejecutar el programa (parámetros)
• Transacciones
• Nombre del Programador
• Fecha
B. Definiciones de Contenido
1. Nombre del Programa
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. Fecha de Efectividad
Fecha a partir de la cual se comienza a ejecutar en producción la version modificada o desarrollada del programa.
4. Archivo de Entrada (Librería/Definición DBD/Descripción de Archivo)
14
5. Archivos de Salida
Indicará el nombre y copia de la librería/DBD/Descripción de los archivos.
6. 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.
7. Nombre del Programador
Deberá indicar el nombre del programador que escribió el programa o que efectuó el cambio, según sea el caso.
8. Fecha
Indicará fecha en que se escribió el programa o que se efectuó el cambio, según sea el caso.
9. Tablas (UPRB-OSI-P006)
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.
10. Lista de Programas
Deberá incluir copia de la última compilación del programa con todas las opciones. Cotejará que la secuencia del programa sea correcta.
11. Lista de Datos de Prueba
Se incluirá una copia de los datos usados para prueba.
12. Mensajes al Operador
En caso que aplique, deberá definir todos los mensajes al operador por consola y las posibles contestaciones con una breve explicación de cada una de ellas.
15
13. Parámetros
Se acompañará una lista detallada de todos los parámetros para ejecutar el programa (JCL, “Command Procedures”, etc.)
IV DOCUMENTACION DE PROGRAMAS
A. Propósito
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 extension de la documentación del sistema. El programador convierte las especificaciones de programas en lenguaje de computador. El programador deberá trabajar conjuntamente con las especificaciones de programas y asegurarse que el programa
11
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 de programas es técnica y detallada y no necesita estar escrita en una manera entendible al usuario.
1. Pasos a seguir al codificar un programa
a. Programa Nuevo
* El programador leerá en detalle las especificaciones del programa y anotará las dudas que tenga.
* Concertará una cita con el usuario que solicita el cambio o desarrollo nuevo para aclarar dichas dudas o discutir alguna condición que él considere debe incluirse y no esté en las especificaciones.
* Codificará el programa en lenguaje de computador, conforme a las directrices definidas en las especificaciones. Deberá incluir dentro del programa una descripción breve del propósito del programa y comentarios que describan cada rutina o sección.
* Creará datos de prueba con suficientes casos para probar todas las alternativas que se han considerado en el programa. NOTA: Muchas veces los datos reales para una ejecución no contienen simultáneamente todas las condiciones que pueden suceder en diferentes ocasiones por separado. En esta fase es conveniente hacer un cotejo del contenido de los datos de prueba contra las especificaciones recibidas.
b. Datos de Prueba
* Presentará una colección de datos que se usarán en la verificación e la corrección de los programas y sistemas. Se incluirán datos de
12
prueba para todos los elementos de datos que se manejen en el programa o sistema. Los datos de prueba incluirán tanto datos correctos como incorrectos. Con cada dato incorrecto se especificará la acción que debe tomar el programa y el mensaje que se debe producir.
* Cotejará concienzudamente los resultados obtenidos en la prueba.
* Se asegurará de entregar los documentos incluídos en la lista de cotejo de documentación de programa.
* Luego que el analista haya cotejado y aprobado el programa, actualizará la documentación final del mismo.
c. Revisión y Cambios
* El programador deberá familiarizarse con el programa original antes de hacer modificaciones al mismo.
* Actualizará toda la documentación del programa a tenor con la revision.
* En el programa, a manera de comentario, indicará fecha del ultimo cambio y el nombre del programador, así como también un breve resumen del cambio.
2. Contenido
La documentación detallada de cada programa deberá incluir los siguientes elementos que apliquen:
• Nombre del Programa (código)
• Descripción
• Frecuencia de Procesamiento
13
• Fecha de Efectividad
• Archivos de Data
• Lista de Archivos de Salida
• Lista de Informes
• Datos de Prueba
• Mensajes al Operador - Pantallas (en caso que aplique)
• Datos de Control para ejecutar el programa (parámetros)
• Transacciones
• Nombre del Programador
• Fecha
B. Definiciones de Contenido
1. Nombre del Programa
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. Fecha de Efectividad
Fecha a partir de la cual se comienza a ejecutar en producción la version modificada o desarrollada del programa.
4. Archivo de Entrada (Librería/Definición DBD/Descripción de Archivo)
14
5. Archivos de Salida
Indicará el nombre y copia de la librería/DBD/Descripción de los archivos.
6. 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.
7. Nombre del Programador
Deberá indicar el nombre del programador que escribió el programa o que efectuó el cambio, según sea el caso.
8. Fecha
Indicará fecha en que se escribió el programa o que se efectuó el cambio, según sea el caso.
9. Tablas (UPRB-OSI-P006)
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.
10. Lista de Programas
Deberá incluir copia de la última compilación del programa con todas las opciones. Cotejará que la secuencia del programa sea correcta.
11. Lista de Datos de Prueba
Se incluirá una copia de los datos usados para prueba.
12. Mensajes al Operador
En caso que aplique, deberá definir todos los mensajes al operador por consola y las posibles contestaciones con una breve explicación de cada una de ellas.
15
13. Parámetros
Se acompañará una lista detallada de todos los parámetros para ejecutar el programa (JCL, “Command Procedures”, etc.)
B. Definiciones de Contenido
1. Descripción General Programa
Presentará brevemente los objetivos y funciones que habrá de realizar el programa.
2. Deberán incluir un modelo de ejecución para cada opción del programa (UPRB-OSI-P005) donde se indicarán los parámetros o datos necesarios. Para programas en línea, se indicarán las opciones de menú y/o los datos requeridos por el programa para su ejecución.
19
3. Formularios y Transacciones
Se incluirá copia de cada formulario y/o transacciones utilizados por el sistema. Se ofrecerá una breve explicación de cada formulario y se especificará lo siguiente:
• Cómo completar cada formulario
• Cualquier detalle en cuanto al manejo de la información
Deberá explicar en detalle cómo completar cada campo.
Si el sistema es en línea, deberá incluir cada pantalla que se utiliza en el sistema. Indicará lo siguiente:
• Código de la Pantalla
• Nombre de la Pantalla
• Propósito
• Entradas
• Instrucciones para cada campo
• Mensajes de cada transacción
VIII MANUAL DE INSTRUCCIONES AL OPERADOR
A. Propósito
El Manual de Instrucciones al Operador proveerá instrucciones de cómo correr el sistema. El analista deberá trabajar en conjunto con las especificaciones funcionales, diseño del sistema y documentación de programas para escribir el Manual de Instrucciones al Operador. Este Manual deberá estar estructurado de manera tal que sirva de ayuda al adiestramiento del personal.
20
1. Contenido
El Manual de Instrucciones al Operador deberá incluir lo siguiente:
a. Instrucciones al Operador
• Descripción del Programa
• Flujogramas Generales del Programa
• Parámetros
• Mensajes al Operador (UPRB-OSI-P004)
• Instrucciones para etiquetas de cintas de salida (“labels”)
• Planes de Resguardo (“backups”)
• “Command Procedures” y/o JCL’s
• Instrucciones Especiales
B. Definiciones de Contenido
1. Instrucciones al Operador
a. Descripción del Programa
Incluirá descripción narrativa del programa y qué debe hacer el Operador antes y mientras ejecuta los programas del sistema.
b. Flujograma General del Programa
Deberá incluir copia del Flujograma General del Programa, tal como aparece en el Manual de Diseño del Sistema. Este flujograma reflejará la interrelación de programa a programa con los archivos correspondientes. Además, se indicará la frecuencia de cada programa, disposición de cada archivo,
21
etiquetas de archivos de salida en cinta magnética, destino de cada copia de los informes y algún comentario específico de cada uno de los programas.
c. Parámetros para ejecutar programas
Se deberá incluir una lista de todos los parámetros para ejecutar cada programa.
d. Mensajes al Operador
Indicará una lista detallada de todos los mensaje, tal como aparecen en la consola, las posibles contestaciones y el por qué de dichas respuestas. Esto se hará para cada programa.
e. Planes de Resguardo (“backups”)
Deberá incluir instrucciones específicas de los procedimientos a seguir para el mantenimiento de un resguardo (“backup”).
f. Instrucciones Especiales
En esta sección se deberá incluir un itinerario de fechas para ejecutar cada programa (frecuencia), fecha de cierre, flujo de documentos, control de cintas (ciclo de retención), formas especiales de impresora y algún otro comentario que se crea pertinente.
1. Descripción General Programa
Presentará brevemente los objetivos y funciones que habrá de realizar el programa.
2. Deberán incluir un modelo de ejecución para cada opción del programa (UPRB-OSI-P005) donde se indicarán los parámetros o datos necesarios. Para programas en línea, se indicarán las opciones de menú y/o los datos requeridos por el programa para su ejecución.
19
3. Formularios y Transacciones
Se incluirá copia de cada formulario y/o transacciones utilizados por el sistema. Se ofrecerá una breve explicación de cada formulario y se especificará lo siguiente:
• Cómo completar cada formulario
• Cualquier detalle en cuanto al manejo de la información
Deberá explicar en detalle cómo completar cada campo.
Si el sistema es en línea, deberá incluir cada pantalla que se utiliza en el sistema. Indicará lo siguiente:
• Código de la Pantalla
• Nombre de la Pantalla
• Propósito
• Entradas
• Instrucciones para cada campo
• Mensajes de cada transacción
VIII MANUAL DE INSTRUCCIONES AL OPERADOR
A. Propósito
El Manual de Instrucciones al Operador proveerá instrucciones de cómo correr el sistema. El analista deberá trabajar en conjunto con las especificaciones funcionales, diseño del sistema y documentación de programas para escribir el Manual de Instrucciones al Operador. Este Manual deberá estar estructurado de manera tal que sirva de ayuda al adiestramiento del personal.
20
1. Contenido
El Manual de Instrucciones al Operador deberá incluir lo siguiente:
a. Instrucciones al Operador
• Descripción del Programa
• Flujogramas Generales del Programa
• Parámetros
• Mensajes al Operador (UPRB-OSI-P004)
• Instrucciones para etiquetas de cintas de salida (“labels”)
• Planes de Resguardo (“backups”)
• “Command Procedures” y/o JCL’s
• Instrucciones Especiales
B. Definiciones de Contenido
1. Instrucciones al Operador
a. Descripción del Programa
Incluirá descripción narrativa del programa y qué debe hacer el Operador antes y mientras ejecuta los programas del sistema.
b. Flujograma General del Programa
Deberá incluir copia del Flujograma General del Programa, tal como aparece en el Manual de Diseño del Sistema. Este flujograma reflejará la interrelación de programa a programa con los archivos correspondientes. Además, se indicará la frecuencia de cada programa, disposición de cada archivo,
21
etiquetas de archivos de salida en cinta magnética, destino de cada copia de los informes y algún comentario específico de cada uno de los programas.
c. Parámetros para ejecutar programas
Se deberá incluir una lista de todos los parámetros para ejecutar cada programa.
d. Mensajes al Operador
Indicará una lista detallada de todos los mensaje, tal como aparecen en la consola, las posibles contestaciones y el por qué de dichas respuestas. Esto se hará para cada programa.
e. Planes de Resguardo (“backups”)
Deberá incluir instrucciones específicas de los procedimientos a seguir para el mantenimiento de un resguardo (“backup”).
f. Instrucciones Especiales
En esta sección se deberá incluir un itinerario de fechas para ejecutar cada programa (frecuencia), fecha de cierre, flujo de documentos, control de cintas (ciclo de retención), formas especiales de impresora y algún otro comentario que se crea pertinente.
