Professional Documents
Culture Documents
com
Documentación de sistemas
Indice
1. Introducción
2. Estandarizacion y normalizacion
3. Manual Administrativo
4. Manual De Usuario
5. Manual De Captacion
1. Introducció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.
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.
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:
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.
2. Estandarizacion y normalizacion
Estandarizacion
Significa que los símbolos convencionales se usan en todos los diagramas de flujo para prescribir el sistema
y que en la documentación se usen formas estandarizadas.
Aún cuando las normas de documentación varían de una instalación a otra, es esencial que dentro de una
organización, se utilice un solo método. 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 Estandarizacion
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.
Normalización
Asegúrese de que los estándares sean completos, actualizados, documentados y legibles.
Auditar permanentemente para que se cumplan los estándares.
Evaluar si los estándares establecidos son los requeridos y hacer los cambios necesarios para que dichos
estándares sean los apropiados.
3. Manual Administrativo
Sirve como punto de partida al Sistema propuesto, ya que será función de la gerencia, de acuerdo con los
usuarios de dicho Sistema, determinar silo expuesto en él satisface los requerimientos del propio sistema.
Una vez lograda la aprobación, se estará en condiciones de iniciar el desarrollo del Sistema propuesto e ir
integrando el resto de la documentación.
El manual tiene como finalidad el permitir a la alta gerencia tener la información necesaria y suficiente sobre
un sistema en particular y servir como fuente dc consulta una vez que el Sistema ha sido implantado.
Contenido
Nombre del sistema
Describir el nombre del sistema a implantar en la empresa.
Resumen Administrativo
Compendio de lo puntos que se describen en el manual, el cual tiene como propósito permitir a los altos
ejecutivos enterarse en forma somera de la propuesta del sistema. En este punto aparece por primera vez el
nombre del sistema, el cual debe ser único, este deberá conservarse invariable en todos los documentos
referentes a ese sistema.
Planteamiento
Este punto tiene como finalidad registrar los antecedentes que servirán de partida al desarrollo del análisis
del sistema. Se debe mencionar:
Dependencia que requirió el trabajo.
Personas y / o puestos ocupados por estas al momento de requerirse el trabajo (acuerdos, disposiciones
legales, memorandos, y otros)
Condiciones y criterios que normaron el desarrollo del trabajo.
Fechas correspondientes.
Ejemplo:
Módulo o
Nombre del Usuarios que manejan
Procedimiento donde Origen del documento
Documento Fuente el documento
entra el documento
Se recomienda utilizar diagrama de Grantt o de Pert para establecer el período de las actividades
requeridas para el desarrollo del sistema.
Ejemplo:
Escala del tiempo en semanas
Actividades a realizar
1 2 3 4
Presentación de la *****
Propuesta
Análisis *****
Costo / Beneficio
Adquisición del Equipo *****
Entrenamiento *****
4. 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.
Al elaborar el Manual de Usuario, hay que tener en cuenta a quién va dirigido es decir, el manual puede
ser manejado desde el director de la empresa hasta el introductor de datos. Por consiguiente, debe
redactarse de forma clara y sencilla para que lo entienda cualquier tipo de usuario.
Contenido
Diagrama general del sistema
Muestra en forma condensada el flujo general de la información y de las actividades que se realizan en el
sistema. Proporciona una visión general del sistema. Representar los diagramas utilizando para ello
diagramas de bloques.
Diagrama particular detallado.
Presentar gráficamente todos los pasos que se efectúen dentro del departamento usuario a quien está
dirigido este manual. Deben especificarse los archivos de entrada, salida, los resultados, revisiones y
procesos manuales.
Manual De Referencia
Es el documento definitivo de cara al usuario y debe ser completo. Describe con detalle las cualidades del
sistema y su uso, los informes de error generados y las situaciones en que surgen esos errores.
Dependiendo del sistema, los documentos al usuario se pueden proporcionar por separado o reunidos en
varios volúmenes. Los sistemas de ayuda en línea evitan que el usuario pierda tiempo en consultas
manuales.
5. Manual De Captacion
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.
Situaciones Anormales
Se presentan mensajes que se emiten al momento de la captura de los datos o cualquier condición fuera dc
lo normal. Ejemplo:
Entregas Al Computador
Establecer un calendario con fechas de entrega al computador, al igual que un horario para la obtención de
resultados.
El calendario determina marca cuándo las actividades deben llevarse a cabo dc manera que la gestión del
sistema no se vea afectado. Si es un sistema en línea no se requiere. Ejemplo:
Manual de operacion
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 ).