DOCUMENTACION DE SISTEMAS

DOCUMENTACION DE SISTEMAS
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.
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, Procedimientos para instalar el sistema
de informacin, Procedimientos para operar el sistema de informacin,
Procedimientos para mantener el sistema de informacin.

Caractersticas que deben cumplir los Sistemas de Documentacin.-

- Deben ser aprobados, firmados y fechados por las personas apropiadas y
autorizadas, ningn documento puede ser cambiado sin autorizacin.
- El contenido de los mismos no puede ser ambiguo, el ttulo, tipo y propsito
deben estar establecidos claramente.
- Deben ser legibles.
- Sencillez, definir las especificaciones de todos los materiales, procesos
tecnolgicos, control y de las actividades relacionadas con la investigacin.
- Seguridad, evitar errores.
- Eficiencia y efectividad, asegurar que todo el personal relacionado con la
investigacin sepa qu hacer y cundo hacerlo.
- Los documentos deben estar donde se les necesita, usarse por lo quien los
requiere sin modificaciones no autorizadas, y ser llenados veraz y
oportunamente.

Importancia.-

Un sistema bien documentado, es necesario para las nuevas personas
interesadas en aprender sobre el sistema y sirve como recordatorio para
aquellas que usan el sistema con poca frecuencia.
Una documentacin consistente y bien conservada, nos traer como ventaja;
acortar la cantidad de horas o tiempo requerido por nuevas personas para
aprender el sistema antes de realizar el mantenimiento.
La documentacin de sistemas permite a usuarios, programadores, analistas
y otros expertos ver el sistema, su software y procedimientos sin tener que
interactuar con l.

Tcnicas de Documentacin de Sistemas.-
No hay un solo estndar de tcnica de diseo y documentacin actualmente
en uso, a continuacin se presentarn, de forma general, ciertas tcnicas que
estn en uso.

Pseudocdigo
El pseudocdigo describe un algoritmo utilizando una mezcla de frases en
lenguaje comn, instrucciones de programacin y palabras clave que definen
las estructuras bsicas.
Puede ser utilizado como un paso intermedio para el desarrollo de cdigo
de programa.
Es apreciado naturalmente por los programadores.



Mtodo de folklore
Es una tcnica de documentacin de sistemas, creada para complementar
otras tcnicas existentes. Muchos de los sistemas se documentan
inadecuadamente o no se documentan en absoluto. El mtodo del folklore
recopila informacin que normalmente se comparte entre los usuarios pero
que raramente se ponen por escrito.
Este enfoque requiere que el analista entreviste a los usuarios, investigue la
documentacin existente en los archivos y observe el procedimiento de
informacin. El objetivo es recopilar la informacin correspondiente a una de
las 4 categoras siguientes: costumbres, ancdotas, proverbios y formas
artsticas.
Costumbres: al documentar las costumbres el analista intenta capturar por
escrito lo que los usuarios hacen para conseguir que los programas puedan
ejecutarse sin problemas.
Ejemplo: normalmente nos tarda 2 das actualizar los registros mensuales
por que la tarea es bastante grande. Ejecutamos cuentas comerciales en un
da y guardamos las otras para el siguiente da.
Ancdotas: Son las historias que los usuarios dicen respecto a cmo funciono
el sistema. Por supuesto la exactitud de la ancdota depende de la memoria
del usuario y es en el mejor de los casos una opinin sobre como funciono el
programa.
Ejemplo: El problema ocurri de nuevo en 1995, esa vez, el trabajo LIB409
(actualizacin mensual). Solo se ejecut con los registros tipo 6. Debido a
este error, no haba registros financieros en el archivo LIBFIN. Cuando
intentamos leer el archivo vaco, este inmediatamente se cerraba y por
consiguiente los totales se reportaron en cero, pudimos corregir este
problema agregando un registro tipo 7 y ejecutando el trabajo.
Las ancdotas generalmente tienen un principio (la historia sobre el
problema), el cuerpo (descripcin de los efectos) y el fin (la solucin).

Los proverbios: son declaraciones que representan generalizaciones o
consejos. A los usuarios les gusta dar consejos y el analista debe intentan
capturar dichos consejos e incluirlos en la documentacin de folklore.
Ejemplo: haga frecuentemente copias de seguridad.
Formas artsticas: Los diagramas de flujo, diagramas y tablas que los usuarios
disean algunas veces podran ser mejores o ms tiles que los diseados por
el autor del sistema original.

