Reporte de Especificación de Software (RES) : Versión (Nombre Del Proyecto)

Descargar como doc, pdf o txt
Descargar como doc, pdf o txt
Está en la página 1de 16

Reporte de

Especificación de
Software (RES)
Versión <1.0>

[Nombre del proyecto]

[Este documento es la plantilla base para elaborar el documento Reporte de


Especificación de Software. Los textos que aparecen entre paréntesis rectos son
explicaciones de que debe contener cada sección. 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 sección”, “La solución que se
está implementando no tiene impacto en esta sección”, “No aplican para el
proyecto” (No borrar secciones del documento)]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 1 de 16
HISTORIAL DE REVISIONES

Fecha de
Versió Fecha de Revisado
Autor Descripción Elaboració
n Revisión por
n
<Persona <Persona(s)
<Fecha de
que elabora <Fecha de que revisa(n)
<x.x> <Detalles> Elaboración
el Revisión> el
>
documento> documento>

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 2 de 16
Contenido
1. Antecedentes............................................................................................4

2. Objetivos..................................................................................................4

3. Alcance.....................................................................................................4
3.1. DENTRO DEL ALCANCE.............................................................................................................4
3.2. FUERA DEL ALCANCE......................................................................................................... 4
3.3. RESTRICCIONES................................................................................................................. 4
3.4. SUPUESTOS........................................................................................................................ 5

4. Procesos de Negocio...........................................................................5
4.1. LISTA DE CASOS DE USO DE NEGOCIO..........................................................................5
4.1.1. LISTA DE ACTORES DEL NEGOCIO................................................................................5
4.1.2. DIAGRAMA GENERAL DE CASO DEL NEGOCIO..............................................................5
4.1.3. ESPECIFICACIÓN DE LOS CASOS DE USO DEL NEGOCIO.............................................5
CUN01 – Nombre del Caso de Uso del Negocio.............................................................................5
4.2. REALIZACIÓN DE LOS CASOS DE USO DE NEGOCIO........................................................6
4.3. LISTA DE TRABAJADORES DE NEGOCIO............................................................................6
4.4. REGLAS DE NEGOCIO........................................................................................................ 6

5. Requisitos Funcionales......................................................................7

6. Requisitos No Funcionales...............................................................7

7. Modelo de Casos de Uso del Sistema.........................................10


7.1. LISTA DE ACTORES DE SISTEMA.....................................................................................10
7.2. DIAGRAMA DE ACTORES DEL SISTEMA...........................................................................10
7.3. ARQUITECTURA DEL SISTEMA – DIAGRAMA DE PAQUETES............................................10
7.4. LISTA DE CASOS DE USO DEL SISTEMA POR PAQUETE.................................................10
7.5. DIAGRAMA DE CASOS DE USO POR PAQUETE................................................................11
7.6. PRIORIZACIÓN DE LOS CASOS DE USO DEL SISTEMA...................................................11
7.7. MATRIZ DE MODELO DE NEGOCIO Y MODELO DE SISTEMA...........................................12
7.8. ESPECIFICACIÓN DE LOS CASOS DE USO DEL SISTEMA................................................12
CUS01 – Nombre del caso de Uso....................................................................................................13

8. Flujo General de Navegación.........................................................14

9. Esquema de Seguridad....................................................................15

10. Modelo de Análisis..........................................................................15

11. Modelo Conceptual..............................................................................15

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 3 de 16
1. Antecedentes
[Describa la situación actual y las necesidades o problemas que se pretende
atender. Recuerde que debe tomar como información base lo registrado en la
solicitud de requerimiento (SRQ).]

Nota:
Para el caso de los cursos de quinto y sexto ciclo se puede tomar como
referencia también el documento de planificación del proyecto (PP)

2. Objetivos
[Referidos a los objetivos del negocio alineados al producto software. Es la
explicación resumida de los resultados que el negocio quiere lograr con el
sistema, estos pueden ser la solución de alguno o varios problemas, la
generación de nuevas oportunidades de negocio, alguna mejora que los
usuarios o clientes necesitan o mejorar la información para la toma de
decisiones directivas o ejecutivas. Recuerde que puede tomar como
información base lo registrado en la solicitud de requerimiento (SRQ).]

Nota:
Para el caso de los cursos de quinto y sexto ciclo se puede tomar como
referencia también el documento de planificación de proyecto (PP).]

