Los Sistemas de Documentación

Estos consisten en un conjunto de información relacionada a un sistema determinado que explica las características técnicas, la funcionabilidad del sistema, la parte lógica, los diagramas de flujos, los programas, la naturaleza, capacidades del sistema y cómo usarlo, en otras palabras, 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. En la mayoría de los sistemas, la documentación siempre es expresada en un carácter técnico por excelencia, indicando algoritmos de cómo realizar alguna acción, registrar transacciones, imprimir reportes; dependiendo de la naturaleza del sistema o su función

Tipos de Documentación

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 software 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 adecúa 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:

Cubicar o dimensionar (definir plazo y costo) de trabajos de mantención de software. Su utilización requiere de que el software a analizar haya sido desarrollado en base a alguna norma y, que esta norma haya sido respetada.

Apoyar labores de auditoria y control.

Ventajas

• Es inmediata y está siempre actualizada.
• Justo a lo requerido.
• No se encuentra sujeta a la disposición del personal.

Desventajas

• Consume recursos de Hardware.
• 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 son incompatibles entre sí, por lo que se puede lograr un equilibrio entre ambas para lograr una buena documentación a un buen costo.

Algunos Software usados en la Documentación de Sistemas
Javadoc, phpDocumentor, Smart Draw

Mantenimiento

El diseño e implementación de cualquier sistema organizativo y su posterior informatización debe siempre tener presente que está al servicio de unos determinados objetivos. Cualquier sofisticación del sistema debe ser contemplada con gran prudencia en evitar, precisamente, de que se enmascaren dichos objetivos o se dificulte su consecución.
En el caso del mantenimiento la organización e información debe estar encaminada a la permanente consecución de los siguientes objetivos:

• Optimización de la disponibilidad del equipo productivo.
• Disminución de los costos de mantenimiento.
• Optimización de los recursos humanos.
• Maximización de la vida de la máquina.

Objetivos del Mantenimiento

• Evitar, reducir, y en su caso, reparar, las fallas sobre los bienes precitados.
• Disminuir la gravedad de las fallas que no se lleguen a evitar.
• Evitar detenciones inútiles o para de máquinas.
• Evitar accidentes.
• Evitar incidentes y aumentar la seguridad para las personas.
• Conservar los bieness productivos en condiciones seguras y preestablecidas de operación.
• Balancear el costo de mantenimiento con el correspondiente al lucro cesante.
• Alcanzar o prolongar la vida útil de los bienes.

Importancia de la Documentación de Sistema

La documentación es esencial para proporcionar entendimiento de un sistema a quien lo vaya a usar para mantenerlo, para permitir auditorias del mismo y para enseñar a los usuarios como interactuar con él y a los operadores y administradores como hacerlo funcionar. 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.