Diseño Detallado Software

6
<Código del Proyecto> - <Nombre del Proyecto> Documento de Diseño Detallado del Software Versión <X.Y> Lima, 2014

Transcript of Diseño Detallado Software

Page 1: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Documento de Diseño Detallado del Software

Versión <X.Y>

Lima, 2014

Page 2: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Versión: <X.Y>

Documento de Diseño Detallado del Software Fecha: dd/mm/yyyy

DES-DSW-02

Realizado por: <Elaborado Por>

Revisado por: <Revisado Por>

Aprobado por: <Aprobado Por>

Página 2 de 6

Tabla de Contenidos

1. Introducción 3

1.1 Propósito 3 1.2 Alcance 3 1.3 Definiciones, Acrónimos y abreviaturas 3 1.4 Referencias 3 1.5 Generalidades 3

2. Subsistemas 3

2.1 < Nombre del Subsistema> 3 2.1.1 < Componente Software, programa 1 > 3

2.1.1.1 < Clase, interface, estructura de datos, tabla, vista > 4 2.1.1.1.1 Atributos o Campos 4 2.1.1.1.2 Operaciones / procedimientos almacenados 4

2.1.1.2 Procedimientos y Funciones 4 2.1.1.2.1 < Procedimiento o Programa 1 > 4

2.2 Interfaces de Integración 4 2.2.1 < Nombre de la Interface 1> 4

2.2.1.1.1 Operaciones / procedimientos almacenados 4 2.3 Protocolos de Comunicación 4

2.3.1 < Nombre del Protocolo de Comunicación1 > 4

3. Componentes Adquiridos / Bibliotecas 5

3.1 < Componente Software, módulo 1 – Presentación > 5 3.1.1 < Clase, interface, estructura de datos, tabla, vista > 5

3.1.1.1 Operaciones / procedimientos almacenados 5 3.1.1.1.1 < Operación, procedimiento almacenado, programa 1 > 5

3.1.2 Procedimientos / Funciones 5 3.1.2.1 < Operación, procedimiento almacenado, programa 1 > 5

Page 3: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Versión: <X.Y>

Documento de Diseño Detallado del Software Fecha: dd/mm/yyyy

DES-DSW-02

Realizado por: <Elaborado Por>

Revisado por: <Revisado Por>

Aprobado por: <Aprobado Por>

Página 3 de 6

Documento de Diseño Detallado del Software

1. Introducción

[La introducción a este documento debe incluir una visión general de todo el documento. Incluye el

propósito, alcance, definiciones, acrónimos, abreviaturas, referencias y generalidades del

proyecto.]

1.1 Propósito

[Especifica el propósito que cumple este documento para el proyecto.]

1.2 Alcance

[Una breve descripción del alcance de este documento; con qué proyecto está asociado y cualquier

cosa que se pueda ver afectado o influenciado por este documento.]

1.3 Definiciones, Acrónimos y abreviaturas

[En esta sección se debe de proveer las definiciones de todos los términos, acrónimos y

abreviaturas requeridas para interpretar de manera apropiada el contenido de este documento.]

1.4 Referencias

[Esta sección provee una lista completa de todos los documentos referencias o usados como b ase

para elaborar este documento. Identifique cada documento por su título, número de reporte (si

aplica), fecha y organización que lo publica. Especifique las fuentes a partir de las cuales se pueden

obtener.]

1.5 Generalidades

[Esta sección describe lo contenido en el resto del documento y explica como el documento se

encuentra organizado en lo adelante.]

2. Subsistemas

2.1 < Nombre del Subsistema>

[Colocar aquí la descripción del subsistema o capa de la arquitectura del producto software, tal y

como se ha definido en el Documento de Arquitectura del Software – SAD. Si el subsistema o capa

de la arquitectura se divide en otros subsistemas u otras sub-capas, colocar la sub-sección

correspondiente.

ACLARAR PARA HOST que significa y para OPEN que significa

Colocar aquí el/los diagrama(s) con las clases o subsistemas en los que descomponen el

subsistema]

Para plataforma HOST los subsistemas se corresponden con los módulos funcionales (DFD Nivel 1,

2 dependiendo del nivel de complejidad de la solución desarrollada. Es decir, un nivel de los DFDs

antes de llegar al nivel de las primitivas funcionales). Las primitivas funcionales / caso de uso

constituyen las funcionalidades básicas a implementar sobre la aplicación.

2.1.1 < Componente Software, programa 1 >

[Colocar aquí la descripción del propósito del componente software, resaltando las principales

funciones del componente dentro del marco de la arquitectura del producto. La sección 2.1.1.1 no

es aplicable cuando se trata de HOST (componentes estructurados o base de datos), a menos que la

clase se refiera a estructuras de datos definidas dentro del módulo correspondiente. Resaltar las

dependencias con otros componentes, lenguaje de programación a emplear para su construcción.

Los componentes software pueden ser de:

Page 4: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Versión: <X.Y>

Documento de Diseño Detallado del Software Fecha: dd/mm/yyyy

DES-DSW-02

Realizado por: <Elaborado Por>

Revisado por: <Revisado Por>

Aprobado por: <Aprobado Por>

Página 4 de 6

Presentación – incluye las definiciones de las interfaces del usuario

Lógica de Negocio – incluye el procesamiento de las transacciones de la aplicación

Acceso a datos – incluye mecanismos para el acceso a los datos de la aplicación

Apoyo – incluye mecanismos para soporte a los componentes anteriores. ]

