res

Reporte de Especificacin de Software (RES)Versin [Nombre del proyecto]

[Este documento es la plantilla base para elaborar el documento Reporte de Especificacin de Software. Los textos que aparecen entre parntesis rectos son explicaciones de que debe contener cada seccin. Dichos textos se deben seleccionar y sustituir por el contenido que corresponda. En caso que alguna de las secciones del presente documento no aplique a su proyecto pueden usarse las frases No hay cambios, No hay impacto en esta seccin, La solucin que se est implementando no tiene impacto en esta seccin, No aplican para el proyecto (No borrar secciones del documento)]

____________________________________________________________________________________Reporte de Especificacin de Software (RES) Pgina 1 de 16

HISTORIAL DE REVISIONESFecha de Elaboraci n

Versin

Autor

Descripcin

Fecha de Revisin

Revisado por


Contenido3.1.DENTRO DEL ALCANCE ......................................................................................................................3 3.2.FUERA DEL ALCANCE........................................................................................................................4 3.3.R ESTRICCIONES................................................................................................................................4 3.4.SUPUESTOS......................................................................................................................................4 4.1.L ISTA DE CASOS DE USO DE NEGOCIO................................................................................................4 4.1.1.L ISTA DE ACTORES DEL NEGOCIO.....................................................................................................5 4.1.2.DIAGRAMA GENERAL DE CASO DEL NEGOCIO.....................................................................................5 4.1.3.E SPECIFICACIN DE LOS CASOS DE USO DEL NEGOCIO..........................................................................5 CUN01 NOMBRE DEL CASO DE USO DEL NEGOCIO..................................................................................5 4.2.R EALIZACIN DE LOS CASOS DE USO DE NEGOCIO..................................................................................5 4.3.L ISTA DE TRABAJADORES DE NEGOCIO.................................................................................................6 4.4.R EGLAS DE NEGOCIO........................................................................................................................6 7.1.L ISTA DE ACTORES DE SISTEMA........................................................................................................10 7.2.DIAGRAMA DE ACTORES DEL SISTEMA................................................................................................10 7.3.ARQUITECTURA DEL SISTEMA DIAGRAMA DE PAQUETES......................................................................11 7.4.L ISTA DE CASOS DE USO DEL SISTEMA POR PAQUETE...........................................................................11 7.5.DIAGRAMA DE CASOS DE USO POR PAQUETE.......................................................................................11 7.6.PRIORIZACIN DE LOS CASOS DE USO DEL SISTEMA..............................................................................11 7.7.MATRIZ DE MODELO DE NEGOCIO Y MODELO DE SISTEMA....................................................................12 7.8.E SPECIFICACIN DE LOS CASOS DE USO DEL SISTEMA...........................................................................13

1.

Antecedentes[Describa la situacin actual y las necesidades o problemas que se pretende atender. Recuerde que debe tomar como informacin base lo registrado en el Reporte de Solicitud de Requerimiento (RSRQ).] Nota: Para el caso de los cursos de quinto y sexto ciclo se puede tomar como referencia tambin el documento de planificacin del proyecto (PP)

2.

Objetivos[Referidos a los objetivos del negocio alineados al producto software. Es la explicacin resumida de los resultados que el negocio quiere lograr con el sistema, estos pueden ser la solucin de alguno o varios problemas, la generacin de nuevas oportunidades de negocio, alguna mejora que los usuarios o clientes necesitan o mejorar la informacin para la toma de decisiones directivas o ejecutivas. Recuerde que puede tomar como informacin base lo registrado en el Reporte de solicitud de requerimiento (SRQ).] Nota: Para el caso de los cursos de quinto y sexto ciclo se puede tomar como referencia tambin el documento de planificacin de proyecto (PP).]

3.

Alcance3.1. Dentro del Alcance

[En esta seccin deber incluir el alcance funcional del producto software, dicho alcance se encuentra tambin definido en el ____________________________________________________________________________________Reporte de Especificacin de Software (RES) Pgina 3 de 16

documento de Planificacin de Proyecto (PP). Es posible detallar el alcance siempre y cuando no vare en cuanto al original definido en el PP. Nota: Para los cursos de ADSI y ADSII se define despus de haber sido obtenida la Matriz de Actividades Vs. Requisitos.]

3.2.

Fuera del Alcance [En esta seccin deber incluir lo que no es parte del alcance funcional del producto software. Se puede tomar como referencia lo indicado en el documento de PP. Es posible detallar lo que queda fuera del alcance siempre y cuando no vare en cuanto al original definido en el PP. Nota: Para los cursos de ADSI y ADSII se define despus de haber sido obtenida la Matriz de Actividades Vs. Requisitos.]

