5.4 DOCUMENTACION DEL MANUAL DE OPERACION

Usuario

Permite tener una clara visión del proceso de Captación de los latos fuentes previo al procesamiento electrónico de los mismos.

Objetivos

• Documentar al usuario a cerca del recorrido a través de las pantallas del sistema.
• Conocer la forma cómo el usuario puede utilizar el equipo necesario para la ejecución del sistema.

Contenido

Diagrama General Del Sistema
Este diagrama debe ser presentado gráficamente y en forma sencilla. Representar los diagramas utilizando para ello diagramas de bloques ( es el mismo diagrama que se presenta en el Manual Administrativo).

Diagramas De Pantalla
Presentar en este punto el flujo del sistema en las pantallas utilizadas por cada módulo.
Puntos a documentar en una pantalla:

• Explicación del recorrido para llegar a la pantalla.
• Formato de los datos a captar.
• Formato en que son captados los datos.
• Explicación Genérica de las fases del sistema.- Es una explicación clara, breve de todos los módulos que se presentan en el diagrama general.
• Equipo Utilizado Para La Captación.-Se debe crear un instructivo que permita al usuario el entrenamiento del sistema.

Tecnico

Objetivo
Contiene la información que permite al personal de operación utilizar en forma eficiente la operación de los sistemas de procesamiento electrónico.

Contenido

Diagrama general del sistema
Este diagrama debe ser presentado gráficamente y en forma sencilla. Representar los diagramas utilizando para ello diagramas de bloques (es el mismo diagrama que se presenta en el Manual Administrativo ).

Diagrama general del flujo del proceso electrónico.
Se representa en este diagrama todo el ambiente periférico que interactúa en el sistema en cuanto a: entradas manuales, medios magnéticos y dispositivos de salida. La simbología a utilizar debe ser establecida como estándar. (Ejemplos: cintas, discos, disquetes).

Explicación Genérica De Las Fases Del Sistema
Es una explicación clara, breve de todos los módulos que se presentan en el Diagrama general descrito anteriormente.

Diagrama De Pantallas Del Sistema.-Se presenta en este punto el flujo del sistema en las pantallas utilizadas por cada módulo.Puntos a documentar en una pantalla:Explicación del recorrido en pantalla.

5.3 DOCUMENTACION DEL MANUAL DE USUARIO

El manual de 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. Permite a los usuarios conocer el detalle de qué actividades ellos deberán desarrollar para la consecución de los objetivos del sistema. Reúne la información, normas y documentación necesaria para que el usuario conozca y utilice adecuadamente la aplicación desarrollada.

Objetivos

• 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 aprendizaje.
• Servir como manual de referencia.
• Definir las funciones que debe realizar el usuario.Informar al usuario de la respuesta a cada mensaje de error.
  

Pasos a seguir para definir como desarrollar el manual de usuario.

Identificar los usuarios del sistema: personal que se relacionará con el sistema.

Definir los diferentes tipo de usuarios: se presentan los diferentes tipos de usuarios que usarían el sistema.

Ejemplo: usuarios directos, indirectos.Definir los módulos en que cada usuario participará: Se describen los módulos o procesos que se ejecutarán por cada usuario en forma narrativa breve y clara.

5.2 DOCUMENTACION GENERAL DEL SISTEMA

INTRODUCCION

La documentación general 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 auditorias del sistema y para enseñar a los usuarios como interactuar con el sistema.

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 usuario en forma general, la naturaleza y las capacidades del sistema.

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.

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.

IMPORTANCIA DE LA DOCUMENTACION 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.

LA DOCUMENTACION

Con el fin de estandarizar el alcance de la documentación referente a un sistema, se sugiere tener la siguiente documentación antes de poner en producción cualquier producto.

Análisis conceptual

Identificación inicial de las necesidades y los principales requerimientos. Justificación del desarrollo de un sistema automatizado. Diagrama de flujo de datos a primer nivel. Áreas involucradas. Funciones principales.

Diseño conceptual

Módulos que forman el sistema. Funciones por cada módulo. Responsables del diseño. Información general de cada función. Índice detallado de cada función autorizada. Estrategia a seguir para la entrega de productos, prioridades y autorizaciones de usuario.

Diseño funcional

