Informatica

INTRODUCCIÓN

El trabaja que se desarrolla a continuación nos muestra los Elementos que se deben tomar en cuenta para hacer una eficiente documentación de sistema, para lograr un buen entendimiento de este tema no debemos dejar de mencionar lo que es una buena documentación, su importancia y los tipos que existan, teniendo estos como base se podrá observar de manera más amplia y sencilla loselementos que conforman la documentación.

El punto a desarrollar es de suma importancia ya que nos ayudara profesionalmente a todos aquellos que requieran llevar la documentación del algún proceso porque aprenderán a usar las mejores herramientas para obtener un resultado excelente.

La documentación, es el acto de reunir documentos sobre un tema dado o material queexplica las características técnicas y la operación de un sistema. Su principal función es enseñar a los usuarios como interactuar con el sistema y a los analistas como hacerlo funcionar. Por lo tanto la documentación de sistemas, es el conjunto de información que especifica que hacen los sistemas, como lo hacen y para quién lo hacen. De acuerdo a la fuentes consultadas se puede decir también quela documentación es una disciplina científica que trata de recopilar, almacenar, analizar y difundir información contenida en documentos de distinto tipo para hacerla accesible a cualquier persona que pueda necesitarla. Es una disciplina instrumental, ya que sirve a todas las demás ciencias para localizar información necesaria para el avance del conocimiento.

Estándares Básicos deDocumentació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 dicadas, estructuradas en carpetas e incluir un índice.
* Los diagramas deberán ser claros, no aglomerados y la escritura manuscrita deberá serlegible.
* 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.

Tipos de Documentación

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 elambiente 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 auditoría ycontrol.

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

Documentación Manual: estetipo 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 culturade la organización.
* No consume capacidad de procesamiento.
Desventajas
* Consume mucho esfuerzo en construirla.
* Documentación incompleta.
* Poca disposición para entregar información.

Elementos básicos para la documentación efectiva:

1) Los requerimientos de documentación deben cubrir todo el ciclo de vida del software. La documentación es requerida desde las...