Documentación (Narrativa De Los Casos De Uso)

¿Para Que Sirve la Documentación ?  

Pueden usarse como una técnica alternativa a las tradicionales listas de requisitos para especificar el caso de uso el cual lleva casi en su totalidad todos los requisitos funcionales.

El diagrama de casos de uso no es suficiente para entender que es lo que se necesita que haga el sistema, por lo que se hace necesario describir el detalle de cada caso uso, esta descripción también recibe el nombre de DOCUMENTACIÓN, ESPECIFICACIÓN DE CASOS DE USO O TÉCNICA

La documentación o especificación técnica de casos de uso se compone de los siguientes puntos:

1.-Nombre.
2.-Descripción.
3.-Actores
4.-Pre-condiciones.
5.-Flujo Principal o Normal.
5.1.-Flujos Alternativos.
6.-Pos-condiciones.
7.-Excepciones.

1.- Nombre: Corresponde al caso de uso que se desea especificar del diagrama de casos de uso.

Es necesario recalcar que el nombre del caso de uso empieza con un verbo y después lo acompañan los sustantivos que permitan identificar qué hace el caso de uso.

2.- Descripción: Es el texto breve que explica en qué consiste el caso de uso.

3.- Actores: Los actores son los que intervienen en ese caso de uso, por lo que sólo se

debe poner los actores que están asociados con el caso de uso en el diagrama.

4.- Pre-Condiciones: Son condiciones que se pueden o deben presentarse antes de que inicie el caso de uso.Describen en qué situación se debe encontrar el sistema y su entorno para poder
comenzar el caso de uso con posibilidades de finalizar con éxito.


OJO (IMPORTANTE): La redacción de los casos de uso debe ser simple ya que es una narrativa que describe las acciones que hay entre el sistema y el actor. Siempre tiene el
patrón el actor hace, el sistema hace, el actor hace, el sistema hace. Una ayuda
de esto es la numeración de cada una de las actividades que ocurren entre el
actor y el sistema.

Ejemplo: 1.1 ,1.2 1.3, 1.4 1.5 2,3,4,5...

5 - 5.1.-Flujos: La parte más importante de una documentación o especificación son los flujos como lo es el flujo principal y flujo alternativos que en algunas ocasiones se juntan o se separan, todo depende de que escritura facilite más su comprensión. No habiendo un flujo correcto aunque  ya este bien estructurado y bien escrito el usuario final o para quien va destinado no podrá comprenderlo.

6.- Pos-Condiciones: Son condiciones o acciones que se tienen que hacer después de concluido alguno de los flujos del caso de uso.Describen la situación en que debe quedar el sistema y su entorno una vez que el caso de uso haya finalizado con éxito.

7.-Excepciones: Situaciones anómalas, y su tratamiento, que pueden

darse durante el flujo de la documentación. 

Estas ayudan a establecer  el flujo si va para algo incorrecto, es decir, son eventos que no tienen nada que ver con las actividades normales de lo especificado.