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:
-
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 Documentación 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.
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.
Si bien en esta sección se nombra brevemente algunas características de la
documentación de un sistemas, se pretende que Ud. logre después de una lectura
comprensiva tener en claro lo complejo de esta tarea y vamos a profundizar en
técnicas tales como:
-
Requerimiento
-
Glosario
-
Especificaciones
-
Contratos
Estandarización
y normalización
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.
Estandares Básicos De Documentación
Toda documentación que se relacione con un sistema, ya sea manual o
por computadora, sencillo o complejo debe reunir los siguientes requisitos
básicos:
-
Debe ser rotulada con claridad y bien organizada, con secciones claramente
indicadas, almacenarlas en carpetas e índice.
-
Los diagramas deberán ser claros, no aglomerados y la escritura manuscrita
deberá ser legible.
-
La documentación deberá ser completa.
-
Se incluirá una leyenda o explicación de los términos utilizados.
-
La documentación siempre se conserva actualizada.
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.
Teoría General De Los Manuales De Documentación
Durante el desarrollo de un sistema, desde su concepción 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 documentación se desarrollan
diferentes tipos de documentos dirigidos a las personas que trabajarán con el
sistema y para facilitar el mantenimiento del mismo.
La documentación de un sistema debe ser marcada adecuadamente, bien organizada
actualizada y completa; todos los términos utilizados deben explicarse. La
documentación se hará disponible a todos los usuarios de acuerdo a sus
necesidades.
El estilo de redacción de los manuales de documentación debe ser:
-
Concreto.
-
Ser preciso y definir los términos utilizados.
-
Utilizar párrafos cortos.
-
Utilizar títulos y subtítulos.
-
Utilizar formas activas en lugar de pasivas.
-
No emplear frases largas que presenten hechos distintos.
-
No hacer referencia a una información solamente con el número de referencia
Manual Administrativo
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 de consulta una vez que el Sistema ha sido implantado. Todo manual
administrativo debe contener:
Nombre del sistema
Índice de contenido del manual
Describir el nombre del sistema a implantar en la empresa.
Equipo Encargado Del Sistema
Nombre del personal encargado del análisis y diseño del sistema.
Descripción de los procesos que efectúa el sistema dentro de ámbito
administrativo
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
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 operación 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 quién va dirigido es
decir, el manual puede ser manejado desde el director de la empresa u
organización 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.
Explicación Genérica De Las Fases Del Sistema.
En este punto se explica en forma específica y detallada todas las operaciones
que aparecen representadas en forma gráfica en el diagrama particular. Se
analizan cada una de las fases señalando:
-
El proceso principal que se desarrolla.
-
La entrada de la información.
-
La obtención de un resultado parcial.
-
El envío de información a otra dependencia.
Instalación Del Sistema
La instalación del sistema proporciona detalles completos sobre la forma de
instalar el sistema en un ambiente particular.
Iniciación Al Uso Del Sistema.
En este punto se explica cómo iniciarse en el sistema y cómo se pueden utilizar
sus cualidades comunes. Esta documentación debe decir al usuario cómo 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 volúmenes. Los sistemas de ayuda en línea evitan
que el usuario pierda tiempo en consultas manuales.
Manual De Captación
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. Debe contener los siguientes
puntos:
-
Uso del equipo: Describir detalladamente el uso correcto del equipo
utilizado para la captación de la información, dando una explicación del
encendido, manejo, control y del material que se usa como medio de captación
de los datos.
-
Entrenamiento del Software de la aplicación: Explicación del software
utilizado en complemento al sistema.
Ejemplo: como entrar y salir del sistema.
Manual de operación
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).
Nota: Como se puede apreciar la documentación es muy compleja y requiere
que los profesionales logren generar una documentación que satisfaga todas las
necesidades del sistemas teniendo en cuenta todos los actores que participan en
el uso diario. No solo sirve para que los usuarios utilicen el sistemas, los
gerentes tomen decisiones sobre que
recurso humano va a utilizar cada parte del sistema, si no también es utilizado
por los profesionales del área sistema para poner realizar el mantenimiento y si
es necesario realizar migraciones, escalamiento vertical y horizontal del
sistema.
Este que se expuso en esta sección es
muy breve y si va a trabaja con documentación de sistemas y realización de
manuales se recomienda profundizar en bibliografía especifica que dependerá si
ud. trabaja en una empresa chica, mediana o grande y de las políticas de
documentación que utilice cada una de ellas.
