Documentos de Académico
Documentos de Profesional
Documentos de Cultura
i
TABLA DE CONTENIDOS
ii
1 Definición del Módulo
1.1 Alcance
[Describa lo que el módulo debe hacer.]
1.2 Supuestos
[Describa todos los supuestos que serán considerados para diseñar el módulo]
1.3 Dependencias
[Describa las dependencias del modulo, por ejemplo este módulo usa el módulo
xxx para ejecutar la operación yyy.]
1.4 Restricciones
[Describa todas las restricciones que deben ser consideradas al diseñar el
módulo, por ejemplo tamaño, tiempo, etc.]
1.5 Riesgos
[Describa todos los riesgos relacionados con el modulo que puedan impactar el
desarrollo.]
1
2 Diseño Detallado
2.1 Arquitectura
2.1.1 Arquitectura de Alto Nivel
[Presente un diagrama de la arquitectura de alto nivel del sistema. Identifique los
módulos relevantes y donde se encuentra en el sistema el módulo que se está
definiendo.]
2.1.2 Arquitectura del Módulo
[Presente un diagrama de la arquitectura del modulo. Identifique los
componentes relevantes (librerías, semáforos, mutex, colas de mensaje,
variables globales, etc.) Describa cada componente y las relaciones entre ellos
(por ejemplo como se usa un semáforo, cuando debe ser seteado, etc.)]
Identificador Descripción
[Escriba una breve explicación de lo que hace la
macro y explique las entradas y salidas
especificando sus rangos]
2
2.7 Rutinas Privadas
[Liste todas las rutinas privadas que serán implementadas entregando una breve
descripción de su función. Algunas de ellas serán definidas en detalle dentro del
documento, por lo que use la columna página para especificar donde se
encuentra el detalle.]
Función Descripción Pagina
2.9 Funciones
[Diseñe en esta sección las funciones privadas y públicas que requieren de un
tratamiento especial o cuyo diseño no es obvio.]
2.9.1 Funcion1()
[Describa la funcion1]
Precondition
[Describa toda acción que debe ser ejecutada antes de llamar la función]
Prototype
status_t funcion1(type1 in_param1, type2 ou_param2,
type3 io_param3);
Parámetros
Identificador Tipo Descripción
Valores de Retorno
Valor Descripción
Implementación
[Describa todo lo que usted piensa que debe ser documentado, esto puede ser
la explicación de una variable especial, un algoritmo, pseudo código, etc. No
ponga código en esta sección. Sea lo más detallado posible. Piense que otra
persona codificará el módulo]
3
2.9.2 Funcion2()
[Describa la funcion2]
Precondition
[Describa toda acción que debe ser ejecutada antes de llamar la función]
Prototype
status_t funcion2(type1 in_param1, type2 ou_param2,
type3 io_param3);
Parámetros
Identificador Tipo Descripción
Valores de Retorno
Valor Descripción
Implementación
[Describa todo lo que usted piensa que debe ser documentado, esto puede ser
la explicación de una variable especial, un algoritmo, pseudo código, etc. No
ponga código en esta sección. Sea lo más detallado posible. Piense que otra
persona codificará el módulo]
4
Glosario (Definiciones y Siglas)
Nnnn: xxxxxxx
Yyyyy: mmmmm.