febrero 07, 2010

UNIDAD I: DOCUMENTACION DE SISTEMAS

La Documentación de Sistema

Es un conjunto de elementos registrados sobre cualquier soporte que permita instruir o informar acerca de algo, en función de las necesidades específicas de aquellos que la utilizan. 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.
Muchas organizaciones tienen lo que se conoce como un "programa de documentación", el cual consiste en una política formal cuya documentación se muestra como algo que debe prepararse en forma rutinaria para cada programa de cómputo, archivo y nuevos sistemas.
Existen varios tipos de documentación. La de programas, que explica la lógica de un programa e incluye descripciones, diagramas de flujo, listados de programas y otros documentos. La del usuarios en forma general la naturaleza y capacidades del sistema y cómo usarlo. 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.

Concepto de Sistema

Un sistema es un conjunto de "elementos" relacionados entre sí, de forma tal que un cambio en un elemento afecta al conjunto de todos ellos. Los elementos relacionados directa o indirectamente con el problema, y sólo estos, formarán el sistema que vamos a estudiar.
Un sistema puede ser definido como un conjunto de actividades y elementos organizados para alcanzar un fin. Un sistema de información se compone de elementos como hardware, software, personas, procedimientos y datos que interactúan unos con otros para generar la información primordial en el desempeño de la organización.

La información es un recurso valioso que permite a la organización llevar a cabo la prestación de servicios o elaboración de productos. Es común que las organizaciones deban cambiar sus sistemas de información, motivado al crecimiento de la misma, cambio en regulaciones estatales, surgimiento de nueva tecnología, y otros. Es decir, siempre habrán factores que modifiquen el ambiente donde se desempeña la organización y ésta debe cambiar para afrontarlos, lo cual se verá reflejado en los sistemas que la conforman.

Importancia De La Documentación De Sistemas

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 l 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.


Estandarización

El uso de procedimientos y documentación estandarizada proporciona la base de una comunicación clara y rápida, adiestramiento menos costoso del personal de sistemas, reducción de costos de almacenamiento, y otros.

Ventajas De La Estandarización

• Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.
• Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
• Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
• Asegura que el sistema opere correctamente.
• Se utilizan eficientemente los recursos que se dispongan.

Estándares Básicos De Documentación

• Toda documentación que se relacione con un sistema, ya sea manual o por computadora, sencillo o complejo debe reunir los siguientes requisitos básicos:
• Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, almacenarlas en carpetas e índice.

• Los diagramas deberán ser claros, no aglomerados y la escritura manuscrita deberá ser legible.
• La documentación deberá ser completa.
• Se incluirá una leyenda o explicación de los términos utilizados.
• La documentación siempre se conserva actualizada.
Leer mas >>

UNIDAD II

Objetivos de la Documentación de Sistemas.

  • Tener un respaldo formal de la información
  • Crear una apreciación unitaria y conjunta del sistema
  • Facilitra el conocimiento, interpretación, comprensión y divulgación del sistema
  • Ser un elemento imprescindible para el control interno en general y del sistema en particular; proveer los antecedentes que permiten conocer como se ha diseñado el sistema y como debería estar operando, o sea facilita el parámetro de referencia contra el cual se analizará y/o enjuiciará su comportamiento real
  • Servir de base para auditar los sistemas de información
  • Eliminar los riesgos de dependencia con respecto a determinados individuos que conocen el sistema
  • Ser elemento fundamental para la adecuada capacitación de los usuarios del sistema y facilita la comunicación con los mismos
  • Proveer antecedentes esenciales, concretos y permanentes para evaluar eventuales modificaciones a sistemas en su funcionamiento y/o para decidir la sustitución de los mismos
  • Aumentar la seguridad y eficiencia en el mantenimiento de los sistemas y reduce su costo
  • Constituir el único medio idóneo de consulta general para poder tomar conocimiento actualizado de los sistemas en funcionamiento en la organización
  • Resultar imprescindible como elemento de juicio para la evaluación de sistemas stándars o programas producto susceptible de ser adquiridos

