Documentacin

de Sistemas

Ing. Alicia Baldovinos del

Rio
Introduccin

La documentacin de sistemas es el conjunto de informacin que nos dice qu hacen los sistemas, cmo lo hacen y para
quin lo hacen.
La documentacin consiste en material que explica las caractersticas tcnicas y la operacin 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 ensear a los usuarios como interactuar con el sistema y a los operandos como hacerlo funcionar.
Existen varios tipos de documentacin. La de programas, que explica la lgica 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 cmo usarlo.
Muchas organizaciones tienen lo que se conoce como un "programa de documentacin", el cual consiste en una poltica
formal cuya documentacin se muestra como algo que debe prepararse en forma rutinaria para cada programa de
cmputo, archivo y nuevos sistemas.
Otra definicin sera la de registro fsico, generalmente por escrito que contiene los siguientes elementos:
Polticas y normas referentes al desarrollo del sistema, su implantacin, operacin y mantenimiento.
El diseo del sistema de informacin administrativo.
Procedimientos para instalar el sistema de informacin administrativo.
Procedimientos para operar el sistema de informacin administrativo.
Procedimientos para mantener el sistema de informacin administrativo.
 Importancia De La Documentacin De Sistemas
La importancia de la documentacin bien podra ser comparada con la
importancia de la existencia de una Pliza de Seguro; mientras todo va bien no
existe la precaucin de confirmar si nuestra Pliza de Seguros est o no vigente.
La documentacin adecuada y completa, de una aplicacin que se desea
implantar, mantener y actualizar en forma satisfactoria, es esencial en cualquier
Sistema de Informacin, sin embargo, frecuentemente es la parte a la cual se
dedica l menor tiempo y se le presta menos atencin.
Siempre se debe documentar un sistema como si estuviera a punto de irse a
Siberia el siguiente mes, para nunca volver. Si la documentacin del sistema es
incompleta el diseador continuamente estar involucrado y no podr moverse
a otra asignacin.
Estandarizacion y normalizacion

Estandarizacion
Significa que los smbolos convencionales se usan en todos los diagramas de flujo para prescribir el sistema y que en la documentacin se
usen formas estandarizadas.
An cuando las normas de documentacin varan de una instalacin a otra, es esencial que dentro de una organizacin, se utilice un solo
mtodo. El uso de procedimientos y documentacin estandarizada proporciona la base de una comunicacin clara y rpida, adiestramiento
menos costoso del personal de sistemas, reduccin de costos de almacenamiento, y otros.
Ventajas De La Estandarizacion
Ayuda al entrenamiento del nuevo personal dentro y fuera de la organizacin de Sistemas.
Es til para cualquiera que tenga la responsabilidad del mantenimiento de los sistemas.
Ayuda a los analistas y diseadores de sistemas en el trabajo de integracin de sistemas.
Asegura que el sistema opere correctamente.
Se utilizan eficientemente los recursos que se dispongan.
Estandares Bsicos De Documentacin
Toda documentacin que se relacione con un sistema, ya sea manual o por computadora, sencillo o complejo debe reunir los siguientes
requisitos bsicos:
Debe ser rotulada con claridad y bien organizada, con secciones claramente indicadas, almacenarlas en carpetas e ndice.
Los diagramas debern ser claros, no aglomerados y la escritura manuscrita deber ser legible.
La documentacin deber ser completa.
Se incluir una leyenda o explicacin de los trminos utilizados.
La documentacin siempre se conserva actualizada.
 Normalizacin
Asegrese de que los estndares sean completos, actualizados, documentados y legibles.
Auditar permanentemente para que se cumplan los estndares.
Evaluar si los estndares establecidos son los requeridos y hacer los cambios necesarios para que dichos estndares sean los apropiados.
Teoria General De Los Manuales De Documentacin
Durante el desarrollo de un sistema, desde su concepcin hasta su puesta en marcha se ha generado gran cantidad de documentos, que
en muchas ocasiones se han visto modificados por documentos posteriores debido a cambios en el sistema.
Para evitar confusiones en las revisiones de la documentacin se desarrollan diferentes tipos de documentos dirigidos a las personas que
trabajarn con el sistema y para facilitar el mantenimiento del mismo. La documentacin de un sistema debe ser marcada
adecuadamente, bien organizada actualizada y completa; todos los trminos utilizados deben explicarse. La documentacin se har
disponible a todos los usuarios dc acuerdo a sus necesidades.
El estilo de redaccin de los manuales de documentacin debe ser:
Concreto.
Ser preciso y definir los trminos utilizados.
Utilizar prrafos cortos.
Utilizar ttulos y subttulos.
Utilizar formas activas en lugar de pasivas.
No emplear frases largas que presenten hechos distintos.
No hacer referencia a una informacin solamente con el nmero de referencia
Manual Administrativo

