Documentacin de un Sistema

Michelle Brenes

Documentacin
La documentacin es un conjunto de elementos registrados sobre cualquier soporte que permita instruir o informar acerca de algo, en funcin de las necesidades especficas de aquellos que la utilizan.

Importancia:
Constituye el respaldo formal de la informacin Es el elemento integrador que permite la apreciacin unitaria y conjunta del sistema Facilita el conocimiento, interpretacin, comprensin y divulgacin del sistema Constituye un elemento imprescindible para el control interno en general y del sistema en particular; facilita el parmetro de referencia contra el cual se analizar y/o enjuiciar su comportamiento real Elimina los riesgos de dependencia con respecto a determinados individuos que conocen el sistema Es un elemento fundamental para la adecuada capacitacin de los usuarios del sistema y facilita la comunicacin con los mismos

Modelos de formularios utilizados para documentar los sistemas de informacin:

Hoja de diseo de archivos o registros ndice de archivos Hoja de diagramacin Hoja de diseo de salidas impresas y/o formularios Hoja de diseo de formatos de pantalla Hoja de programacin ndice de programas Tabla de decisiones y/o alternativas Hoja de especificaciones del programa

La documentacin bsica necesaria de un sistema de informacin deber contar con:

Carpeta de papeles de trabajo (anlisis):

Sntesis del documento de generacin Presupuesto o plan de fijacin de tareas Documentacin del relevamiento detallado Formularios o comprobantes analizados Papeles de trabajo del anlisis Estudio de factibilidad y diagnstico

Carpeta de sistemas (diseo global):

Fijacin de los objetivos del sistema Descripcin global del sistema Modelo lgico del sistema (DFD, diccionario de datos, especificacin de la lgica) Diseo 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 tcnico-econmico acerca de la posibilidad de procesar el sistema mediante el uso de un computador

Carpeta de programas (diseo detallado):

Descripcin detallista del programa Diagrama de lgica Descripcin de entradas Descripcin de salidas Descripcin de archivos Tablas, cuadros de control de consistencia y parmetros utilizados Controles del programa sobre archivos y datos

Carpeta de operaciones:
Normas de control de entradas, salidas y de procesamientos Normas de operacin, de recupero, de backup, de seguridad de archivos Cronograma de procesos Descripcin de usuarios

Impredecibles

aquellos que no pueden ser omitidos

Los elementos que conforman la documentacin de los sistemas, pueden ser categorizados como:

Convencionales

Aquellos que enriquecen los antecedentes documentales del sistema Su omisin no tendr consecuencias irremediables

Programas documentadores:
Se puede documentar con procesadores de texto Un programa que se puede utilizar para disear y/o documentar es el Erwin. Un programa exclusivo para hacer o documentar manuales de usuarios es el Help Workshop Otra manera de documentar la instalacin y manejo de una aplicacin es generando archivos en formato HTML (como una pgina Web).