Descripción detallada de toda función involucrada con su respectiva documentación de: Responsable, periodicidad, reportes, pantallas, principales entradas/salidas y sobre todo una narrativa autorizada de cada función con el Vo.Bo. del usuario responsable. La narrativa no deberá contemplar lógica difícil de entender y mucho menos tener tendencias procedimentales de lenguaje de programación.

Diseño detallado

Especificación detallada de todo programa, indicando la función a la que corresponde. Deberá tener una autorización por programa del "gerente de informática" responsable del proyecto. Esta etapa por ningún motivo deberá evitarse.

Programas y salidas de los mismos

Menús de donde se llamarán los programas. Índice de programas, indicando función que realizan. Listado ejemplo de reportes obtenidos. Proporción mínima de una línea de comentarios por cada 10 de código. Narrativa clara que mencione al (los) programador(es), objetivos del programa, detalle de las actualizaciones que realiza y relación de las modificaciones.

Diagramas entidad - relación por cada módulo

Descripción de la infraestructura de desarrollo

Rutinas comunes

Entradas/salidas, nombre, ubicación, lenguaje, parámetros, indicando programas que los llaman o que están insertadas en los programas.

Parámetros del módulo

Indicar que parámetros son cambiables fácilmente, tablas de parámetros, características de usuarios, posibles valores y que aplicaciones o programas utilizan ese parámetro.

Arquitectura

Diagrama de todo módulo en cuestión, que indique las llamadas que hace cada programa, indicando función, rutinas comunes, objetivo del programa y lenguaje, y el ambiente en que es ejecutado.

Documentación de procesos especiales

Cualquier procedimiento que saliera de lo convencional, indicando donde es ejecutado, parámetros que recibe o entrega, lenguaje de programación y la arquitectura clara y actualizada en que se diseñó.

Relación de errores

Índice de errores que se monitorean con su número, causa y solución posible.

Bitácoras

Principales problemas técnicos durante la construcción, solución otorgada y solución ideal

Lista de requerimientos solicitados no otorgados y la razón

Relación de elementos sujetos a optimización y condiciones que deberán existir

Manuales de usuarios

Información de la base de datos

Diagramas entidad-relación de cada sistema, indicando la integridad referencial. Objetivo de cada entidad. Descripción de cada columna y posibles valores y validaciones.

Matriz de requerimientos para la liberación de un sistema

Descripción de un sistema

• Carátula del proyecto
• Diagrama de flujo
• Diagrama conceptual
• Diagrama relación-entidad

Estructura del sistema

• Relación de menús con opciones
• Inventario de equipo requerido
• Nivel de usuarios
• Seguridad

Instructivo de operación

• Guías de las interfases del sistema
• Instructivo de procesos para soporte técnico

Reportes

• Relación de reportes (distribución, volumen aproximado, tipo de formas utilizadas y consumos)
• Catálogo de reportes

Tablas del sistema

• Relación de tablas utilizadas
• Tablas vs. programas

Programas

• Inventario de programas
• Matriz programas vs. procedimientos
• matriz programas vs. archivos

Procedimientos

• Inventario de procedimientos
• Matriz procedimientos vs. programas
• Matriz procedimientos vs. archivos

Archivos

• Matriz directorio de datos vs. archivos
• Matriz de archivos físicos vs. lógicos
• Formatos

Normas de ejecución

• Procesos diarios
• Procesos mensuales
• Procesos anuales
• Procesos especiales

Procedimientos de backup, restore, depuración y reorganización de información

Plan de contingencia

Información adicional

• Políticas y procedimientos administrativos
  

5.1 METODOLOGIA PARA LA DOCUMENTACION DE SISTEMAS

1. La necesidad de los diagramas
Los diagramas o representaciones gráficas representan una parte fundamental en el desarrollo de sistemas. En general, se utilizan para definir las especificaciones de un programa y representar el diseño de los sistemas (programas). Proporcionan el proyecto original para la implantación del diseño en código y además son partes esenciales para la documentación del sistema y posteriormente para su mantenimiento.

Los diagramas claros son una parte fundamental en el diseño de sistemas y en el desarrollo de programas durante el ciclo de vida del software. Una técnica de diagramación pobre puede provocar la inhibición en el razonamiento, en cambio, una buena puede acelerar el trabajo y aumentar la calidad de los resultados. Por ejemplo, si sólo hay una persona que desarrolla el diseño de un sistema o de un programa, los diagramas ayudarán al razonamiento claro. Cuando hay varias personas que participan en el desarrollo del sistema los diagramas son una poderosa herramienta esencial para la comunicación y el desarrollo del sistema.