3.3.

Restricciones [En esta seccin deber incluir las restricciones de la solucin propuesta relacionados al software, hardware y a la funcionalidad as como lo referido a los lmites que impone la empresa contratante en el desarrollo del producto software.] Nota: Para el caso de los cursos de quinto y sexto ciclo puede tomar como referencia la seccin de restricciones del documento de planificacin de proyecto (PP).

3.4.

Supuestos [En esta seccin deber incluir los principales supuestos relacionados con la implementacin del sistema y lo referido a lo que la empresa contratante posee a nivel de tecnologas de informacin.] Nota: Para el caso de los cursos de quinto y sexto ciclo puede tomar como referencia la seccin de supuestos del documento de planificacin de proyecto (PP).

4.

Procesos de Negocio4.1. Lista de Casos de Uso de Negocio [En esta seccin deber listar los casos de uso de negocio que se obtuvieron a partir de los procesos de negocio identificados dentro del mbito de la solucin y a los cuales se les dar el soporte con el producto software. Cada Caso de Uso de Negocio deber ser identificado con un cdigo nico y correlativo. Ejemplo CUN01. De ser necesario deber incorporar un diagrama de casos de uso de negocio.]

Caso de uso del negocio CUN01 [NombreReporte de Especificacin de Software (RES)

Descripcin

____________________________________________________________________________________Pgina 4 de 16

del CUN01] CUN02 [Nombre del CUN02]

[Descripcin del flujo de trabajo del CUN01.] [Descripcin del flujo de trabajo del CUN02.]

4.1.1. Lista de Actores del Negocio [En esta seccin deber listar a los actores de negocio incluyendo una descripcin por cada uno.] Actor del Negocio Descripcin

4.1.2. Diagrama General de Caso del Negocio [En esta seccin deber graficar el Diagrama general de Casos de uso del Negocio.]

