Diez Consejos Útiles y Simples Para Escribir Correctamente Casos de Uso Correctos: X

Consejo 10

No usemos expresiones del tipo: “el sistema verifica si se cumple tal condición” y más adelante: “si se cumple la condición, haga esto”, y para terminar: “si no se cumple la condición, haga esto otro.” Este es un patrón que viene de la programación de computadores, es más bien pseudocódigo y la primera de las acciones no cumple con una de las premisas importantes de un caso de uso y es que cada acción lleve la secuencia del caso de uso un paso más adelante que el anterior. Vemos claramente que “el sistema verifica si se cumple tal condición” no avanza en el proceso, en cambio, debemos esperar hasta la siguiente operación: “si se cumple…” para continuar la secuencia.

En cambio, escribamos el caso de uso en términos de escenarios:

n. El sistema verifica que tal condición se cumple y hace…

n+1. El actor hace…

En una secuencia alterna especificamos lo que ocurre cuando la condición no se cumple:

nA1. El sistema verifica que tal condición no se cumple y hace…

(n+1)A2. El actor hace…

Como en:

4. El sistema verifica que el Cliente tiene capacidad de endeudamiento y solicita el valor del crédito

5. El actor ingresa el valor del crédito

Y en la secuencia alterna:

4A1. El sistema verifica que el Cliente no tiene capacidad de endeudamiento y solicita la identificación del avalista

4A2. El actor ingresa la identificación del avalista

Ejemplo

Consideremos este fragmento de caso de uso para verificar los fondos de una cuenta bancaria con miras a hacer efectivo un cheque.

Caso de Uso: Verificar fondos cuenta

Actor: Cajero

Secuencia Básica:

1.     El caso de uso inicia cuando el Cajero decide verificar los fondos disponibles para un cheque

2.     El sistema solicita el tipo y número de cuenta

3.     El Cajero ingresa el tipo y número de cuenta

4.     El sistema verifica que el número de cuenta existe y que está Activa y solicita el número del cheque

5.     El cajero ingresa el número del cheque

6.     El sistema valida que el número del cheque está dentro del rango autorizado y que no está contraordenado, y solicita el valor del cheque

7.     El cajero ingresa el valor del cheque

8.     El sistema verifica que hay fondos suficientes para pagar el cheque

9.     El caso de uso termina

Secuencia Alterna 1:

4A. El número de cuenta no existe

4A.1. El sistema verifica que el número de cuenta no existe y muestra el mensaje: “El número de cuenta dado no existe. Verifique.”

4A.2. El caso de uso continúa en el paso 2 de la secuencia básica.

Secuencia Alterna 2:

6A. El número del cheque no está dentro del rango autorizado

6A.1. El sistema verifica que el número del cheque no está dentro del rango autorizado y muestra el mensaje “El número del cheque no está autorizado. Verifique.”

6A.2. El caso de uso continúa en el paso 5 de la secuencia básica

Secuencia Alterna 3:

8A. No hay fondos suficientes para pagar el cheque

8A.1. El sistema verifica que la cuenta no tiene fondos suficientes para pagar el cheque y muestra el mensaje “Fondos insuficientes. Verifique.”

8A.2. El caso de uso continúa en el paso 7 de la secuencia básica

La escritura limpia del caso de uso lo hace claro, preciso y consistente, entre otros atributos deseables en un caso de uso. Nótese que es posible que haya más secuencias alternas.

Para saber más de casos de uso pueden visitar la sección Lecturas Fundamentales de mi Gazafatonario IT. En particular, pueden leer la Lectura Fundamental 3: Casos de Uso: Del Todo y de sus Partes.

http://www.gazafatonarioit.com/2006/11/lecturas-fundamentales-3.html

Esta serie de consejos útiles para escribir casos de uso inicia en:

http://www.gazafatonarioit.com/2012/10/diez-consejos-utiles-y-simples-para.html

Diez Consejos Útiles y Simples Para Escribir Correctamente Casos de Uso Correctos: VIII y IX

Consejo 8

Cuando se trata de incluir casos de uso se escribe:

