La Documentacion

Documentación
La documentación tiene una gran importancia dentro de una empresa, ya que esta ayuda a eliminar la posible dependencia que se pueda formar entre el proyecto realizado, y el ejecutor de éste. Para que toda aplicación tecnológica y todo servicio informático quede adecuadamente documentado, es necesario exigirle a quien lo diseñe y/o desarrolle (puede ser personal interno o un proveedor) que entregue dicha documentación obtenida a través del desarrollo del proyecto, de manera que otras personas relacionadas o autorizadas por la empresa accedan a los conocimientos necesarios para corregir errores, hacer ajustes, etc.
La oposición que entregan los técnicos a la realización del proceso de documentación, se basa principalmente en los costos en que se incurre para su construcción y en el mayor plazo de entrega. Pero estas justificaciones no son posibles de sustentar en la realidad, ya que el mayor costo en que se incurre para documentar se recupera con creces en el futuro, especialmente cuando se ve enfrentado a un error del sistema o tener que efectuarle mantenciones.

Existen dos tipos de documentaciones, que son:

Documentación Manual

Este tipo de documentación se efectúa manualmente. Puede documentarse en papel o en algún medio magnético como disquete o CD. Se cuenta con apoyo de sw para su confección, como un procesador de texto, planilla electrónica y programas graficadores.

Ventajas:

-Refleja historia.
-Muestra la evolución de la documentación en el tiempo.
-Más explicativa.
-Se adecua a la cultura de la organización.
-No consume capacidad de procesamiento.

Desventajas:

-Consume mucho esfuerzo en construirla.
-Documentación incompleta.
-Poca disposición para entregar información.
-Más lenta y sin actualizar.
-Errores de escritura

Documentación Automática

Para este tipo de documentación, existen software que documentan. Pero estos software no están disponibles para todas las plataformas, por lo que hay que revisar bien el ambiente en que se trabaja para ver si existe algún software de documentación compatible.

Este tipo de documentación es muy útil para:
a)Cubicar o dimensionar (definir plazo y costo) de trabajos de mantención de sw. Su utilización requiere de que el sw a analizar haya sido desarrollado en base a alguna norma y que esta norma haya sido respetada.

b)Apoyar labores de auditoria y control.

Ventajas:

-Es inmediata y está siempre actualizada.
-Más rápida.
-Justo a lo requerido.
-No se encuentra sujeta a la disposición del personal.

Desventajas:

-Consume recursos de Hardware.
-No guarda historia, no obstante es posible ir guardando en medios magnéticos las diferentes documentaciones obtenidas en el tiempo y de esta forma ir conservando historia.
-No siempre disponible, pues no hay disponibilidad para todas las plataformas.
-No es explicativa
-Costo, es un software que debe adquirirse

Los dos tipos de documentación no son incompatibles entre sí, por lo que se puede lograr un equilibrio entre ambas para lograr una buena documentación a un buen costo.

Qué documentar

Existen elementos que son necesarios de mantener documentados, como:

Manuales
Pueden estar en cualquier medio, ya sea en papel, CD, diskette, etc. Existen varios tipos de manuales, como:

Usuario

Este manual explica a los usuarios o clientes, como es la utilización del Sw, sus posibles errores, que funciones cumple, como se instala el Sw, sus requerimientos, etc. En las aplicaciones se incluye este manual en línea al cual el usuario puede acceder a él normalmente apretando la tecla de Help en cualquier opción en que se encuentre trabajando dentro de la aplicación, adicionalmente está el manual de FAQ (frequent asked questions) que es un resumen con las respuestas a las preguntas mas frecuentes que se hacen los usuarios.

Técnico

Destinado para uso operacional, este manual señala como se manejan los respaldos, la conexión de equipos periféricos, etc. Según las características de las aplicaciones, este manual puede existir o no.

Errores

Indica que hacer ante la posible ocurrencia de errores y como solucionarlos. Estos errores no son del sistema, sino que son errores que el usuario puede cometer.

Sistemas

Explica qué hace la aplicación, pero se los explica a los técnicos utilizando un lenguaje técnico, ya que está orientada a informática.

Interna

Es documentación que se encuentra dentro de cada uno de los programas, indicando como funcionan éstos. Permite que el programador entienda cómo se ejecuta el programa y también deben registrar todos los cambios efectuados al programa a manera de documentación
Toda esta documentación está dentro del programa fuente, ya que si éste no viene no es posible realizar ningún tipo de modificación a la aplicación.

Diagramas de Red
Para la documentación de los diagramas de red, es necesario contar con planos y dibujos, además de un Sw de apoyo llamado autocad (es un programa de dibujo técnico de Diseño Asistido por Computador). Adicionalmente existen Sw administradores de red, el cual mantiene la documentación de la red que administra y va registrando todas las modificaciones que cambian la configuración, adicionalmente entrega alertas y aviso de algún funcionamiento anormal, a no ser que exista un corte en las comunicaciones que no permita que llegue dicho mensaje, aunque lo probabilidad de ocurrencia de esto último es muy baja.

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.

Sistemas de 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 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 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.