Sirve como punto de partida al Sistema propuesto, ya que ser funcin 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 aprobacin, se estar en condiciones de iniciar el desarrollo del Sistema propuesto e ir integrando el resto de la
documentacin.
El manual tiene como finalidad el permitir a la alta gerencia tener la informacin 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.
Equipo Encargado Del Sistema
Nombre del personal encargado del anlisis y diseo del sistema.
Resumen Administrativo
Compendio de lo puntos que se describen en el manual, el cual tiene como propsito 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 servirn de partida al desarrollo del anlisis
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.
Objetivos Del Sistema
Aqu se dejarn establecidos los objetivos que debe cubrir el sistema, en forma clara y precisa para evitar
errores de interpretacin.
Entradas Del Sistema (Informacin A Captar)
Debe quedar especificado en este punto, los documentos fuentes que inician las operaciones del sistema
as como la informacin detallada de aquellos conceptos que sern los datos a captar por el sistema. Se
debern mencionar todos los datos que en forma secundaria originan una entrada importante al sistema.
 Ejemplo:
Mdulo o
Nombre del Usuarios que
Procedimiento Origen del
Documento manejan el
donde entra el documento
Fuente documento
documento
Salidas Del Sistema (Resultados A Obtener)
En este punto, solamente se describirn los resultados de
mayor importancia obtenidos a travs de todo el proceso. En
esta seccin se debe dar mayor nfasis a la informacin que el
sistema proporciona cuidando de no hacer tan slo mencin de
los resultados a obtener.
 Ejemplo:
Nombre de la Periodicidad en Usuarios que lo
Destino
salida que se genera requieren

Diagramacion General Del Sistema

Es la representacin grfica de las fases del Sistema y su flujo a
travs de las dependencias que intervienen en el mismo,
aunque en forma generalizada. La tcnica a utilizar y la
simbologa debe ser seleccionada por los interesados.
 Explicaciones De Las Fases Del Sistema
Este punto se encuentra relacionado con el anterior ya que lo que se muestra grficamente, ahora
se describe en forma genrica, explicando los procesos que se llevan a cabo en cada dependencia
sin profundizar en detalles tcnicos o especficos. Se deber resaltar aquellas fases del proceso en
las cules se obtengan resultados de importancia as como aquellas que requieran una
supervisin especial.
Requerimientos Del Sistema
Se establecen los recursos, tanto humanos como materiales que son necesarios para poder llevar
a cabo el sistema. Presentar costos y descripcin, adems de las cantidades que se requieran.
Estimacin De La Fecha Probable De Implementacion Del Sistema
Es necesario que exista una fecha probable de implantacin cuya base ser la terminacin de
todas las actividades para la creacin del sistema, tales como: anlisis, programacin, elaboracin
de formas, y otros.
Se recomienda utilizar diagrama de Grantt o de Pert para establecer el perodo de las actividades
requeridas para el desarrollo del sistema.
 Ejemplo:
Escala del tiempo en semanas
Actividades a
realizar 1 2 3 4
Presentacin de *****
la Propuesta
Anlisis *****
Costo / Beneficio
Adquisicin del *****
Equipo
Entrenamiento *****
 Consideraciones Generales Del Nuevo Sistema
En este punto se deber sealar las ventajas, desventajas, y
principales diferencias del nuevo sistema con el anterior, tales
cmo seguridad, disminucin de costo, ahorro de tiempo,
flexibilidad, confiabilidad y otros. Adems, desarrollar en
cualquier aspecto de la propuesta del sistema que no file
considerado en el desarrollo de los puntos antes mencionados.
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 caractersticas que tienen los
programas y la forma de acceder e introducir informacin.
Permite a los usuarios conocer el detalle de qu actividades
ellos debern desarrollar para la consecucin de los objetivos
del sistema. Rene la informacin, normas y documentacin
necesaria para que el usuario conozca y utilice adecuadamente
la aplicacin desarrollada.
 Objetivos
Que el usuario conozca cmo 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
usaran el sistema. Ejemplo: usuarios directos, indirectos.
Definir los mdulos en que cada usuario participar: Se describen los mdulos o
procesos que se ejecutarn por cada usuario en forma narrativa breve y clara.
 Importancia Del Manual De Usuario