• El sistema ejecuta el caso de uso “AQUÍ VIENE EL NOMBRE DEL CASO DE USO INCLUIDO”

O simplemente,

• Se ejecuta el caso de uso “AQUÍ VIENE EL NOMBRE DEL CASO DE USO INCLUIDO”

En este último caso se entiende que el único que ejecuta casos de uso incluidos es el sistema. Como en:

n. El sistema ejecuta el caso de uso “Verificar Lista Clinton”

n+1. Se ejecuta el caso de uso “Hacer Análisis de Riesgo”

Consejo 9

La especificación de un caso de uso incluido se debe iniciar estableciendo los nombres de los casos de uso que incluyen este caso de uso, como en:

1.     Este caso de uso se incluye en los casos de uso:

        a.     Caso de uso base 1

        b.     Caso de uso base 2

        c.     …

        d.     Caso de uso base n

2.     El sistema hace…

3.     El actor hace…

…

n. El caso de uso termina

Donde n es el número del último paso del caso de uso incluido.

Recordemos que esta relación de inclusión se usa cuando queremos:

•      Factorizar o descomponer (en sentido matemático) el comportamiento del caso de uso base que no es necesario para entender el objetivo principal del mismo y donde solamente el resultado del caso de uso incluido es importante.
•      Distribuir en uno o más casos de uso, funcionalidad del caso de uso base que es común para dos o más casos de uso (reusabilidad).

La primera opción se usa especialmente en casos de uso largos o complejos donde algunas partes del mismo no son relevantes para el sentido primordial del caso de uso y no son necesarias, en primera instancia, para entenderlo y aprobarlo. Por ejemplo, un caso de uso para Ingresar un Cliente de Naturaleza Jurídica puede solicitar docenas o cientos de datos que se pueden agrupar de acuerdo a algunos criterios como Datos Generales, Datos del Tipo de Entidad y Naturaleza Jurídica, Datos del Gerente o Representante Legal, Datos de los Contactos, Referencias Comerciales, entre otros. Algunos de estos grupos de datos pueden incluirse en casos de uso complementarios que son ejecutados desde el caso de uso principal.

La segunda posibilidad de inclusión es la reusabilidad de funcionalidad del sistema, es decir, cuando existe un comportamiento del sistema que se ejecuta en dos o más casos de uso de la misma manera, podemos usar un caso de uso incluido que represente ese comportamiento común. Por ejemplo, un caso de uso Verificar Centrales de Riesgo, que se ejecuta desde varios casos de uso de un sistema financiero, como Matricular Cliente, Revisar Solicitud de Crédito, Abrir Cuenta Corriente, entre otros.

Para conocer más acerca de relaciones entre casos de uso, pueden leer la Lectura Fundamental 12 Casos de Uso: de Extensiones y de Inclusiones en mi Gazafatonario IT:

http://www.gazafatonarioit.com/2008/05/lectura-fundamental-12-lectura_8835.html

La serie completa de estos consejos la encuentran en:

http://www.gazafatonarioit.com/2012/10/diez-consejos-utiles-y-simples-para.html

http://www.gazafatonarioit.com/2012/11/diez-consejos-utiles-y-simples-para.html

http://www.gazafatonarioit.com/2012/11/diez-consejos-utiles-y-simples-para_4.html

http://www.gazafatonarioit.com/2012/11/diez-consejos-utiles-y-simples-para_6.html

http://www.gazafatonarioit.com/2012/11/diez-consejos-utiles-y-simples-para_8.html

Diez Consejos Útiles y Simples Para Escribir Correctamente Casos de Uso Correctos: V, VI y VII

Consejo 5

Cuando se trata de operaciones complejas (que en un caso de uso son realizadas únicamente por el sistema), se debe evitar la descripción de la operación. Simplemente se debe decir:

·         El sistema calcula…

·         El sistema busca…

·         El sistema clasifica… o El sistema ordena…

·         El sistema almacena…