La documentación básica necesaria de un sistema de información deberá contar con:

Carpeta de papeles de trabajo (análisis):

  • Síntesis del documento de generación
  • Presupuesto o plan de fijación de tareas
  • Documentación del relevamiento detallado
  • Formularios o comprobantes analizados
  • Papeles de trabajo del análisis
  • Estudio de factibilidad y diagnóstico
  • Carpeta de sistemas (diseño global):
  • Fijación de los objetivos del sistema
  • Descripción global del sistema
  • Modelo lógico del sistema (DFD, diccionario de datos, especificación de la lógica)
  • Diseño de entradas y salidas
  • Normas y procedimientos para los usuarios (en operaciones de rutina, de respaldo, de emergencia, de recupero, de uso de back-up)
  • Recursos materiales y humanos necesarios
  • Estudio técnico-económico acerca de la posibilidad de procesar el sistema mediante el uso de un computador
Carpeta de programas (diseño detallado):
  • Descripción detallista del programa
  • Diagrama de lógica
  • Descripción de entradas
  • Descripción de salidas
  • Descripción de archivos
  • Tablas, cuadros de control de consistencia y parámetros utilizados
  • Controles del programa sobre archivos y datos
Carpeta de operaciones:

  • Objetivos de la Documentación de Sistemas.
  • Tener un respaldo formal de la información
  • Crear una apreciación unitaria y conjunta del sistema
  • Facilitra el conocimiento, interpretación, comprensión y divulgación del sistema
  • Ser un elemento imprescindible para el control interno en general y del sistema en particular; proveer los antecedentes que permiten conocer como se ha diseñado el sistema y como debería estar operando, o sea facilita el parámetro de referencia contra el cual se analizará y/o enjuiciará su comportamiento real
  • Servir de base para auditar los sistemas de información
  • Eliminar los riesgos de dependencia con respecto a determinados individuos que conocen el sistema
  • Ser elemento fundamental para la adecuada capacitación de los usuarios del sistema y facilita la comunicación con los mismos
  • Proveer antecedentes esenciales, concretos y permanentes para evaluar eventuales modificaciones a sistemas en su funcionamiento y/o para decidir la sustitución de los mismos
  • Aumentar la seguridad y eficiencia en el mantenimiento de los sistemas y reduce su costo
  • Constituir el único medio idóneo de consulta general para poder tomar conocimiento actualizado de los sistemas en funcionamiento en la organización
  • Resultar imprescindible como elemento de juicio para la evaluación de sistemas stándars o programas producto susceptible de ser adquiridos
La documentación básica necesaria de un sistema de información deberá contar con:
  • Carpeta de papeles de trabajo (análisis):
  • Síntesis del documento de generación
  • Presupuesto o plan de fijación de tareas
  • Documentación del relevamiento detallado
  • Formularios o comprobantes analizados
  • Papeles de trabajo del análisis
  • Estudio de factibilidad y diagnósticoCarpeta de sistemas (diseño global):
  • Fijación de los objetivos del sistema
  • Descripción global del sistema
  • Modelo lógico del sistema (DFD, diccionario de datos, especificación de la lógica)
  • Diseño de entradas y salidas
  • Normas y procedimientos para los usuarios (en operaciones de rutina, de respaldo, de emergencia, de recupero, de uso de back-up)
  • Recursos materiales y humanos necesarios
  • Estudio técnico-económico acerca de la posibilidad de procesar el sistema mediante el uso de un computador

Carpeta de programas (diseño detallado):
  • Descripción detallista del programa
  • Diagrama de lógica
  • Descripción de entradas
  • Descripción de salidas
  • Descripción de archivos
  • Tablas, cuadros de control de consistencia y parámetros utilizados
  • Controles del programa sobre archivos y datos

Carpeta de operaciones:
  • Normas de control de entradas, salidas y de procesamientos
  • Normas de operación, de recupero, de back-up, de seguridad de archivos
  • Cronograma de procesos
  • Descripción de usuarios