3. Alcance

3.1. Dentro del Alcance


[En esta sección deberá incluir el alcance definido en el PP. Es posible
detallar el alcance siempre y cuando no varíe en cuanto al original
definido en el PP.
Nota: Para los cursos de ADSI y ADSII se define después de haber
sido obtenida la Matriz de Actividades Vs. Requisitos.]

3.2. Fuera del Alcance


[En esta sección deberá incluir lo que no es parte del alcance del
proyecto definido en el PP. Es posible detallar lo que queda fuera del
alcance siempre y cuando no varíe en cuanto al original definido en el
PP.
Nota: Para los cursos de ADSI y ADSII se define después de haber
sido obtenida la Matriz de Actividades Vs. Requisitos.]

3.3. Restricciones
[En esta sección deberá incluir las restricciones de la solución
propuesta relacionados al software, hardware y a la funcionalidad así
como lo referido a los límites 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 sección de restricciones del documento de planificación
de proyecto (PP).

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 4 de 16
3.4. Supuestos
[En esta sección deberá incluir los principales supuestos relacionados
con la implementación del sistema y lo referido a lo que la empresa
contratante posee a nivel de tecnologías de información.]

Nota:
Para el caso de los cursos de quinto y sexto ciclo puede tomar como
referencia la sección de supuestos del documento de planificación de
proyecto (PP).

4. Procesos de Negocio

4.1. Lista de Casos de Uso de Negocio


[En esta sección deberá listar los casos de uso de negocio que se
obtuvieron a partir de los procesos de negocio identificados dentro del
ámbito de la solución y a los cuales se les dará el soporte con el
producto software. Cada Caso de Uso de Negocio deberá ser
identificado con un código único y correlativo. Ejemplo CUN01. De ser
necesario deberá incorporar un diagrama de casos de uso de negocio.]

Caso de uso del negocio Descripción


CUN01 – [Nombre
del CUN01] [Descripción del flujo de trabajo del CUN01.]
CUN02 – [Nombre
del CUN02] [Descripción del flujo de trabajo del CUN02.]

4.1.1. Lista de Actores del Negocio


[En esta sección deberá listar a los actores de negocio incluyendo una
descripción por cada uno.]
Actor del Negocio Descripción

4.1.2. Diagrama General de Caso del Negocio


[En esta sección deberá graficar el Diagrama general de Casos de uso
del Negocio.]

4.1.3. Especificación 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 continuación se
detalla:

CUN01 – Nombre del Caso de Uso del Negocio


1 Breve Descripción
Reutilizar el resumen del punto 4.1
2 Objetivo
Referido al negocio y alineado al producto software.
____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 5 de 16
3 Flujo de Trabajo
3.1 Flujo Básico
1. Indicar el flujo básico del CUN
3.2 Flujos Alternativos
1. Detalle del flujo alterno.
4 Categoría
Se coloca si es básica, estratégica o de apoyo.
5 Gestor del proceso
Se identifica a la persona que está interesada en el éxito o fracaso
del proceso.

4.2. Realización de los Casos de Uso de Negocio


[En esta sección deberá desarrollar los diagramas de actividades y
diagrama de clases de negocio por cada Caso de Uso de Negocio
identificado en la sección 4.1. Por cada juego de diagramas deberá
identificar cuáles serán las actividades que serán automatizadas.]

4.3. Lista de Trabajadores de Negocio


[En esta sección deberá listar a los trabajadores de negocio
incluyendo una descripción por cada uno.]
Trabajador del
Descripción
Negocio

4.4. Reglas de Negocio


[En esta sección deberá identificar las reglas que regulan la estructura
del negocio y cómo ellos operan afectando el funcionamiento de los
procesos de negocio. Dichas reglas de negocio son las que se
considerarán para el diseño del sistema. Cada Regla de Negocio
deberá ser identificada con un código único y correlativo. Ejemplo:
RN01. Para identificar las reglas de negocio puede considerar la
siguiente clasificación:

Reglas de Estructura: Ejemplo (Todo pedido debe ser realizado por un


cliente, y que el mismo debe estar dado de alta. Además una vez que
el cliente haya hecho algún pedido, se deberá garantizar que no es
posible eliminarlo, al menos que previamente se eliminen todos sus
pedidos)

Reglas de Derivación: Ejemplo (El total de un pedido se puede calcular


a partir de distintas líneas que lo componen, mientras que el total de
cada línea se puede calcular a partir del número de unidades vendidas
y el precio por unidad)

Reglas de Interfaz o de Modelo de Datos: Ejemplo (No hay precio de


artículos negativos, el sexo de una persona sólo puede ser masculino
o femenino, una fecha tiene que ser siempre una fecha válida - no
existe 30 de febrero)
____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 6 de 16
Reglas de Operación o Reglas de Flujo: Ejemplo (Un cliente puede
hacer una petición de análisis al laboratorio que anota un encargado:
hecho esto, se genera un parte para uno o más analistas, estos
realizan las mediciones correspondientes y devuelven los partes con la
información pertinente, a partir de la cual se genera un informe de
análisis, que será un análisis válido solo cuando sea firmado por los
responsables de garantizar su corrección)

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

Código Descripción Proceso de Negocio


[Código del [Identificador del
[Descripción detallada del requisito
requisito proceso de negocio
funcional.]
funcional] asociado]
[Descripción detallada del requisito [CUN01]
RF-001
funcional 1.]
[Descripción detallada del requisito
RF-002
funcional 2.]

... ....
[Descripción detallada del requisito
RF-00n
funcional n.]

6. Requisitos No Funcionales
[Listar los requisitos no funcionales los mismos que deberán ser
considerados para el modelo de calidad de producto. Cada Requisito No
Funcional deberá ser identificado con un código único y correlativo. Ejemplo:
RNF01.]

Tipo de Requisito Código Descripción


[Código del [Descripción detallada
[Nombre del tipo de
requisito no del requisito no
requisito no funcional]
funcional] funcional.]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 7 de 16
Tipo de Requisito Código Descripción
Restricciones del Diseño
[Definir cualquier tipo de
restricción de diseño, tales
como: proceso de desarrollo
de software, sistemas [Descripción detallada
operativos, lenguajes de RNF-001 del requisito no
programación, administrador funcional 1.]
de base de datos, conexión
a la BD, generador de
reportes, manejo de
información, etc.]
[Descripción detallada
RNF-002 del requisito no
funcional 2.]
Componentes a Adquirir
[Identificar los componentes
que se deben adquirir o
tener en cuenta, para llevar [Descripción detallada
acabo el desarrollo y RNF-003 del requisito no
ejecución del sistema. funcional 3.]
Ejemplo: lenguajes de
programación, servidores,
estaciones de trabajo, etc.]
[Descripción detallada
RNF-004 del requisito no
funcional 4.]
Interfaces de Usuario
[Describir las interfaces de
usuario que serán
implementados en el [Descripción detallada
software. Esto incluye por RNF-005 del requisito no
ejemplo: formatos de la funcional 5.]
pantalla, página o esquemas
de las ventanas, reportes,
menús, etc.]

[Descripción detallada
RNF-006 del requisito no
funcional 6.]

Interfaces de Hardware
[Definir cualquier interfase [Descripción detallada
de hardware que será RNF-007 del requisito no
soportado por el software, funcional 7.]
incluyendo estructura lógica,
direcciones físicas, etc.]

[Descripción detallada
RNF-008 del requisito no
funcional 8.]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 8 de 16
Tipo de Requisito Código Descripción
Interfaces de Software
[Especificar el uso de otros [Descripción detallada
productos software RNF-009 del requisito no
requeridos e interfaces con funcional 9.]
otros sistemas de la
aplicación.]

[Descripción detallada
RNF-010 del requisito no
funcional 10.]

Interfaces de
Comunicaciones
[Describir las interfaces de [Descripción detallada
comunicación para otros RNF-011 del requisito no
sistemas ó dispositivos, funcional 11.]
tales como: redes de área
local, dispositivos de serie
remota.]

[Descripción detallada
RNF-012 del requisito no
funcional 12.]

Requerimientos de
Licenciamiento [Descripción detallada
[Identificar las licencias que RNF-013 del requisito no
se requieran para el funcional 13.]
desarrollo del sistema.]

[Descripción detallada
RNF-014 del requisito no
funcional 14.]

Seguridad
[Descripción detallada
[Describir como será RNF-015 del requisito no
controlada la seguridad del funcional 15.]
sistema.]
[Descripción detallada
RNF-016 del requisito no
funcional 16.]
Estándares aplicables
[Descripción detallada
[Especificar con qué RNF-017 del requisito no
estándares trabaja el funcional 17.]
sistema.]

[Descripción detallada
RNF-018 del requisito no
funcional 18.]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 9 de 16
Tipo de Requisito Código Descripción
Requisitos del Sistema
[Especificar los [Descripción detallada
requerimientos de RNF-019 del requisito no
plataforma tecnológica funcional 19.]
necesarios para el diseño y
el desarrollo del sistema.]

[Descripción detallada
RNF-020 del requisito no
funcional 20.]

Requisitos de Desempeño
[Listar y especificar los
requisitos de desempeño [Descripción detallada
con los que debe trabajar el RNF-021 del requisito no
sistema. Ejemplo: Tiempo funcional 21.]
de respuesta en alguna
consulta del sistema.]
[Descripción detallada
RNF-022 del requisito no
funcional 22.]

7. Modelo de Casos de Uso del Sistema


[En esta sección 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 relación de casos de uso por cada
paquete. Cada Caso de Uso deberá ser identificado con un código único y
correlativo. Ejemplo: CUS01.]

7.1. Lista de Actores de Sistema


[Listar a los actores de sistema.]

Actor del sistema Descripción

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
código único y correlativo. Ejemplo: P01.]

7.4. Lista de Casos de Uso del Sistema por Paquete


[En esta sección deberá listar todos los casos de uso del sistema que
se han identificado. Para hacerlo deberá tomar como referencia la

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 10 de 16
organización del sistema de acuerdo al diagrama de paquetes del
punto 7.3.]
Paquete: P01 – Nombre del Paquete
Caso de uso del sistema Descripción

CUS01 – [Nombre del [Descripción del caso de uso. En la


Caso de Uso] descripción deberá indicar las acciones
que permitirá el caso de uso.]
CUS02 – [Nombre del [Descripción del caso de uso. En la
Caso de Uso] descripción 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. Priorización de los Casos de Uso del Sistema

7.6.1. Clasificación de los Casos de Uso del Sistema


[En esta sección deberá clasificar los casos de uso de sistema
indicando si son principales o secundarios.]

0,4 0,3 0,2 0,1 CLASIFICACIÓ


CASO DE USO IMPORTANCIA COMPLEJIDAD RIESGO IMPACTO RNF TOTAL N DE CU
CUS01-XXXXXX Primario
CUS02-XXXXXX Secundario
CUS03-XXXXXX Secundario

7.6.2. Ciclos de Desarrollo de los Casos de Uso del Sistema


[En esta sección deberá indicar en qué ciclo de desarrollo se
trabajarán cada uno de los casos de uso del sistema.]

Ciclo de desarrollo Nombre del caso de uso Clasificación


Núcleo central o Ciclo 0 CUS01 – Nombre del caso de uso Primario
Ciclo 1 CUS02 – Nombre del caso de uso Secundario
CUS03 – Nombre del caso de uso Secundario

7.7. Matriz de Modelo de Negocio y Modelo de Sistema


[En esta sección 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 Actividad a automatizar Requerimient Caso de uso del


del negocio o funcional sistema

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 11 de 16
Nº Nombr N Nombre Responsabl Nº Nombre Nº Nombr Acto
e º e e r
CUN01 Caso de 1 Actividad a Trabajador de RF- Requisito CUS01 Casos de Actor
Uso de ser Negocio 001 Funcional Uso de
Negocio automatizada Sistema
2 Actividad a Trabajador de
ser Negocio
automatizada
3 Actividad a Trabajador de
ser Negocio
automatizada

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 12 de 16
7.8. Especificación de los Casos de Uso del Sistema

7.8.1. Especificación de Alto Nivel


[En esta sección deberá incluir la especificación de alto nivel
de los casos de uso del sistema. Asimismo deberá indicar que
requisitos funcionales están asociados a cada caso de uso,
tomando como referencia lo indicado en la matriz del punto
7.7.]

Caso de uso: CUS01 – Nombre del Caso de Uso


Actor(es): Nombre del actor
Propósito: Indicar el propósito del caso de uso
Caso de uso Indicar si existe algún caso de uso asociado. De no
asociado: haber indicar No Aplica.
Resumen: Describir brevemente el caso de uso. Para ello
deberá indicar como empieza el caso de uso, que
actividades desarrolla y como termina.
Clasificación Indicar la clasificación del caso de uso
Requisitos Indicar el(los) códigos de requisitos funcionales
asociados.

7.8.2. Especificación Expandida


[Por cada caso de uso de sistema especificado deberá incluir
la especificación expandida de casos de uso. Para ello deberá
indicar el flujo básico y los flujos alternos e incorporará el
prototipo con la inclusión de los controles. Deberá usar la
plantilla que a continuación se detalla:

CUS01 – Nombre del caso de Uso


6 Actores
Indicar la lista de actores
7 Propósito
Indicar el propósito
8 Breve Descripción
Reutilizar el resumen del punto 7.4
9 Flujo Básico de Eventos
2. Indicar el flujo básico de eventos
3. Es posible hacer referencia a las reglas de negocio.
10 Subflujos
Indicar los subflujos del flujo básico.
11 Flujos Alternativos
6.1. Nombre del subflujo
1. Detalle del flujo alterno.

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 13 de 16
2. Se pueden incluir reglas de negocio.
12 Precondiciones
1.1. Nombre de la precondición
Descripción de la precondición

1.2. Perfil de usuario


Indicar el perfil de usuario que interactúa con el caso de uso

2. Poscondiciones
2.1. Nombre de la poscondición
Descripción de la poscondición

3. Puntos de Extensión
Indicar si existen puntos de extensión.
4. Requerimientos Especiales
Indicar si existen requerimientos especiales.
5. Prototipos
Incluir los prototipos asociados al caso de uso.

8. Flujo General de Navegación


[Incluir un árbol de navegación que permita entender el flujo que se seguirá
en la navegación por el aplicativo. El siguiente ejemplo muestra un árbol de
navegación:Aplicación/módulo/opción/subopción]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 14 de 16
Ver Agenda

Encargar Acción

Agenda Ver Acciones

Ver Alarmas

Acción Propia

APLICACION Clientes Consultar


Parámetros

Tablas Resultados

Razones
Mantenimiento

Matriz CAP

Relaciones

Matriz GAF

Acciones Enviadas

Avances

Reportes Resultados Históricos

Resultado de
Acciones

Seguimiento Semanal

9. Esquema de Seguridad
[En esta se documenta los esquemas de seguridad en base a perfiles y su acceso a
su información. Para ello se utiliza una matriz de perfiles de usuario y accesos por
Aplicativo/Módulo/Función.]

Aplicativo
Funciónes por Módulo Perfil 1 Perfil 2 ... Perfil N
Módulo A x x X x
Consulta de información de
empresas
Consulta de operadores x x X x
autorizados
Modificación de operadores x x X x
autorizados

Módulo B
Modificación de cuentas x x X x
afiliadas
Modificación de combinaciones x x X x
autorizadas

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 15 de 16
10. Modelo de Análisis
10.1. Realización de Casos de Uso – Análisis
[Esta sección ilustra cómo el software trabaja a partir de los casos
de uso o escenarios seleccionados, y explica cómo varios elementos
del modelo de análisis contribuyen con ellos funcionalmente. Por
cada caso de uso deberá desarrollar un diagrama de secuencia y de
clases de análisis. Para ello deberá usar el patrón MVC. Para la
realización deberá identificar los escenarios. Dichos escenarios se
obtienen de las combinaciones entre el flujo principal y flujos
alternativos del la especificación expandida de casos de uso (ver
punto 7.8.2).]

Código del CUS – Nombre del CUS


Nombre del Escenario
[Identifica el escenario a ser realizado y una breve descripción. Se
recomienda identificar con un código único a cada escenario. Por
ejemplo ESC01]

Diagrama de Secuencia de Análisis


[Incluya el diagrama de secuencia de análisis en el cual se observe
el uso del patrón MVC que implementa el escenario identificado.]

Diagrama de Clases de Análisis


[Incluya el diagrama de clases de análisis obtenido del conjunto de
diagramas de secuencia que se implementan por cada escenario.]

11. Modelo Conceptual


[Esta sección ilustra cómo 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
arquitectura del sistema. Se puede hacer uso de tarjetas CRC para
documentar las responsabilidades y colaboraciones de cada clase de
persistencia identificada.]

____________________________________________________________________________________
Reporte de Especificación de Software (RES) Página 16 de 16

También podría gustarte