La descripción del cálculo, de la búsqueda, de la clasificación u ordenamiento y del método y destino específico de almacenamiento se hace en los requisitos especiales del caso de uso o en un documento de especificación de requisitos funcionales y no funcionales y se referencian en el caso de uso que lo requiera. Como en:

·         El sistema calcula el valor de la liquidación del empleado

·         El sistema busca los créditos que cumplan con las condiciones establecidas

·         El sistema clasifica los datos de los empleados por fecha de ingreso

·         El sistema almacena los datos del crédito

Consejo 6

Cuando el sistema realiza más de una de estas funciones se especifica la de mayor relevancia para el usuario. Por ejemplo: si para hacer un cálculo específico, el sistema debe buscar uno o más datos, se especifica el cálculo. Si el sistema clasifica u ordena un conjunto de datos para buscar uno o varios de ellos, se especifica la búsqueda. Si el sistema calcula y luego almacena, se puede decir “el sistema calcula SUJETO DE CÁLCULO y almacena DATOS A ALMACENAR” como en:

“El sistema calcula el interés corriente y almacena los datos del crédito.”

La fórmula matemática para hacer el cálculo y la enumeración detallada de los datos a almacenar pueden ser objeto de uno o varios requisitos especiales del caso de uso o de requisitos generales del sistema escritos en forma declarativa. En cualquier caso, debe existir un mecanismo de trazabilidad entre esos requisitos y el caso de uso que incluya las acciones de cálculo y de almacenamiento del ejemplo.

Consejo 7

Las operaciones complejas de cálculo, búsqueda o clasificación de datos se describen mejor usando diagramas de actividad, de estados o de secuencia, según el caso.

Explicación

Recordemos que un caso de uso (del sistema) especifica lo que hace el sistema y es relevante para el negocio. Por ejemplo, al usuario le interesa que el sistema almacene la información, pero no es importante si el sistema usa un procedimiento almacenado, un servicio o cualquier otro mecanismo para realizar esa acción. De la misma forma, al usuario le interesa que el sistema le muestre un informe con ciertos criterios de clasificación y agrupamiento, pero no se preocupa por los aspectos puramente técnicos de cómo se realiza el ordenamiento o si se requiere almacenamiento temporal para hacer los agrupamientos de datos, entre otros.

Para conocer más sobre este asunto pueden visitar el caso de abuso 5 en este miso Gazafatonario IT.

Caso de Abuso 5: El caso de uso contiene detalles de formularios (pantallas) y otros aspectos técnicos (bases de datos, componentes, etc.)

http://www.gazafatonarioit.com/2012/09/casos-de-abuso-parte-5-el-caso-de-uso.html

También el caso de abuso 2:

El caso de uso es la única documentación necesaria para construir el software

http://www.gazafatonarioit.com/2012/09/casos-de-abuso-parte-2.html

Sobre el consejo 7 pueden leer mi Lectura Fundamental 10:

Realización de Casos de Uso: De los Objetos y sus Interacciones

http://www.gazafatonarioit.com/2007/10/lecturas-fundamentales-10-lectura_3046.html

Diez Consejos Útiles y Simples Para Escribir Correctamente Casos de Uso Correctos, IV

Al escribir el caso de uso deben evitarse sinónimos “técnicos” para Sistema como “programa”, “módulo”, “rutina”, “función”, “procedimiento”, “procedimiento almacenado” y “subrutina”. Como en:

n. El programa solicita la fecha de ingreso

n+1. El actor proporciona la fecha de ingreso

n+2. El módulo calcula el número de días laborados hasta la fecha

Algunos de estos términos son usados de manera indistinta donde debemos usar siempre “sistema”, otros se usan en pasos específicos donde normalmente estamos suministrando información técnica que no es responsabilidad de los casos de uso, como cuando hablamos de procedimientos almacenados o de rutinas.

Simplemente usamos el término “sistema”.

Ejemplo

Consideremos el siguiente caso de uso de la Web 2.0, relacionado con la publicación de entradas en un blog:

Caso de Uso: Publicar Artículo

Actor: Bloguero

Descripción: este caso de uso permite crear una entrada para su publicación en un blog específico de la Web.

