Documento de diseño del software

La documentación consiste en material que explica las características técnicas y la operación de un sistema. Otras utilidades de la documentación residen en permitir auditorías del sistema y para enseñar a los usuarios cómo interactuar con el sistema y a los operadores cómo hacerlo funcionar.

La documentación de programas explica las razones y la lógica de un programa e incluye descripciones narrativas, diagramas de flujo, listados de programas y otros documentos. La del usuario, en general es menos técnica y explica a los usuarios en forma general la naturaleza y capacidades del sistema y cómo usarlo; esta documentación casi siempre está en forma de manual.

El software modular bien diseñado tiene mayor probabilidad de cumplir los requerimientos de facilidad de mantenimiento, confiabilidad y prueba (que es el objetivo del diseño) por lo que es de suma importancia que todo quede debidamente documentado.

La documentación del diseño debe contener una parte denominada justificación racional del diseño, donde se indiquen las cuestiones críticas y los compromisos que fueron considerados en la generación del diseño. Toda esta información va orientada a los clientes, a los usuarios y a otros desarrolladores a comprender cómo y por qué encajan ciertas partes del sistema.

Algunas de las interrogantes que debe responder la documentación del diseño son: ¿Este diseño es la solución al problema?, ¿Es un diseño bien estructurado y fácil de comprender?, ¿Puede hacerse algo para mejorar la estructura y la compresión del sistema?, ¿El diseño es transportable a otras plataformas? y, ¿Es reutilizable?

La documentación debe contener también la descripción de los componentes del sistema. Una de las secciones deberá indicar la forma en que interactuarán los usuarios con el sistema, para ello se debe incluir:

Menús y otros formatos de presentaciones en pantalla;
Interfaces hombre-máquina: teclas de fusión, descripciones en pantalla, teclados, uso de ratón o de los dispositivos requeridos;
– y, formatos de los informes. También especificaciones sobre la procedencia de los datos (entrada), indicar cómo se les dará forma y por qué medio serán almacenados; así como de la forma en que se presentarán los datos (salida).

Además, debe contener información acerca de las características de las funcionales generales, exigencias del performance, y tratamiento de defectos.

Otro de los aspectos importantes que debe contener la documentación tiene que ver con circunstancias como:

– el entorno de red (en caso de que el sistema lo requiera);
– en tal caso, se debe presentar la topología de la red y la forma en que los nodos de la red deben tener acceso a otros nodos o al servidor y la filiación de servicios incluyendo información respecto a restricciones de los nodos hacia el servidor y,
– recomendaciones sobre la integridad de la red, asegurándose de que los datos sean exactos y que puedan recuperarse después de una falla.

Otras secciones de la documentación de diseño pueden tratar aspectos especiales como:

– Localización y aislamiento de errores;
– reconfiguración del sistema y
– medidas especiales de seguridad.

Fuente: Informática I de la facultad de contaduría y administración, UNAM.

Publicado en Informática

Suscríbete:

who's online