¿Qué es la Documentación?

¿Qué es la Documentación?

En términos generales, la documentación es el acto de reunir documentos sobre un tema dado y el tratamiento de éstos en vistas a su difusión.

Sistema de Documentació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 operando como hacerlo funcionar.

Tipos de documentación

La documentación que se entrega al cliente se divide claramente en dos categorías, interna y externa:

Interna: Es aquella que se crea en el mismo código, ya puede ser en forma de comentarios o de archivos de información dentro de la aplicación.

Externa: Es aquella que se escribe en cuadernos o libros, totalmente ajena a la aplicación en si. Dentro de esta categoría también se encuentra la ayuda electrónica.

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

Campo de la documentación de sistemas:

Son aquellos que esporádica o periódicamente tienen necesidad de documentarse con motivo de estudio, trabajo, investigación, docencia, formación permanente, decisión, etc.

Características de la documentación de sistemas:

•Pertinencia: los documentos que se proporcionan deben responder a las necesidades específicas de los utilizadores.

•Exhaustividad: deben proporcionarse al usuario todos los documentos que respondan a sus necesidades.

•Rapidez: los documentos pertinentes deben transmitirse al usuario interesado inmediatamente después de su publicación.

•Economía: el coste de la Documentación debe ser mínimo

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 entrenamiento del nuevo personal dentro y fuera de la organización de Sistemas.

...