Seleccin de una Tcnica de Documentacin.-
Los siguientes son un grupo de lineamientos para ayudar al analista a
seleccionar una tcnica adecuada.
Sea compatible con la documentacin existente.
Sea comprendida por los dems de la organizacin.
Permita que se regrese al trabajo sobre un sistema despus de que se
haya estado retirado de el por un tiempo.
Sea adecuada para el tamao del sistema en que se est trabajando.
Permita fcil modificacin.

Manuales de Sistemas de Documentacin.-

Los manuales del sistema juegan un papel importante en la implementacin
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
documentacin que se le proporcion.


Generalmente, en la etapa de implementacin, la mayora de consultas se
refieren al uso del sistema, lo cual debe estar claramente explicado en el
manual de usuario. La documentacin garantiza la continuidad del
mantenimiento de las aplicaciones.

Al estandarizar la documentacin del sistema, la organizacin logra varias
ventajas tales como:
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.
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
caractersticas que tienen los programas y la forma de acceder e introducir
informacin. Rene la informacin, normas y documentacin necesaria para
que el usuario conozca y utilice adecuadamente la aplicacin desarrollada.

Objetivos del Manual del Usuario
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 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 mdulos en que cada usuario participar.

Importancia del Manual del Usuario
Los documentos a los que se pueden 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.

Contenido del Manual del Usuario
1. Diagrama general del sistema.
2. Diagrama particular detallado.
3. Explicacin genrica de las Fases del Sistema.
4. Instalacin del Sistema.
5. Iniciacin al uso del Sistema.
6. Manual de Referencia.

Manual del Analista.-
El manual del analista, tambin conocido como Manual Tcnico juega un
papel importante dentro del sistema debido a que luego de instalar el
sistema y ponerlo en produccin, se tiene la ardua tarea de darle
mantenimiento para que el sistema contine 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 tcnico que me permita aprender
fcilmente como est integrado el sistema desde el punto de vista tcnico,
presentando claramente cada uno de los procesos del sistemas y su
interrelacin para formar el sistema completo.

Adems de indicar cada uno de los datos o informacin que se almacena en
la base de datos del sistema, sus relaciones y las transformaciones que sufren
los datos para convertirse en informacin.

Elementos que debe incluir el Manual del Analista

El diagrama funcional de todo el sistema. La descripcin de procesos
detallando E-P-S. Diagramas de flujo de procesos y algoritmos del sistema. El
diagrama Entidad-Relacin. Estructura de datos y caractersticas fsicas y
lgicas de los archivos usados. Detalle de las condiciones especiales de
ejecucin tales como banderas, palabras claves, prerrequisitos, usos
especficos de recursos.
Descripcin de interfaces con otros sistemas o aplicaciones.
Bitcora de cambios dentro de los mismos cdigos fuentes que incluya el
responsable del cambio, la fecha y la descripcin del cambio.

Este manual debe ser actualizado constantemente inmediatamente despus
de hacer cualquier modificacin (mantenimiento) al sistema; de tal manera
que el prximo que lo consulte est basado en una informacin real al
momento de efectuar un nuevo cambio al sistema.

Manual de Operacin.-
El Manual de Instrucciones al Operador proveer instrucciones de cmo
correr el sistema. El analista deber trabajar en conjunto con las
especificaciones funcionales, diseo del sistema y documentacin 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 Operacin

El Manual de Instrucciones al Operador deber incluir lo siguiente:
Instrucciones al Operador:
Descripcin del Programa
Flujogramas Generales del Programa
Parmetros
Mensajes al Operador
Instrucciones para etiquetas de cintas de salida (labels)
Planes de Resguardo (backups)
Instrucciones Especiales

Manual de Programacin.-
El objetivo de los manuales de programacin es familiarizar a analistas y
programadores con lo que hace cada programa en particular.

Los manuales de programacin son una extensin de la documentacin 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 programacin,
deber ser expuesto y aceptado antes de aplicar el cambio.

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

Manual del Diseo.-
El objetivo primordial del manual de diseo del sistema es el de proveer a los
programadores suficiente informacin para escribir los programas de
aplicaciones en lenguaje de computador. Este manual forma parte de las
especificaciones funcionales, ya que convierte la definicin orientada al
usuario en una definicin orientada a sistemas computadorizados.


El Analista que est desarrollando el diseo del sistema deber trabajar
conjuntamente con las especificaciones funcionales y enmendarlas, si fuera
necesario. Cualquier cambio a las especificaciones funcionales, como
resultado del diseo del sistema, debe ser aprobado antes de proceder a
actualizar el documento original.