Documentación

El desarrollo de un sistema de software lleva consigo no sólo las líneas de código, sino que también debe proporcionar ciertos productos para que los usuarios tengan un mejor cono cimiento sobre el proyecto. Al igual se busca dejar constancia de las decisiones tomadas en el análisis y diseño para el mantenimiento posterior del sistema.

Los productos de desarrollo orientado a objetos incluyen: diagramas de clases, diagramas de objetos, diagramas de módulos y diagramas de procesos. En conjunto sirven para remontarse a los requerimientos del sistema .

Los productos del proceso de diseño son un conjunto de documentación dirigida a clientes y usuarios en lenguaje natural, donde se describe qué e s lo que el sistema hará, y en una segunda parte, se utiliza una documentación técnica que describe la estructura del sistema, datos y funciones.

En general la documentación esencial debe incluir: documentación de la arquitectura de alto nivel del sistema, documentación de las abstracciones y mecanismos de arquitectura y documentación de los escenarios que ilustran el funcionamiento práctico.

Debe contener descripciones de los componentes del sistema , la forma en que interactúan los usuarios con el sistema en donde se debe considerar lo siguiente:

– Menús y otros formatos en pantalla,
– Interfaces: teclas de función, descripciones de pantalla, esquemas de teclados y uso del ratón formatos de los reportes,
– Entradas: informa ción de datos como se dan, en qué formato y el medio donde son almacenados,
– Salidas: dónde se envían los datos, cómo se les da formato y el medio donde son almacenados y procedimientos de archivo.

Si el sistema es distribuido, la configuración deberá detallarse presentando la topología de la red y posibles recomendaciones de integridad.

Finalmente se debe real izar un cruce del diseño frente a los requerimientos, para demostrar cómo el diseño ha sido efectivamente derivado de ellos.

Fuente: Apuntes de Informática V de la FCA de la UNAM