TEORÍA GENERAL DE LOS MANUALES DE DOCUMENTACIÓNDurante 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
1. 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 si lo 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 permitir a la alta gerencia tener 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
Un 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 analisis del sistema. Se debe mencionar:
Dependencia que requirió el trabajo.
Personas o puestos ocupados por éstas 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:
Salidas Del Sistema (Resultados a Obtener)
En este punto, solamente se describien los resultados de mayor importancia obtenidos a través de todo el proceso. En esta sección se da 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:

Diagramación 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 pricesos 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. Se Presen 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
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 segurida, 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.
2. Manual De Usuario
Expone los procesos0 que el usuario puede realizar con el sistema implantado. Para lograr esto, es necesario que se detallen todas y cada una de las caracteristicas 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 tipos 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 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 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.
Pasos a seguir para la elaboración del manual del usuario:
1. Portada: De que se trata el documento y quién lo elaboro
2. Introducción: Describe el uso del documento (para qué sirve) y de qué habla.
3. Análisis y requerimientos del sistema.
3. Explicación del funcionamiento: Se debe poner paso a paso y con pantallas bien explicadas como funciona el programa
4. Glosario
• Debe ser escrito de tal manera, que cualquier persona pueda entenderlo con la menor dificultad posible.
• Es recomendable, detallar todos aquellos pasos que se llevan a cabo para usar el programa.
• Especificar los alcances y las limitaciones que tiene el programa.
• Un buen punto de partida para un manual de usuario, es hacer de cuenta que las personas que lo van a leer no tienen el mas mínimo conocimiento sobre computadores.
3. 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.
4. Manual De Captacion
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 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.
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 anormal
Mensaje
Causas
Soluciones
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 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ón
Frecuencia
Objetivo
Hora de Entrada
Hora de salida
Solicitud de reporte
Semanal
Mensual
Actualizar informe del departamento X
Antes 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.
5. 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 Sistema.
Se 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 Programa.
Se debe desarrollar por cada programa del sistema. Incluye:
Diagrama electrónico del programa.
6. Manual Técnico
Este documento contiene toda la información sobre los recursos utilizados por el proyecto, llevan una descripción muy bien detallada sobre las características físicas y técnicas de cada elemento. Por ejemplo: características de procesadores, velocidad, dimensiones del equipo, garantías, soporte, proveedores y equipo adicional.
Su extensión depende de la cantidad de recursos y equipo utilizado y generalmente se presenta en forma de fichas técnicas en donde se describe en cada una las características de cada recurso.
CONSIDERACIONES GENERALES PARA LA DOCUMENTACIÓN DE EL DESARROLLO DE APLICACIONES INFORMÁTICAS:
1. Toda documentación que se genere para un proyecto específico, que haya sido revisada y aprobada, debe poseer lo siguiente:
A) Identificación del documento
Este documento debe incorporar la siguiente información:
• Logotipo de la organización.
• Nombre oficial de la organización.
• Denominación y extensión. De corresponder a una unidad en particular debe anotarse el nombre de la misma.
• Lugar y fecha de elaboración.
• Número de revisión (si aplica).
• Unidades responsables de su elaboración, revisión o autorización.
• Clave de la forma. En primer término, las siglas de la organización, en segundo lugar las siglas de la unidad administrativa donde se utiliza la forma y, por último, el número de la forma. Entre las siglas y el número debe colocarse un guión o diagonal. (si aplica)
B) Estructura del documento.
2. Por cada documento final deberá entregarse copias al personal involucrado en el proyecto.
3. Una vez concluido el desarrollo de un sistema, considerando para esto los posibles cambios que se efectúen durante la etapa de garantía de que lo cubre (si así fuera el caso), el usuario final del sistema debe recibir una versión actualizada final del documento.
Estructura del documento MANUAL TÉCNICO
1. Índice
Relación de los capítulos y páginas correspondientes que forman parte del documento
2. Introducción.
Se debe presentar una breve descripción del sistema desarrollado, que contemple el ámbito abarcado, cual es su función principal y un detalle de las funciones macros o partes que lo componen. Puede incluir un mensaje de la máxima autoridad de las áreas comprendidas en el manual.
2.1. Objetivo general del sistema
Se debe de describir el objetivo general del sistema.
2.2. Objetivos específicos
Se deben describir brevemente los objetivos específicos que se cumplieron con el desarrollo del sistema.
3. Contenido técnico
3.1. Definición de reglas del negocio implementadas en el sistema desarrollado.
3.2. Diagramas de flujo de datos, junto con su respectivo diccionario de datos.
3.3. Controles de auditoria implementados en el sistema.
3.4. Descripción de campos requeridos por pantalla con presentación de pantallas.
3.5. Diagrama de navegación del sistema.
3.6. Requerimientos de interfase con otros sistemas.
3.7. Modelo lógico de datos, diagrama entidad-relación.
3.8. Modelo de datos físico, junto con su respectivo diccionario de datos.
3.9. Matriz de procesos versus organización.
3.10. Matriz de programas versus entidades.
3.11. Plataforma de usuario. Aquí se describen los requerimientos mínimos que se deben tener tanto de hardware como de software para que el sistema se pueda instalar y ejecutar correctamente (en caso de que se considere necesario).
3.12. Áreas de aplicación o alcance de los procedimientos. Esfera de acción que cubren los procedimientos
4. Responsables.
Para iniciar los trabajos que conducen a la integración de un manual, es indispensable prever que no queda diluida la responsabilidad de la conducción de las acciones en diversas personas, sino que debe designarse a un coordinador, auxiliado por un equipo técnico, al que se le debe encomendar la conducción del proyecto en sus fases de diseño, implantación y actualización.
De esta manera se logra homogeneidad en el contenido y presentación de la información. Por lo que respecta a las características del equipo técnico, es conveniente que sea personal con un buen manejo de las relaciones humanas y que conozca a la organización en lo que concierne a sus objetivos, estructura, funciones y personal. Para este tipo de trabajo, una organización puede nombrar a la persona que tenga los conocimientos y la experiencia necesarios para llevarlo a cabo. Por la naturaleza de sus funciones puede encargarlo al titular del área específica. Asimismo, puede contratar los servicios de consultores externos.
4.1. Mapa de navegación. Muestra de forma gráfica la interconexión entre cada una de las pantallas del sistema, lo que serviría para saber como llegar a determinada parte de la aplicación. En este se muestran los menús, submenús y pantallas a las que nos lleva cada uno de ellos
4.2. Descripción gráfica del mapa de navegación. En el anterior aparece de forma de diagrama de flujo y en esta sección deberá aparecer ya con las respectivas pantallas.
4.3. Describe paso a paso los procesos, así como pantallas, botones, cuadros de texto, etc., pero también se muestra el código de cada rutina, pantalla, botón, etc. es decir, se muestra lo que hay detrás de la interfaz del usuario y la elaboración del Manual Técnico