IEEE 1016-1998

Recommended Practice for Software Design Description

Creada y desarrollada por: Jos Luis Loarca de Avila. Fecha: 17/junio/2002

Objetivo:
El objetivo de la recomendacin IEEE 1016-1998 es presentar una gua adaptable para elaborar la descripcin de diseo de software (SDD-Software Design Description).

Definiciones:
Entidad de diseo (Design entity): Es un elemento del diseo que es estructural y funcionalmente distinto de otros elementos. Es nombrado y referenciado en forma separada. Puede describir un componente discreto del sistema y puede ser implementado, cambiado y probado con el mnimo efecto de otras entidades. Mdulo: Unidad del programa que es discreto e identificable con respecto al compilador, combinado con otras unidades y cargables. Paso de programa (Program step): Instruccin simple ejecutable en lenguaje de programacin. Los bloques de programa, selecciones e interacciones son clasificados como simples instrucciones del programa.

Definiciones (cont.)
Especificaciones de la arquitectura del sistema (System Architecture Specifications): Provee una estructura para el desarrollo del diseo detallado. Este describe la divisin de la solucin en mdulos individuales de hardware y software. Adems describe la interaccin entre estos mdulos. No provee una descripcin detallada de sus funciones en cada mdulo. Esta es la funcin de la descripcin del diseo del software. Especificacin requerida del software (Software Requirement Specification): Son los requerimientos de lo que el sistema debe hacer desde el punto de vista del usuario.

Definiciones (cont.)
Descripcin del diseo de software (Software Design Description): Describe en forma detallada las funciones de cada componente del software. Esquema estructural: Diagrama que identifica los mdulos, actividades u otras entidades en un sistema o programa. Arquitectura del sistema: Conjunto de componentes hardware y software cuyas interfaces constituyen el sistema. Pruebas de caja blanca (White box testing): Pruebas aplicadas en el interior de una estructura del cuerpo del software para asegurar que todas las rutas sean utilizadas y todos los bloques ejecutados.

Propsito
El SDD es creado por el diseador de sistemas y es generalmente proporcionado para el diseo de los procesos detallados.

Requisitos previos
La documentacin previa requerida para el SDD varia segn el tamao y complejidad del producto software a desarrollar. Sistemas grandes: Uso de las especificaciones de la arquitectura del sistema (SAS). En este contexto el SDD representa otro proceso de refinamiento en el diseo de entidades descrito en el SAS. El SDD puede proveer descripciones para uno o ms entidades de diseo. Sistemas pequeos: Uso de la especificacin de requerida del software (SRS). Este contexto es la forma sencilla del diseo de la solucin a problemas comenzados en el SRS.

Aplicacin
El SDD es la referencia primaria para el desarrollo del cdigo. En s, debe contener toda la informacin requerida por el programador para escribir el cdigo.

Criterio de calidad
Se definir el criterio en el cual la calidad del SDD ser evaluada.

Trazabilidad (Traceability)
Cada entidad de diseo descrita en el SDD debe satisfacer un requerimiento interno de diseo.

Cumplimiento de estndares
Todos los SDDs debern tener un encabezado de prrafo. Si un encabezado de prrafo no se utiliza en el diseo, este ser incluido y marcado como no aplicable. Todos los prrafos aplicables debern referenciar al checklist de los puntos cubiertos en cada subseccin de este estndar.
Diseo de la base de datos El diseo de la base...

Comprensibilidad
Estn los conceptos de diseo en un lenguaje simple o ambiguo ? Pueden los conceptos de diseo ser entendidos en la primera lectura ? Pueden ser las descripciones de diseo obvias sin dejar nada a la imaginacin del lector ?

Modularidad
Es el grado en el cual el problema (comprensin, pruebas, programacin, etc.) es dividido en problemas ms pequeos cuya solucin puede ser alcanzada en forma independiente.

Cohesin
Es el grado en que los elementos internos de un mdulo son relacionados otro otros.

Acople
Es el grado en el cual mdulos individuales son independientes entre s.

Bueno: Regular: Malo:

Acople de datos (mx. 5 parmetros entre mdulos) Acople de control (un mdulo controla la sec. de instrucciones en otro mdulo) Acople comn (muchas rutinas referencian a un bloque comn de datos)

Muy malo: Acople de contenido (un mdulo modifica valores de datos locales en otro mdulo)

Concentracin (Fan-in)
Es el nmero de mdulos que llaman a un mdulo. Una buena modularidad es cuando se maximiza la concentracin.

DIVISION DE CONTROL: Nmero de mdulos subordinados llamados por un mdulo. Una gran divisin de control (mayor a 7) puede indicar que el mdulo es demasiado complejo. Esto es, contiene demasiado control y lgica de coordinacin.

Implementabilidad
El SDD deber proveer toda la informacin que el programador requiere para codificar la entidad descrita.

Modificabilidad
El diseo de la informacin ser presentada de una sola forma para dar un soporte a modificaciones futuras del documento. Una instancia de ms de una ocurrencia de la misma informacin puede ser ambigua si todas las ocurrencias de la informacin no son actualizadas simultneamente.

Extendibilidad
Es la forma ms sencilla en la que el diseo puede ser adaptado a los cambios de los requerimientos. Los elementos claves de la extendibilidad son: - Simplicidad del diseo - Modularidad

Puntos a cubrir
El SDD deber cubrir: Formato y contenido Portada Pgina de comentarios Introduccin Propsito Visin Definiciones, acrnimos y abreviaciones Referencias Descomposicin del diseo Estructura del diseo Estructura del cdigo Descripcin detallada del diseo del mdulo Identificacin Propsito Funcin Subordinados Dependencias Interfaces Recursos Datos internos Procesamiento Informacin implementada al proceso Estrategia de prueba al mdulo Descripcin del diseo de la interfase - Identificacin - Tipo - Propsito - Funcin - Protocolo - Cdigos de error - Interaccin con el usuario Diseo de la base de datos - Introduccin - Diccionario de datos - Diseo de la base de datos Memoria global Mensajes generales Mensajes de usuario Mensajes interproceso ndice Apndice

10

Referencias (IEEE 1016-1998)

Institute of Electric and Electronic Engineers. http://www.ieee.org Software Design Description http://tuffley.hispeed.com/tcs20004contents.htm Software Requirements Specifications http://tuffley.hispeed.com/tc20001.htm

11