El Manual de Usuario facilita el conocimiento de:
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 operacin deseada.
Los resultados de las operaciones realizadas a partir de los datos introducidos.
Al elaborar el Manual de Usuario, hay que tener en cuenta a quin 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 informacin y de las actividades que se realizan en el
sistema. Proporciona una visin general del sistema. Representar los diagramas utilizando para ello diagramas de
bloques.
Diagrama particular detallado.
Presentar grficamente todos los pasos que se efecten dentro del departamento usuario a quien est dirigido
este manual. Deben especificarse los archivos de entrada, salida, los resultados, revisiones y procesos manuales.
Explicacin Genrica De Las Fases Del Sistema
En este punto se explica en forma especfica y detallada todas las operaciones que aparecen representadas en
forma grfica en el diagrama particular. Se analizan cada una de las fases sealando:
El proceso principal que se desarrolla.
La entrada de la informacin.
La obtencin de un resultado parcial.
El envo de informacin a otra dependencia.
 Instalacin Del Sistema
La instalacin del sistema proporciona detalles completos sobre la forma de instalar el sistema en un
ambiente particular.
Iniciacin Al Uso Del Sistema
En este punto se explica cmo iniciarse en el sistema y cmo se pueden utilizar sus cualidades comunes.
Esta documentacin debe decir al usuario cmo salir de un problema cuando las cosas funcionan mal.
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 volmenes. Los sistemas de ayuda en lnea evitan que el usuario pierda tiempo en consultas
manuales.
Caducidad De Documento Fuente Y Destino Final
Como el usuario trabajar con documentos fuentes, stos podrn tener un perodo de retencin y un
destino especificado.
Manual De Captacion

Permite tener una clara visin del proceso de Captacin de los latos fuentes
previo al procesamiento electrnico de los mismos.
Objetivos
Documentar al usuario a cerca del recorrido a travs de las pantallas del sistema.
Conocer la forma cmo el usuario puede utilizar el equipo necesario para la
ejecucin del sistema.
Contenido
Diagrama General Del Sistema
Este diagrama debe ser presentado grficamente 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 mdulo.
Puntos a documentar en una pantalla:
Explicacin del recorrido para llegar a la pantalla.
Formato de los datos a captar.
Formato en que son captados los datos.
Explicacin Genrica De Las Fases Del Sistema
Es una explicacin clara, breve de todos los mdulos que se presentan en el diagrama general.
Equipo Utilizado Para La Captacin
Se debe crear un instructivo que permita al usuario el entrenamiento del sistema.
Debe contener los siguientes puntos:
Uso del equipo:
Describir detalladamente el uso correcto del equipo utilizado para la captacin de la informacin,
dando una explicacin del encendido, manejo, control y del material que se usa como medio de
captacin de los datos.
 Entrenamiento del Software de la aplicacin:
Explicacin del software utilizado en complemento al sistema.
Ejemplo: como entrar y salir del sistema.
Situaciones Anormales
Se presentan mensajes que se emiten al momento de la captura
de los datos o cualquier condicin fuera dc lo normal. Ejemplo:

Situacin
Mensaje Causas Soluciones
anormal
 Entregas Al Computador
Establecer un calendario con fechas de entrega al computador,
al igual que un horario para la obtencin de resultados.
El calendario determina marca cundo las actividades deben
llevarse a cabo dc manera que la gestin del sistema no se vea
afectado. Si es un sistema en lnea no se requiere. Ejemplo:

Operacin Frecuencia Objetivo Hora de Entrada Hora de

salida
Solicitud Semanal Actualizar Antes de las 2:00 3:00 p.m.
de reporte Mensual informe del p.m.
departament
oX
 Caducidad De Documentos Fuentes
Establecer por escrito la fecha de caducidad de los documentos fuentes, el fin a que han
de destinarse ya sea para su destruccin, devolucin o conservacin en un archivo.
Manual de operacin
Objetivo
Contiene la informacin que permite al personal de operacin utilizar en forma eficiente
la operacin de los sistemas de procesamiento electrnico.
Contenido
Diagrama general del sistema
Este diagrama debe ser presentado grficamente 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 electrnico.
Se representa en este diagrama todo el ambiente perifrico que interacta en el sistema en cuanto a:
entradas manuales, medios magnticos y dispositivos de salida. La simbologa a utilizar debe ser
establecida como estndar. (Ejemplos: cintas, discos, disquetes).
Explicacin Genrica De Las Fases Del Sistema
Es una explicacin clara, breve de todos los mdulos 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 mdulo.
Puntos a documentar en una pantalla:
Explicacin del recorrido en pantalla.
Formato en que son captados los datos.
Instruciwo De Operacin Por Programa
Se debe desarrollar por cada programa dcl sistema. Incluye:
Diagrama electrnico del programa.