Los elementos que conforman la documentación de los sistemas:

  • Normas de control de entradas,
  • Salidas y de procesamientos.
  • Normas de operación.
  • Back-up.
  • Seguridad de archivos
  • Cronograma de procesos
  • Descripción de usuarios

Los elementos que conforman la documentación de los sistemas:

Pueden ser categorizados como imprescindibles (aquellos que no pueden ser omitidos) y convencionales (aquellos que enriquecen los antecedentes documentales del sistema, pero su omisión no tendrá consecuencias irremediables).
Leer mas >>

UNIDAD III: ESTANDARES Y SIMBOLOS PARA LA DOCUMENTACIÓN DE SISTEMAS


Leer mas >>

UNIDAD IV: MANUALES

Manuales de Sistemas de Documentación

Los manuales del sistema juegan un papel importante en la implementación de sistemas ya que eliminan la necesidad de que el analista de sistemas se encuentre dedicado totalmente al soporte de usuarios y simplemente puede estar esperando por consultas que el usuario no pudo evacuar con la documentación que se le proporcionó.Generalmente, en la etapa de implementación, la mayoría de consultas se refieren al uso del sistema, lo cual debe estar claramente explicado en el manual de usuario.La documentación garantiza la continuidad del mantenimiento de las aplicaciones.

Se debe asignar un responsable de administrar la documentación, sobre todo de los sistemas generados internamente o por consultores externos, pero es importante que cada analista programador que da mantenimiento al sistema elabore y actualice, según sea el caso, la documentación pertinente siguiendo los estándares establecidos para tal fin.

Es importante que los símbolos convencionales se usen en todos los diagramas de flujo para prescribir el sistema y que en la documentación se usen formas estandarizadas. Al estandarizar la documentación del sistema, la organización logra varias ventajas tales como:

• Ayuda al entrenamiento del nuevo personal dentro y fuera de la organización de sistemas.
• Es útil para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.Ayuda a los analistas y diseñadores de sistemas en el trabajo de integración de sistemas.
• Asegura que el sistema opere correctamente.
• Se utilizan eficientemente los recursos que se dispongan.

Manual del Usuario.

Expone los procesos que el usuario puede realizar con el sistema implantado.Para lograr esto, es necesario que se detallen todas y cada una de las características que tienen los programas y la forma de acceder e introducir información. Reúne la información, normas y documentación necesaria para que el usuario conozca y utilice adecuadamente la aplicación desarrollada.




Objetivos del Manual del Usuario

• Que el usuario conozca cómo preparar los datos de entrada.
• Que el usuario aprenda a obtener los resultados y los datos de salida.
• Servir como manual de referencia y aprendizaje.
• Definir las funciones que debe realizar el usuario.
• Informar al usuario de la respuesta a cada mensaje de error.
• Definir los diferentes tipos de usuarios
• Definir los módulos en que cada usuario participará.

Importancia del Manual del Usuario
• Los documentos a los que se puede dar entrada por computadora.
• Los formatos de los documentos.
• Las operaciones que utiliza de entrada y salida de los datos.
• El orden del tratamiento de la computadora con los datos introducidos.
• El momento en que se debe solicitar una operación deseada.
• Los resultados de las operaciones realizadas a partir de los datos introducidos.

Contenido del Manual del Usuario

1. Diagrama general del sistema.
2. Diagrama particular detallado.
3. Explicación genérica de las Fases del Sistema.
4. Instalación del Sistema.
5. Iniciación al uso del Sistema.
6. Manual de Referencia.


Manual del Analista.

El manual del analista, también conocido como Manual Técnico juega un papel importante dentro del sistema debido a que luego de instalar el sistema y ponerlo en producción, se tiene la ardua tarea de darle mantenimiento para que el sistema continúe siendo operacional. Tomando en cuenta que las personas que dan mantenimiento al sistema no necesariamente son las mismas personas que lo desarrollaron, es necesario contar con una herramienta o el manual técnico que me permita aprender fácilmente como esta integrado el sistema desde el punto de vista técnico, presentando claramente cada uno de los procesos del sistemas y su interrelación para formar el sistema completo.