2.1.1.1 < Clase, interface, estructura de datos, tabla, vista >

[Descripción del propósito de elemento como parte del componente software. Si se documenta un

componente de base de datos, deberá plantearse con suficiente detalle las especificaciones físicas

de la base de datos de la aplicación, indicando los detalles de la tabla en la base de datos de la

aplicación.]

2.1.1.1.1 Atributos o Campos

[Preparar en esta sección una tabla con la siguiente información: nombre del atributo o campo,

tipo de dato, valor inicial, criterios semántico (obligatorio, opcional, reglas de validación, etc),

otras consideraciones importantes sobre el elemento de dato.]

2.1.1.1.2 Operaciones / procedimientos almacenados

2.1.1.1.2.1 < Operación, procedimiento almacenado, programa 1 >

[Proporcionar una descripción detallada de la operación, fundamentalmente su propósito a fin de

servir de guía para el programador. Definir además, los parámetros, tipo de datos de cada

parámetro y valor implícito, tipo de retorno, excepciones manejadas, etc.]

2.1.1.2 Procedimientos y Funciones

[Esta sección es aplicable exclusivamente para desarrollos usando técnicas estructuradas (HOST)]

2.1.1.2.1 < Procedimiento o Programa 1 >

[Proporcionar una descripción detallada de la operación, fundamentalmente su propósito a fin de

servir de guía para el programador. Definir además, los parámetros, tipo de datos de cada

parámetro y valor implícito (de existir), tipo de retorno, excepciones/errores manejadas, etc. Cada

programa deberá ser especificado usando algunas de las técnicas siguientes: Español Estructurado,

Diagrama en bloque o la técnica establecida como estándar para el Banco de la Nación]

2.2 Interfaces de Integración

[Presentar las interfaces para la integración del sistema software con otros productos software de

terceros.]

2.2.1 < Nombre de la Interface 1>

[Descripción del propósito de la interfaz como parte del componente software.]

2.2.1.1.1 Operaciones / procedimientos almacenados

2.2.1.1.1.1 < Operación, procedimiento almacenado, programa 1 >

[Proporcionar una descripción detallada de la operación, fundamentalmente su propósito a fin de

servir de guía para el programador. Definir además, los parámetros, tipo de datos de cada

parámetro y valor implícito, tipo de retorno, excepciones manejadas, etc.]

2.3 Protocolos de Comunicación

2.3.1 < Nombre del Protocolo de Comunicación1 >

[Descripción protocolo definido para establecer la comunicación.]

Page 5: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Versión: <X.Y>

Documento de Diseño Detallado del Software Fecha: dd/mm/yyyy

DES-DSW-02

Realizado por: <Elaborado Por>

Revisado por: <Revisado Por>

Aprobado por: <Aprobado Por>

Página 5 de 6

3. Componentes Adquiridos / Bibliotecas

[Colocar aquí la descripción de las especificaciones del componente adquirido. ]

3.1 < Componente Software, módulo 1 – Presentación >

[Colocar aquí la descripción del propósito del componente software, resaltando las principales

funciones del componente dentro del marco de la arquitectura del producto. Las secciones 3.1.1 no

aplica cuando se trata de componentes estructurados, a menos que la clase se refiera a estructuras

de datos definidas dentro del módulo correspondiente. Resaltar las dependencias con otros

componentes, lenguaje de programación a emplear para su construcción.]

3.1.1 < Clase, interface, estructura de datos, tabla, vista >

[Descripción del propósito de la clase como parte del componente software.]

3.1.1.1 Operaciones / procedimientos almacenados

3.1.1.1.1 < Operación, procedimiento almacenado, programa 1 >

[Proporcionar una descripción detallada de la operación, fundamentalmente su propósito a fin de

servir de guía para el programador. Definir además, los parámetros, tipo de datos de cada

parámetro y valor implícito, tipo de retorno, excepciones manejadas, etc.]

3.1.2 Procedimientos / Funciones

3.1.2.1 < Operación, procedimiento almacenado, programa 1 >

[Proporcionar una descripción detallada de la operación, fundamentalmente su propósito a fin de

servir de guía para el programador. Definir además, los parámetros, tipo de datos de cada

parámetro y valor implícito, tipo de retorno, excepciones manejadas, etc.]

Page 6: Diseño Detallado Software

<Código del Proyecto> - <Nombre del Proyecto> Versión: <X.Y>

Documento de Diseño Detallado del Software Fecha: dd/mm/yyyy

DES-DSW-02

Realizado por: <Elaborado Por>

Revisado por: <Revisado Por>

Aprobado por: <Aprobado Por>

Página 6 de 6

Historia de las Revisiones Fecha Versión Descripción Autor

<dd/mmm/yy> <x.x> <detalles> <nombre>