Ninguno

Definición Documentacion

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 delsistema y para enseñar a los usuarios como interactuarcon el sistema y a los operandos como hacerlo funcionar.

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.

Ladocumentació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. Sila documentación del sistema es incompleta el diseñador continuamente estará involucrado y no podrá moverse a otra asignación.

Tipos de documentacion

Existen varios tipos de documentación. La de programas, que explica la lógica de un programa e incluye descripciones, diagramas de flujo, listados deprogramas y otros documentos; la del usuarios en forma general la naturaleza y capacidades delsistema 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 semuestra como algo que debe prepararse en forma rutinaria para cada programa de cómputo, archivo y nuevos sistemas.

Teoria General De Los Manuales De Documentación

Durante el desarrollo de un sistema, desde su concepción hastasu 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ónde 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 ysubtí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

Tipos de manuales

Manuales administrativos

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 siloexpuesto 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 elSistema 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...