4.1.3. Especificacin de los Casos de Uso del Negocio[Por cada caso de uso de negocio deber indicar el flujo de trabajo del Caso de Uso del Negocio. Deber usar la plantilla que a continuacin se detalla:

CUN01 Nombre del Caso de Uso del Negocio 1. 2. Breve Descripcin Objetivo Reutilizar el resumen del punto 4.1 Referido al negocio y alineado al producto software.

3.3.1 3.2 4. 5.

Flujo de Trabajo Flujo Bsico 1. 1. Indicar el flujo bsico del CUN Detalle del flujo alterno. Flujos Alternativos Categora Gestor del proceso

Se coloca si es bsica, estratgica o de apoyo. Se identifica a la persona que est interesada en el xito o fracaso del proceso. 4.2. Realizacin de los Casos de Uso de Negocio [En esta seccin deber desarrollar los diagramas de actividades y diagrama de clases de negocio por cada Caso de Uso de Negocio identificado en la seccin 4.1. Por cada juego de diagramas deber identificar cules sern las actividades que sern automatizadas.]


4.3.

Lista de Trabajadores de Negocio [En esta seccin deber listar a los trabajadores incluyendo una descripcin por cada uno.] Trabajador del Negocio Descripcin de negocio

4.4.

Reglas de Negocio [En esta seccin deber identificar las reglas que regulan la estructura del negocio y cmo ellos operan afectando el funcionamiento de los procesos de negocio. Dichas reglas de negocio son las que se considerarn para el diseo del sistema. Cada Regla de Negocio deber ser identificada con un cdigo nico y correlativo. Ejemplo: RN01. Para identificar las reglas de negocio puede considerar la siguiente clasificacin: Reglas de Estructura: Ejemplo (Todo pedido debe ser realizado por un cliente, y que el mismo debe estar dado de alta. Adems una vez que el cliente haya hecho algn pedido, se deber garantizar que no es posible eliminarlo, al menos que previamente se eliminen todos sus pedidos) Reglas de Derivacin: Ejemplo (El total de un pedido se puede calcular a partir de distintas lneas que lo componen, mientras que el total de cada lnea se puede calcular a partir del nmero de unidades vendidas y el precio por unidad) Reglas de Interfaz o de Modelo de Datos: Ejemplo (No hay precio de artculos negativos, el sexo de una persona slo puede ser masculino o femenino, una fecha tiene que ser siempre una fecha vlida - no existe 30 de febrero) Reglas de Operacin o Reglas de Flujo: Ejemplo (Un cliente puede hacer una peticin de anlisis al laboratorio que anota un encargado: hecho esto, se genera un parte para uno o ms analistas, estos realizan las mediciones correspondientes y devuelven los partes con la informacin pertinente, a partir de la cual se genera un informe de anlisis, que ser un anlisis vlido solo cuando sea firmado por los responsables de garantizar su correccin)

CdigoRN-001 RN-002

Descripcin[Descripcin de la Regla 001] [Descripcin de la Regla 002]

RN-00n


5.

Requisitos Funcionales[De acuerdo a lo solicitado explcitamente por el rea usuaria, listar todos los requisitos funcionales del producto software. Considere que los requisitos funcionales que liste debern ser asociados posteriormente a los casos de uso (funciones de software). Cada Requisito Funcional deber ser identificado con un cdigo nico y correlativo. Ejemplo: RF01. Nota: Esta lista proviene de la Matriz de Actividades Vs. Requisitos. Y de la Matriz de Requisitos Funcionales Adicionales.]

Cdigo[Cdigo del requisito funcional] RF-001 RF-002 ... RF-00n

Descripcin

Proceso de Negocio

[Identificador del [Descripcin detallada del requisito proceso de negocio funcional.] asociado] [Descripcin detallada del requisito [CUN01] funcional 1.] [Descripcin detallada del requisito funcional 2.] .... [Descripcin detallada del requisito funcional n.]

6.

Requisitos No Funcionales[Listar los requisitos no funcionales los mismos que debern ser considerados para el modelo de calidad de producto. Cada Requisito No Funcional deber ser identificado con un cdigo nico y correlativo. Ejemplo: RNF01.]

Tipo de Requisito [Nombre del tipo de requisito no funcional] Restricciones del Diseo

Cdigo [Cdigo del requisito no funcional]

Descripcin [Descripcin detallada del requisito no funcional.]

Implementacin [Describir como se implementar el RNF-00n]

[Definir cualquier tipo de restriccin de diseo, tales como: proceso de desarrollo de software, sistemas operativos, RNF-001 lenguajes de programacin, administrador de base de datos, conexin a la BD, generador de reportes, manejo de informacin, etc.] RNF-002

[Descripcin detallada del requisito no funcional 1.]

[Descripcin detallada del requisito no funcional 2.]Pgina 7 de 16

____________________________________________________________________________________Reporte de Especificacin de Software (RES)

Tipo de Requisito Componentes a Adquirir [Identificar los componentes que se deben adquirir o tener en cuenta, para llevar acabo el desarrollo y ejecucin del sistema. Ejemplo: lenguajes de programacin, servidores, estaciones de trabajo, etc.]

Cdigo

Descripcin

Implementacin

RNF-003


RNF-004


Interfaces de Usuario [Describir las interfaces de usuario que sern implementados en el software. Esto incluye por ejemplo: formatos de la pantalla, pgina o esquemas de las ventanas, reportes, mens, etc.]

RNF-005


RNF-006


Interfaces de Hardware [Definir cualquier interfase de hardware que ser soportado por el software, incluyendo estructura lgica, direcciones fsicas, etc.] RNF-007 [Descripcin detallada del requisito no funcional 7.]

RNF-008


Interfaces de Software [Especificar el uso de otros productos software RNF-009 requeridos e interfaces con otros sistemas de la aplicacin.]Reporte de Especificacin de Software (RES)


____________________________________________________________________________________Pgina 8 de 16

Tipo de Requisito

Cdigo RNF-010

Descripcin [Descripcin detallada del requisito no funcional 10.]

Implementacin

Interfaces de Comunicaciones [Describir las interfaces de comunicacin para RNF-011 otros sistemas dispositivos, tales como: redes de rea local, dispositivos de serie remota.] RNF-012 Requerimientos de Licenciamiento [Identificar las licencias que se requieran para el desarrollo del sistema.] RNF-013 [Descripcin detallada del requisito no funcional 11.]

[Descripcin detallada del requisito no funcional 12.] [Descripcin detallada del requisito no funcional 13.] [Descripcin detallada del requisito no funcional 14.] [Descripcin detallada del requisito no funcional 15.] [Descripcin detallada del requisito no funcional 16.] [Descripcin detallada del requisito no funcional 17.] [Descripcin detallada del requisito no funcional 18.]

RNF-014

Seguridad [Describir como ser controlada la seguridad del sistema.] RNF-015

RNF-016

Estndares aplicables [Especificar con qu estndares trabaja el sistema.] RNF-017

RNF-018


Tipo de Requisito Requisitos del Sistema [Especificar los requerimientos de plataforma tecnolgica necesarios para el diseo y el desarrollo del sistema.]

Cdigo

Descripcin

Implementacin

RNF-019


RNF-020


Requisitos de Desempeo [Listar y especificar los requisitos de desempeo con los que debe trabajar el sistema. Ejemplo: Tiempo de respuesta en alguna consulta del sistema.] [Descripcin detallada del requisito no funcional 21.]

RNF-021

RNF-022


7.

Modelo de Casos de Uso del Sistema[En esta seccin deber desarrollar el modelo de sistema o modelo de requisitos. Para ello deber indicar los actores de sistemas, la arquitectura de sistema (organizada en paquetes) y la relacin de casos de uso por cada paquete. Cada Caso de Uso deber ser identificado con un cdigo nico y correlativo. Ejemplo: CUS01.] 7.1. Lista de Actores de Sistema [Listar a los actores de sistema.] Actor del sistema Descripcin

7.2.

Diagrama de Actores del Sistema [Incorpore el diagrama de actores del sistema.]


7.3.

Arquitectura del Sistema Diagrama de Paquetes [Incorpore el diagrama de paquetes que representa la arquitectura modular del sistema. Cada Paquete deber ser identificado con un cdigo nico y correlativo. Ejemplo: P01.]

7.4.

Lista de Casos de Uso del Sistema por Paquete [En esta seccin deber listar todos los casos de uso del sistema que se han identificado. Para hacerlo deber tomar como referencia la organizacin del sistema de acuerdo al diagrama de paquetes del punto 7.3.] Paquete: P01 Nombre del Paquete Caso de uso del sistema CUS01 [Nombre del Caso de Uso] CUS02 [Nombre del Caso de Uso] Descripcin [Descripcin del caso de uso. En la descripcin deber indicar las acciones que permitir el caso de uso.] [Descripcin del caso de uso. En la descripcin deber indicar las acciones que permitir el caso de uso.]

7.5.

Diagrama de Casos de Uso por Paquete [Incorpore el diagrama de casos del uso del sistema de acuerdo a los paquetes y la lista trabajada en el punto 7.4.] Paquete: P01 Nombre del Paquete

7.6.

Priorizacin de los Casos de Uso del Sistema 7.6.1. Clasificacin de los Casos de Uso del Sistema [En esta seccin deber clasificar los casos de uso de sistema indicando si son primarios o secundarios.] 0,4 0,3 0,2RIESGO

0,1IMPACTO RNF

CASO DE USO CUS01-XXXXXX CUS02-XXXXXX CUS03-XXXXXX

IMPORTANCIA COMPLEJIDAD

TOTAL

CLASIFICACIN DE CU Primario Secundario Secundario

7.6.2.

Ciclos de Desarrollo de los Casos de Uso del Sistema [En esta seccin deber indicar en qu ciclo de desarrollo se trabajarn cada uno de los casos de uso del sistema.] Nombre del caso de uso CUS01 Nombre del caso de uso CUS02 Nombre del caso de uso CUS03 Nombre del caso de uso Clasificacin Primario Secundario Secundario

Ciclo de desarrollo Ncleo central o Ciclo 0 Ciclo 1


7.7.

Matriz de Modelo de Negocio y Modelo de Sistema [En esta seccin deber incluir una matriz en la que se pueda evidenciar la trazabilidad entre los procesos de negocio y las funciones del producto software.]

Caso del uso del negocio N Nombr e N 1

Actividad a automatizar NombreActividad a ser automatizada Actividad a ser automatizada Actividad a ser automatizada

Requerimient o funcional N NombreRF001 Requisito Funcional

Caso de uso del sistema N Nombr e ActorActor

Responsabl eTrabajador de Negocio Trabajador de Negocio Trabajador de Negocio

CUN01 Caso de Uso de Negocio

CUS01 Casos de Uso de Sistema

2

3


7.8.

Especificacin de los Casos de Uso del Sistema 7.8.1. Especificacin de Alto Nivel [En esta seccin deber incluir la especificacin de alto nivel de los casos de uso del sistema. Asimismo deber indicar que requisitos funcionales estn asociados a cada caso de uso, tomando como referencia lo indicado en la matriz del punto 7.7.] CUS01 Nombre del Caso de Uso Nombre del actor Indicar el propsito del caso de uso Indicar si existe algn caso de uso asociado. De no haber indicar No Aplica. Describir brevemente el caso de uso. Para ello deber indicar como empieza el caso de uso, que actividades desarrolla y como termina. Indicar la clasificacin del caso de uso Indicar el(los) cdigos de requisitos funcionales asociados.

Caso de uso: Actor(es): Propsito: Caso de uso asociado: Resumen:

Clasificacin Requisitos

7.8.2.

Especificacin Expandida [Por cada caso de uso de sistema especificado deber incluir la especificacin expandida de casos de uso. Para ello deber indicar el flujo bsico y los flujos alternos e incorporar el prototipo con la inclusin de los controles. Deber usar la plantilla que a continuacin se detalla:

CUS01 Nombre del caso de Uso 1. 2. 3. 4. Actores Indicar la lista de actores Propsito Indicar el propsito Breve Descripcin Reutilizar el resumen del punto 7.4 Flujo Bsico de Eventos Indicar el flujo bsico de eventos Es posible hacer referencia a las reglas de negocio. 5. 6. Sub Flujos Indicar los subflujos del flujo bsico. Flujos Alternos 6.1. Nombre del flujo alterno 1. Detalle del Flujo alterno


Se pueden incluir reglas de negocio. 7. Precondiciones Descripcin de la precondicin 8. Pos condiciones Descripcin de la pos condicin 9. Puntos de Extensin Indicar si existen puntos de extensin. 10. Requerimientos Especiales Indicar si existen requerimientos especiales. 11. Prototipos Incluir los prototipos asociados al caso de uso.

8.

Flujo General de Navegacin[Incluir un rbol de navegacin que permita entender el flujo que se seguir en la navegacin por el aplicativo. El siguiente ejemplo muestra un rbol de navegacin: Aplicacin/mdulo/opcin/subopcin]Ver Agenda Encargar Accin Ver Acciones Ver Alarmas Accin Propia

Agenda

APLICACIO

N

Clientes

Consultar

Parmetro s Resultado s Razone s Matriz CAP

Tabla s

Mantenimient o

Relacione s

Matriz GAF

Acciones Enviadas Avance s Reportes Resultados Histricos Resultado de Accione s Seguimiento Semanal


9.

Esquema de Seguridad[En esta se documenta los esquemas de seguridad en base a perfiles y su acceso a su informacin. Para ello se utiliza una matriz de perfiles de usuario y accesos por Aplicativo/Mdulo/Funcin.] Aplicativo Perfil 1 Perfil 2 x x x x x x

Funciones por Mdulo Mdulo A Consulta de informacin de empresas Consulta de operadores autorizados Modificacin de operadores autorizados Mdulo B Modificacin de cuentas afiliadas Modificacin de combinaciones autorizadas

... X X X

Perfil N x x x

x x

x x

X X

x x

10. Modelo de Anlisis 10.1. Realizacin de Casos de Uso Anlisis[Esta seccin ilustra cmo el software trabaja a partir de los casos de uso o escenarios seleccionados, y explica cmo varios elementos del modelo de anlisis contribuyen con ellos funcionalmente. Por cada caso de uso deber desarrollar un diagrama de secuencia y de clases de anlisis. Para ello deber usar el patrn MVC. Para la realizacin deber identificar los escenarios. Dichos escenarios se obtienen de las combinaciones entre el flujo principal y flujos alternativos del la especificacin expandida de casos de uso (ver punto 7.8.2).]

Cdigo del CUS Nombre del CUS Nombre del Escenario[Identifica el escenario a ser realizado y una breve descripcin. Se recomienda identificar con un cdigo nico a cada escenario. Por ejemplo ESC01]

Diagrama de Secuencia de Anlisis[Incluya el diagrama de secuencia de anlisis en el cual se observe el uso del patrn MVC que implementa el escenario identificado.]

Diagrama de Clases de Anlisis[Incluya el diagrama de clases de anlisis obtenido del conjunto de diagramas de secuencia que se implementan por cada escenario.]

11. Modelo Conceptual[Esta seccin ilustra cmo a partir de las clases del tipo entidad se pueden identificar una primera propuesta de modelo de persistencia. Para ello se utiliza un diagrama clases por cada paquete que forma parte de la ____________________________________________________________________________________Reporte de Especificacin de Software (RES) Pgina 15 de 16

arquitectura del sistema. Se puede hacer uso de tarjetas CRC para documentar las responsabilidades y colaboraciones de cada clase de persistencia identificada.]


res

Documents

Transcript of res