Precondiciones:

1.     El Bloguero está debidamente acreditado ante el Sistema

Secuencia Básica:

1.     El caso de uso inicia cuando el Bloguero opta por publicar un nuevo artículo

2.     El sistema solicita el título del artículo

3.     El Bloguero ingresa el título del artículo

4.     El sistema solicita el cuerpo del artículo

5.     El Bloguero proporciona el cuerpo del artículo

6.     El sistema solicita las palabras clave con las cuales indexar el artículo

7.     El Bloguero ingresa las palabras clave del artículo

8.     El sistema verifica que el título del artículo no existe y solicita confirmación para publicar la entrada

9.     El Bloguero confirma la publicación del artículo

10.   El sistema publica el artículo

11.   El caso de uso termina

Secuencia Alterna 1: el título de la publicación ya existe

8A. El sistema muestra el mensaje “El título del artículo ya existe. Por favor, verifique.”

8B. El caso de uso continúa en el paso 2 de la secuencia básica

Secuencia Alterna 2: el Bloguero cancela la publicación del artículo

9A. El Bloguero cancela la publicación de la entrada al Blog

9B. El caso de uso termina

Poscondiciones:

1.     La entrada se puede modificar durante los siguientes 30 minutos.

2.     El artículo puede ser leído por los lectores del blog.

Nótese que en todo momento sabemos qué hace el sistema y qué hace el actor.

Diez Consejos Útiles y Simples Para Escribir Efectivamente Casos de Uso Efectivos, III

Puesto que es una buena (mejor) práctica encontrar primero los actores y a continuación los casos de uso, es recomendable también especificar el actor en la descripción de cada paso, en vez del término genérico “actor”, como en:

q. El sistema solicita la fecha de creación de la cuenta

q+1. El Analista de Crédito ingresa la fecha de creación de la cuenta

Recordemos que los actores, humanos o no, son externos a y delimitan el sistema y, por tanto, su funcionalidad. Es a los actores a quienes les interesa el resultado de cada caso de uso, cualquier proceso del sistema, así sea un proceso automático, ocurre porque en algún instante a alguien o a algo consultará o le resultará de vital importancia el resultado de ese proceso. Ningún caso de uso lo sería si no hay un actor involucrado, directa o indirectamente.

Con ello en mente, y ya que vamos a adoptar la rutina de identificar a cada actor del sistema y luego a los casos de uso subyacentes, en estos nombraremos al actor cada que ejecute una acción y no usaremos términos como “usuario”, “usuario final” o “actor”.

Ejemplo

Consideremos un caso de uso simple para consultar el saldo disponible en una cuenta bancaria vía Internet:

Caso de uso: Consultar saldo

Actor: Cuenta-habiente

Precondiciones: El Cuenta-habiente está debidamente autenticado ante el sistema virtual

Secuencia básica:

1.     El caso de uso inicia cuando el Cuenta-habiente quiere consultar el saldo disponible en su cuenta de ahorros

2.     El sistema solicita seleccionar la cuenta

3.     El Cuenta-habiente selecciona la cuenta de la cual consultar el saldo

4.     El sistema consulta la cuenta y muestra el saldo disponible

5.     El caso de uso termina

Poscondiciones: Él Cuenta-habiente puede transferir dinero a otra cuenta. El Cuenta-habiente puede hacer pagos a terceros.

El correcto nombramiento de los actores también ayuda a entender mejor el sistema que vamos a construir. Un banco, por ejemplo, tiene muchos tipos de clientes, algunos de estos tienen abierta una o más cuentas bancarias tradicionales, son los Cuenta-habientes. Al menos en Colombia, una persona puede tener una tarjeta de crédito emitida por un banco o un crédito de consumo y no tener ningún otro producto con la entidad financiera, son otros tipos de clientes, por lo que usar el término genérico Cliente no ayuda mucho.

Nótese en el caso de uso la especificación de precondiciones y poscondiciones que, entre otras características, hacen más clara y corta la especificación y permiten a los involucrados conocer más detalles de la operación que se está describiendo.