Además de indicar cada uno de los datos o información que se almacena en la base de datos del sistema, sus relaciones y las transformaciones que sufren los datos para convertirse en información.

Elementos que debe incluir el Manual del Analista

• El diagrama funcional de todo el sistema.
• La descripción de procesos detallando E-P-S.
• Diagramas de flujo de procesos y algoritmos del sistema.
• El diagrama Entidad-Relación.
• Estructura de datos y características físicas y lógicas de los archivos usados.
• Detalle de las condiciones especiales de ejecución tales como banderas, palabras claves, prerrequisitos, usos específicos de recursos.
• Descripción de interfases con otros sistemas o aplicaciones.
• Bitácora de cambios dentro de los mismos códigos fuentes que incluya el responsable del cambio, la fecha y la descripción del cambio.

Este manual debe ser actualizado constantemente inmediatamente después de hacer cualquier modificación (mantenimiento) al sistema; de tal manera que el próximo que lo consulte esté basado en una información real al momento de efectuar un nuevo cambio al sistema.

Manual de Operación.

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.

Contenido del Manual de Operación

El Manual de Instrucciones al Operador deberá incluir lo siguiente:

1. Instrucciones al Operador:
2. Descripción del Programa
3. Flujogramas Generales del Programa
4. Parámetros
5. Mensajes al Operador
6. Instrucciones para etiquetas de cintas de salida (“labels”)
7. Planes de Resguardo (“backups”)
8. “Command Procedures”
9. Instrucciones Especiales


Descripción del Programa

Incluirá descripción narrativa del programa y qué debe hacer el Operador antes y mientras ejecuta los programas del sistema.

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, 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.

Parámetros para ejecutar programas

Se deberá incluir una lista de todos los parámetros para ejecutar cada programa.

Mensajes al Operador

Indicará una lista detallada de todos los mensajes, tal como aparecen en la consola, las posibles contestaciones y el por qué de dichas respuestas. Esto se hará para cada programa.

Planes de Resguardo (“backups”)

Deberá incluir instrucciones específicas de los procedimientos a seguir para el mantenimiento de un resguardo (“backup”).

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.


Manual de Programación.

El objetivo de los manuales de programación es familiarizar a analistas y programadores con lo que hace cada programa en particular.

Los manuales de programación son una extensión 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 cumpla con las mismas. Cualquier cambio que surja como resultado de la programación, deberá ser expuesto y aceptado antes de aplicar el cambio.

Estos manuales deben ser técnicos, detallados y no necesitan estar escritos en una manera entendible al usuario.

Contenido de un Manual de Programación

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

• Nombre del Programa (código)
• Descripción
• Frecuencia de Procesamiento
• 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


Nombre del Programa
Indicará código que identifica el programa y el título del programa.

Descripción
Indicará la función que realiza el programador.

Fecha de Efectividad
Fecha a partir de la cual se comienza a ejecutar en producción la versión modificada o desarrollada del programa.

Archivo de Entrada (Librería/Definición DBD/Descripción de Archivo)

Archivos de Salida
Indicará el nombre y copia de la librería/DBD/Descripción de los archivos.

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.

Nombre del Programador
Deberá indicar el nombre del programador que escribió el programa o que efectuó el cambio, según sea el caso.

Fecha
Indicará fecha en que se escribió el programa o que se efectuó el cambio, según sea el caso.

Tablas
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.

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.

Lista de Datos de Prueba
Se incluirá una copia de los datos usados para prueba.

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.

Parámetros
Se acompañará una lista detallada de todos los parámetros para ejecutar el programa (JCL, “Command Procedures”, etc.)


Manual del Diseño.

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.

Contenido del Manual de Diseño 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.

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.

Flujograma
Se incluirá flujograma general del sistema, en el cual se identificarán los programas para usos, archivos e informes que componen el mismo.

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”)


Formato de Pantallas
Si el sistema es en línea, deberá incluir formato de las pantallas que serán utilizadas por el sistema.

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.)
* 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.
Leer mas >>