Este documento describe los diferentes tipos de documentación de sistemas, incluyendo la documentación de programas, de usuarios, administrativa y de captación. Explica la importancia de documentar sistemas de manera estandarizada y completa para facilitar el mantenimiento, operación y entendimiento del sistema. También describe los diferentes manuales requeridos como el manual administrativo, de usuario, de captación y de operación.

1. QUE ES LA DOCUMENTACIÓN DE SISTEMAS 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. TIPOS DE DOCUMENTACIÓN 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 el 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. 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. Estándares 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 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 de 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 análisis y diseño del sistema. 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. Objetivos Del Sistema Aquí se dejarán establecidos los objetivos que debe cubrir el sistema, en forma clara y precisa para evitar errores de interpretación. Entradas Del Sistema (Información A Captar) Debe quedar especificado en este punto, los documentos fuentes que inician las operaciones del sistema así como la información detallada de aquellos conceptos que serán los datos a captar por el sistema. Se deberán mencionar todos los datos que en forma secundaria originan una entrada importante al sistema. Ejemplo: Nombre del Documento FuenteMódulo o Procedimiento donde entra el documentoUsuarios que manejan el documentoOrigen del documento Salidas Del Sistema (Resultados A Obtener) En este punto, solamente se describirán los resultados de mayor importancia obtenidos a través de todo el proceso. En esta sección se debe dar mayor énfasis a la información que el sistema proporciona cuidando de no hacer tan sólo mención de los resultados a obtener. Ejemplo: Nombre de la salidaDestinoPeriodicidad en que se generaUsuarios que lo requieren Diagramacion General Del Sistema Es la representación gráfica de las fases del Sistema y su flujo a través de las dependencias que intervienen en el mismo, aunque en forma generalizada. La técnica a utilizar y la simbología 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 gráficamente, ahora se describe en forma genérica, explicando los procesos que se llevan a cabo en cada dependencia sin profundizar en detalles técnicos o específicos. Se deberá resaltar aquellas fases del proceso en las cuáles se obtengan resultados de importancia así como aquellas que requieran una supervisión 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 descripción, además de las cantidades que se requieran. Estimación De La Fecha Probable De Implementacion Del Sistema Es necesario que exista una fecha probable de implantación cuya base será la terminación de todas las actividades para la creación del sistema, tales como: análisis, programación, elaboración de formas, y otros. 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 realizar1234Presentación de la Propuesta***** AnálisisCosto / Beneficio ***** Adquisición del Equipo ***** Entrenamiento ***** Consideraciones Generales Del Nuevo Sistema En este punto se deberá señalar las ventajas, desventajas, y principales diferencias del nuevo sistema con el anterior, tales cómo seguridad, disminución de costo, ahorro de tiempo, flexibilidad, confiabilidad y otros. Además, 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 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 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. Caducidad De Documento Fuente Y Destino Final Como el usuario trabajará con documentos fuentes, éstos podrán tener un período de retención y un destino especificado. MANUAL DE CAPTACIÓN Permite tener una clara visión del proceso de Captación de los datos 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 SistemaEs una explicación clara, breve de todos los módulos que se presentan en el diagrama general.Equipo Utilizado Para La CaptaciónSe 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. Situaciones Anormales Se presentan mensajes que se emiten al momento de la captura de los datos o cualquier condición fuera de lo normal. Ejemplo: Situación anormalMensajeCausasSoluciones 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 de manera que la gestión del sistema no se vea afectado. Si es un sistema en línea no se requiere. Ejemplo: OperaciónFrecuenciaObjetivoHora de EntradaHora de salidaSolicitud de reporteSemanalMensualActualizar informe del departamento XAntes de las 2:00 p.m.3:00 p.m. 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 destrucción, devolución o conservación en un archivo. 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). 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 descrito anteriormente. Diagrama De Pantallas Del SistemaSe presenta 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 en pantalla.Formato en que son captados los datos.Instructivo De Operación Por ProgramaSe debe desarrollar por cada programa del sistema. Incluye:Diagrama electrónico del programa.