Descripción Funcional Diseño del Software Template

MA ST E R E N I NG E NI E RÍ A D E SOF TW A R E
UNIVERSIDAD POLITÉCNICA DE CATALUNYA
PROYECTO FINAL DE MÁSTER – MRF FRAMEWORK
Descripción Funcional del Diseño del Software
Template
VERSIÓN: [VERSIÓN NÚMERO]
FECHA DE REVISIÓN: [FECHA]
La aprobación de la presente Descripción Funcional del Diseño del Software indica el entendimiento del
propósito y contenido descrito en el presente documento, sus referencias y anexos. Esto implica que la
aprobación del presente documento reconoce la aprobación de todos sus anexos. La firma de este
documento, implica la conformidad de cada individuo con el mismo.
Gerente / Director Organización Cliente
[Nombre]
[Email]
Firma
[Teléfono]
Fecha
Auspiciante Ejecutivo
[Nombre]
[Email]
Firma
[Teléfono]
Fecha
Auspiciante Tecnológico
[Nombre]
[Email]
Firma
[Teléfono]
Fecha
Gerente / Director Organización Ejecutante
[Nombre]
[Email]
Firma
[Teléfono]
Fecha
Gerente de Proyecto
[Nombre]
Firma
[Email]
[Teléfono]
Fecha
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Tabla de Contenidos
Sección 1. Introducción.........................................................................................1
1.1
Propósito .............................................................................................1
1.2 Ámbito ....................................................................................................1
Sección 2. Arquitectura del Sistema .....................................................................2
Sección 3. Diccionario de Datos ...........................................................................3
Sección 4. Diseño del Dominio del Software ........................................................4
4.1
Diagrama del Dominio de la Aplicación Software ...............................4
4.2
Dominios de la Aplicación Software....................................................4
4.2.x
Dominio X
..........4
Sección 5. Diseño de los Datos ............................................................................5
5.1
Datos Persistentes/Estáticos ..............................................................5
5.1.x
Almacén X de los Datos Persistentes/Estáticos
..........5
5.2
Datos Transitorios/Dinámicos .............................................................5
5.3
Datos Externos a la Interfaz ................................................................5
5.4
Transformación de los Datos ..............................................................5
Sección 6. Diseño de la Interfaz de Usuario .........................................................6
6.1
Visión General del Diseño de la Interfaz de Usuario ..........................6
6.2
Jerarquía de Navegación de la Interfaz de Usuario ...........................6
6.3
Categorías de las Funciones de Usuario (o Casos de Uso) ..............6
6.3.x Función (o Caso de Uso) X
6
Sección 7. Otras Interfaces...................................................................................8
7.x Interfaz X
8
Sección 8. Otras Características de Diseño .........................................................9
Sección 9. Matriz de Trazabilidad de los Requerimientos ..................................10
Sección 9. Matriz de Trazabilidad de los Requerimientos ..................................10
Sección 10.
Referencias ...................................................................................11
Sección 11. Glosario .............................................................................................12
Sección 12. Historial de Revisión .........................................................................13
Sección 13.
Basado en
TS-Plantilla-10DFDSW-1.0
Apéndices .....................................................................................14
Página i
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 1. Introducción
1.1
Propósito
[Especificar el propósito de la Descripción Funcional del Diseño del Software y su audiencia
prevista.]
1.2 Ámbito
[Describir el ámbito del sistema que se va a producir.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 1
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 2. Arquitectura del Sistema
[Proporcionar y describir un gráfico que represente en conjunto la arquitectura global del
sistema.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 2
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 3. Diccionario de Datos
[Proporcionar una referencia a la localización del Diccionario de Datos que contiene una
descripción para cada uno de los elementos de la aplicación software.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 3
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 4. Diseño del Dominio del Software
4.1
Diagrama del Dominio de la Aplicación Software
[Proporcionar una figura que represente el conjunto de dominios de la aplicación software y
muestre los principales componentes y sus relaciones.]
4.2
Dominios de la Aplicación Software
[Personalizar esta sección para que contenga las subsecciones necesarias para documentar de
manera comprensible los dominios, las funciones y las tareas del diseño del software. Cada
subsección se tendrá que etiquetar apropiadamente y titularse en función de un dominio,
componente o tarea específico Describir cada domino en todo el diseño. Representar y describir
la jerarquía de dominios, componentes y tareas.]
4.2.x Dominio X
[Proporcionar un diagrama de la jerarquía de dominio y una descripción en alto nivel para el
Dominio X, así como la familia de componentes que forman dicho dominio. Incluir los dominios
de cualquier base de datos y sus procedimientos y disparadores almacenados. Además, si
resulta apropiado, proporcionar una representación jerárquica de los componentes dentro del
dominio.]
4.2.x.y Componente Y1 del Dominio X
[Proporcionar una descripción en alto nivel del Componente Y1 del Dominio X. Incluir una
descomposición funcional del componente que incluya las funciones en bajo nivel, siguiendo
los principios de diseño top-down.]
4.2.x.y.z Tarea Z del Componente Y1 del Dominio X
[Proporcionar una descripción en alto nivel de la Tarea Z del Componente Y1 del
Dominio X. Si es conveniente para el diseño, proveer también diagramas y narraciones
que especifiquen el flujo de datos o el control a nivel de componente o de tarea.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 4
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 5. Diseño de los Datos
[Personalizar las siguientes subsecciones para describir los datos contenidos en las bases de
datos y otras estructuras de datos compartidas entre los elementos de diseño del diseño del
software, incluyendo datos persistentes/estáticos, datos transitorios/dinámicos, datos externos a
la interfaz y la transformación de los datos. Etiquetar y titular apropiadamente cada subsección.]
5.1
Datos Persistentes/Estáticos
5.1.x Almacén X de los Datos Persistentes/Estáticos
[Describir y proporcionar una representación del modelo lógico de datos o diagramas de entidad
relación para el almacén X de los Datos Persistentes/Estáticos. Incluir el propósito y la
configuración general del almacén de datos.]
5.2
Datos Transitorios/Dinámicos
[Proporcionar una descripción del diseño de los datos transitorios/dinámicos del sistema, así
como su configuración general. Para cada de los elementos de diseño de este tipo de datos,
incluir también su propósito.]
5.3
Datos Externos a la Interfaz
[Describir y, si es apropiado, proporcionar diagramas del diseño de los datos de las interfaces
externas. Incluir el propósito y la configuración global de los elementos de diseño de los datos.]
5.4
Transformación de los Datos
[Describir el diseño del sistema de transformación de los datos. Para cada uno de los elementos
de transformación de los datos, y para las reglas de mapeo de las transformaciones se tendrá
que incluir su propósito y configuración general.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 5
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 6. Diseño de la Interfaz de Usuario
6.1
Visión General del Diseño de la Interfaz de Usuario
[Proporcionar una descripción en alto nivel de la interfaz de usuario para un sistema concreto.
Describir cualquier requerimiento del sistema (por ejemplo, rendimiento y usabilidad) asociado
con todas las interfaces de usuario.]
6.2
Jerarquía de Navegación de la Interfaz de Usuario
[Proporcionar y describir un diagrama de navegación de la jerarquía que ilustre cómo se mueve
un usuario por dentro de la interfaz.]
6.3
Categorías de las Funciones de Usuario (o Casos de Uso)
[Personalizar las subsecciones siguientes para que documenten de forma precisa y
comprensible cada una de las categorías de las funciones de usuario o los casos de uso que
requiere una interfaz. Documentar cada categoría de las funciones de usuario o caso de uso
individual en su subsección correspondiente. Asimismo, también se tendrá que etiquetar y titular
cada una de ellas adecuadamente para que indiquen de forma descriptiva la función o el caso de
uso documentado.]
6.3.x Función (o Caso de Uso) X
[Proporcionar una descripción de la función que soporta esta categoría de interfaces de usuario.]
6.3.x.y Función (o Caso de Uso) X Formato de la Pantalla/Informe de la Interfaz de
Usuario XX
[Proporcionar un descripción y, si es adecuado, una imagen o maqueta de cada pantalla,
informe u otra interfaz de usuario dentro de esta función o caso de uso.]
6.3.x.y.1 Función (o Caso de Uso) X Campos de la Pantalla u otra Interfaz de Usuario XX
[Proporcionar una tabla que, dentro de todas las funciones o casos de uso, incluya
información descriptiva para cada campo de cada pantalla (u otra interfaz de usuario).
Además, si los datos se seleccionan a partir de un listado de selección, se tendrá que
incluir la lista de los posibles valores que se pueden tomar, así como su descripción. Si
el contenido de un campo se deriva en el lado del cliente a partir de cálculos que utilizan
otros campos o valores, es necesario especificar el algoritmo que realiza dicho cómputo
en un pie de nota descriptivo a la tabla. Si el contenido de un campo se deriva a partir de
cálculos o búsquedas en el lado del servidor, también se deberá detallar el cómputo.
Basado en
TS-Plantilla-10DFDSW-1.0
Página 6
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Asimismo, se especificarán también los mensajes de error que se mostrarán cuando las
entradas no cumplan con los requisitos esperados para el campo.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 7
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 7. Otras Interfaces
[Personalizar las subsecciones siguientes para que documenten el diseño de cualquier interfaz
adicionar no descrita en las secciones previas de forma precisa y comprensible, incluyendo las
interfaces específicas entre aplicación-aplicación, base de datos-base de datos, etc. Asimismo,
también se deberá identificar la tecnología que se utilizará para posibilitar la interacción.
Etiquetar y titular cada subsección adecuadamente para que indiquen de forma descriptiva la
interfaz que se va a documentar.]
7.x Interfaz X
[Describir el diseño de la interfaz, incluyendo la tecnología, el protocolo, cualquier formato de
mensaje específico, condiciones de error, inicio y cierre, y otras propiedades que definan el
diseño de la interfaz.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 8
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 8. Otras Características de Diseño
[Describir otras características de diseño no capturadas en las secciones previas.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 9
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 9. Matriz de Trazabilidad de los
Requerimientos
[Proporcionar una referencia a la localización de la Matriz de Trazabilidad de los Requerimientos
que deberá completarse durante el ciclo de vida del proyecto y que indica la trazabilidad desde
los requerimientos del sistema documentados en la Especificación de los Requerimientos del
Sistema hasta los elementos de diseño documentados en la Descripción del Diseño del Sistema,
desde los elementos de diseño documentados en la Descripción del Diseño del Sistema hasta
los requerimientos software documentados en la Especificación de los Requerimientos Software
y desde los requerimientos software documentados en la Especificación de los Requerimientos
Software hasta los elementos de diseño documentados en la Descripción del Diseño Software.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 10
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 10. Referencias
[Proporcionar una lista con todos los documentos y otras fuentes de información de la
Descripción del Diseño del Software y las utilizadas durante su desarrollo. Para cada una de
ellas, es necesario incluir el número de documento, el título, la fecha y el autor.]
Nº Documento
Basado en
TS-Plantilla-10DFDSW-1.0
Título del Documento
Fecha
Página 11
Autor
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 11. Glosario
[Definir todos los términos y acrónimos requeridos para interpretar adecuadamente la
Descripción del Diseño del Software.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 12
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 12. Historial de Revisión
[Identificar los cambios a la Descripción del Diseño del Software.]
Versión
Fecha
Basado en
TS-Plantilla-10DFDSW-1.0
Nombre
Descripción
Página 13
[Organización Cliente]
[Nombre del Proyecto]
DESCRIPCIÓN FUNCIONAL DEL DISEÑO DEL SOFTWARE
[Versión: ##] | [Fecha de Revisión: dd/mm/yyyy]
Sección 13. Apéndices
[Incluir cualquier apéndice relevante.]
Basado en
TS-Plantilla-10DFDSW-1.0
Página 14