Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Introducción
2. Estandarizacion y normalización
3. Manual Administrativo
4. Manual De Usuario
5. Manual De Captacion
1. Introducción
La documentación de sistemases 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 muestracomo algo que debe
prepararse en forma rutinaria para cada programa de cómputo, archivo y nuevos sistemas.
Otra definición sería la de registrofí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ñodel 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.
2. Estandarizacion y normalizacion
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 entrenamientodel 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.
Teoria 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 dc 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
3. 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 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 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:
Módulo o Procedimiento
Nombre del Documento Usuarios que manejan el
donde entra el Origen del documento
Fuente documento
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:
Periodicidad en que se
Nombre de la salida Destino Usuarios que lo requieren
genera
Actividades a realizar 1 2 3 4
Presentación de la *****
Propuesta
Análisis *****
Costo / Beneficio
Entrenamiento *****
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 dc manera que
la gestión del sistema no se vea afectado. Si es un sistema en línea no se requiere. Ejemplo:
Solicitud de Semanal Actualizar informe Antes de las 2:00 p.m. 3:00 p.m.
reporte del departamento X
Mensual
1. Toda documentación que se genere para un proyecto específico, que haya sido
revisada y aprobada, debe poseer lo siguiente:
• Logotipo de la organización.
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 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.
3. Contenido técnico
3.12. Áreas de aplicación y/o alcance de los procedimientos. Esfera de acción que
cubren los procedimientos
4. Responsables.
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.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