Con una técnica de diagramación formal, los desarrolladores tendrán la posibilidad de intercambiar ideas y podrán reunir con precisión los distintos componentes del sistema. Una de las características con que deben contar los diagramas es con el uso de una simbología estandarizada para facilitar la comunicación y evitar las confusiones que puedan conducir a un error dentro del desarrollo del sistema por parte del equipo de trabajo.

En cuanto a la fase de mantenimiento en el ciclo de vida del software, los diagramas son herramientas valiosas para saber por parte del equipo de programación cómo funciona el sistema, además de que permite localizar el origen de los errores y el impacto de las posibles modificaciones que se hagan al sistema. Como se sabe, después de un periodo transcurrido esto es lo que va desgastando al software.

En términos generales, podemos decir que los diagramas forman un lenguaje que permite el modelado del software, debido a que proporcionan una forma de representación concisa y sin ambigüedades. Además, forman una parte fundamental en el ciclo de vida del software; más específicamente en la etapa de documentación del sistema, sin olvidar que son esenciales para el análisis y el diseño de software.

2. Requisitos de documentación
Una buena documentación de un sistema informático, incluyendo los programas, es un componente de lo que se conoce como filosofía estructurada. De lo anterior, una buena documentación cumple con los siguientes puntos:

♦ Proporciona una visión de alto nivel del sistema (programa), explicando su propósito y las relaciones entre los diversos componentes (datos y procedimientos).

♦ Mejora la comprensión de los sistemas y, en general, del software producido.

♦ Describe detalladamente los componentes de los datos y procedimientos que forman el sistema.

♦ Es fácil y poco costosa de realizar y actualizar, y existe la posibilidad de producirse automáticamente.

♦ Proporciona una forma de representar los requerimientos de diseño de un sistema y del traslado del diseño al código de programa.

3. Importancia de la visión en los diagramas
Las técnicas de diagramación se utilizan para dar una visión de alto nivel y detallada de un sistema. Una de las cualidades es que permiten la localización exacta de un error fácilmente; si una persona deseara determinar en cuál de varios programas se realiza una determina función, una visión de alto nivel será la mejor ayuda.

Para representar un sistema completo se necesita un diagrama de estructura de datos de alto nivel y otro detallado del sistema. La visión estructurada del sistema identifica los componentes del proceso y las relaciones entre ellos mostrando el flujo de datos, el flujo de control, así como el tiempo y la secuencia de la información. La visión de la estructura de datos describe principalmente las entidades y atributos, así como sus posibles relaciones o asociaciones. La importancia de ambas visiones radica en que los ingenieros pueden ver cómo los datos se derivan o utilizan en un determinado proceso.
Existe varias técnicas de diagramación (estructurada), pero los tres tipos de diagramas fundamentales para representar un sistema informático son:
Diagrama de flujo de datos (DFD): Un diagrama conocido y utilizado durante el análisis para definir los componentes del problema (sistema) y diseñar un primer esbozo de los componentes del programa y del paso de datos entre ellos. Describe la transformación que los datos experimentan en su flujo a través del sistema.
Diagramas de los modelos de datos: Un diagrama utilizado durante el proceso de modelado de los datos para representar los registros y entidades de los datos y las asociaciones lógicas entre ellos.
Diagrama de estructura de árbol: Un diagrama jerárquico creado durante un diseño del sistema para definir la arquitectura global del sistema para mostrar los programas y las relaciones entre ellos.

4. Tipos de metodologías
Entre los tres tipos de metodologías más utilizados están la de Yourdon, De Marco y la de Gane-Searson, las cuales están basadas en los siguientes conceptos:

♦ Usan la organización jerarquizada descendente, por medio de la descomposición funcional para definir los requerimientos del sistema.

♦ Herramientas gráficas de comunicación y documentación.

TEMARIO DE LA UNIDAD 5

5. METODOLOGIA PARA LA DOCUMENTACION DE SISTEMAS

5.1 METODOLOGIA PARA LA DOCUMENTACION DE SISTEMAS

5.2 DOCUMENTACION GENERAL DEL SISTEMA

5.3 DOCUMENTACION DEL MANUAL DE USUARIO

5.4 DOCUMENTACION DEL MANUAL DE OPERACION

• USUARIO
• TECNICO