DISEO DETALLADO DEL SOFTWARE

[NOMBRE DEL MODULO]

PREFACIO

Este documento describe el diseo detallado de software del

modulo [nombre del modulo], cuyo objetivo principal es
[describa el objetivo principal del modulo]
Alcance Este documento de diseo detallado del software del modulo
es la base de la codificacin de este. Describe los siguientes
tpicos: [especifique la lista de tpicos]. Este documento no
describe [especifique lo que no se describe en este
documento].

HISTORIA DEL DOCUMENTO

Fecha

Versin

Comentarios

Autor

30 Julio 2002

0.1

Versin inicial

nn

27 Agosto2002

1.0

Revisada por el equipo

nn

TABLA DE CONTENIDOS
1

Definicin del Mdulo......................................................................................1

1.1
Alcance.....................................................................................................1
1.2
Supuestos.................................................................................................1
1.3
Dependencias..........................................................................................1
1.4
Restricciones............................................................................................1
1.5
Riesgos.....................................................................................................1
1.6
Metodologa de Prueba............................................................................1
2 Diseo Detallado.............................................................................................2
2.1
Arquitectura..............................................................................................2
2.1.1
Arquitectura de Alto Nivel..................................................................2
2.1.2
Arquitectura del Mdulo....................................................................2
2.2
Macros Privadas.......................................................................................2
2.3
Constantes Privadas................................................................................2
2.4
Tipos de Datos Enumerados Privados.....................................................2
2.5
Estructuras de Datos Privadas.................................................................2
2.6
Variables Privadas....................................................................................2
2.7
Rutinas Privadas......................................................................................3
2.8
Rutinas Pblicas.......................................................................................3
2.9
Funciones.................................................................................................3
2.9.1
Funcion1().........................................................................................3
2.9.2
Funcion2().........................................................................................4
Glosario (Definiciones y Siglas)..............................................................................5

ii

1 Definicin del Mdulo

1.1

Alcance

[Describa lo que el mdulo debe hacer.]

1.2

Supuestos

[Describa todos los supuestos que sern considerados para disear el mdulo]
1.3

Dependencias

[Describa las dependencias del modulo, por ejemplo este mdulo usa el mdulo
xxx para ejecutar la operacin yyy.]
1.4

Restricciones

[Describa todas las restricciones que deben ser consideradas al disear el

mdulo, por ejemplo tamao, tiempo, etc.]
1.5

Riesgos

[Describa todos los riesgos relacionados con el modulo que puedan impactar el
desarrollo.]
1.6

Metodologa de Prueba

[Describa como realizar las pruebas unitarias del mdulo. Si se planifica escribir
una o ms funciones para probar el mdulo, estas deben ser definidas y
diseadas en esta seccin.]

2 Diseo Detallado
2.1

Arquitectura

2.1.1 Arquitectura de Alto Nivel

[Presente un diagrama de la arquitectura de alto nivel del sistema. Identifique los
mdulos relevantes y donde se encuentra en el sistema el mdulo que se est
definiendo.]
2.1.2 Arquitectura del Mdulo
[Presente un diagrama de la arquitectura del modulo. Identifique los
componentes relevantes (libreras, semforos, mutex, colas de mensaje,
variables globales, etc.) Describa cada componente y las relaciones entre ellos
(por ejemplo como se usa un semforo, cuando debe ser seteado, etc.)]
2.2

Macros Privadas

[Liste las macros privadas que son usadas internamente por el mdulo]
Identificador

2.3

Descripcin
[Escriba una breve explicacin de lo que hace la
macro y explique las entradas y salidas
especificando sus rangos]

Constantes Privadas
[Liste todas las constantes privadas que son utilizadas por el mdulo]
Identificador

2.4

Valor

Descripcin

Tipos de Datos Enumerados Privados

[Liste los tipos de datos enumerados privados que son usados internamente,
incluyendo su definicin]
2.5

Estructuras de Datos Privadas

[Liste las estructuras de datos privadas que son usadas internamente,

incluyendo su definicin]
2.6

Variables Privadas

[Liste las variables privadas que son usadas internamente, incluyendo su

definicin]
Identificador

Tipo

Descripcin

2.7

Rutinas Privadas

[Liste todas las rutinas privadas que sern implementadas entregando una breve
descripcin de su funcin. Algunas de ellas sern definidas en detalle dentro del
documento, por lo que use la columna pgina para especificar donde se
encuentra el detalle.]
Funcin

2.8

Descripcin

Pagina

Rutinas Pblicas

[Liste todas las rutinas pblicas que sern implementadas qu requieren un

tratamiento especial o cuyo diseo no es obvio, entregando una breve
descripcin de lo que hacen.]
Funcin

2.9

Descripcin

Pagina

Funciones

[Disee en esta seccin las funciones privadas y pblicas que requieren de un

tratamiento especial o cuyo diseo no es obvio.]
2.9.1 Funcion1()
[Describa la funcion1]
Precondition
[Describa toda accin que debe ser ejecutada antes de llamar la funcin]
Prototype
status_t funcion1(type1
type3 io_param3);

in_param1,

type2

ou_param2,

Parmetros
Identificador

Tipo

Descripcin

Valores de Retorno
Valor

Descripcin

Implementacin
[Describa todo lo que usted piensa que debe ser documentado, esto puede ser
la explicacin de una variable especial, un algoritmo, pseudo cdigo, etc. No

ponga cdigo en esta seccin. Sea lo ms detallado posible. Piense que otra
persona codificar el mdulo]
2.9.2 Funcion2()
[Describa la funcion2]
Precondition
[Describa toda accin que debe ser ejecutada antes de llamar la funcin]
Prototype
status_t funcion2(type1
type3 io_param3);

in_param1,

type2

ou_param2,

Parmetros
Identificador

Tipo

Descripcin

Valores de Retorno
Valor

Descripcin

Implementacin
[Describa todo lo que usted piensa que debe ser documentado, esto puede ser
la explicacin de una variable especial, un algoritmo, pseudo cdigo, etc. No
ponga cdigo en esta seccin. Sea lo ms detallado posible. Piense que otra
persona codificar el mdulo]

Glosario (Definiciones y Siglas)

Nnnn: xxxxxxx
Yyyyy: mmmmm.