28. Plantillas para documentar casos de uso

28.1 Introducción

Una plantilla de caso de uso es una estructura ordenada para documentar una funcionalidad. Su objetivo es evitar descripciones incompletas, desordenadas o difíciles de comparar.

La plantilla no debe convertirse en burocracia. Debe ayudar a pensar mejor: quién participa, qué objetivo se busca, qué condiciones existen, cuál es el flujo principal, qué alternativas aparecen y qué resultado debe quedar garantizado.

No existe una única plantilla universal. Cada equipo puede adaptarla según el tamaño del proyecto, el nivel de formalidad requerido y la complejidad del sistema.

28.2 Para qué sirve una plantilla

Una plantilla permite documentar casos de uso con un criterio uniforme. Esto facilita la lectura, la revisión, la trazabilidad y la derivación de pruebas.

También ayuda a detectar campos faltantes. Si una plantilla incluye precondiciones, flujos alternativos y postcondiciones, el analista se ve obligado a pensar en esos aspectos, aunque luego decida que alguno no aplica.

Una buena plantilla guía el análisis; no reemplaza el criterio del analista.

28.3 Campos principales de una plantilla

Una plantilla completa reúne los campos necesarios para comprender y validar el caso de uso. Puede incluir identificación, actores, objetivo, condiciones, flujos, reglas, datos, requisitos no funcionales y criterios de prueba.

Plantilla completa para documentar un caso de uso con campos principales de especificación

28.4 Plantilla breve

Una plantilla breve sirve para casos simples o para etapas tempranas de descubrimiento. Permite registrar lo esencial sin entrar todavía en todos los detalles.

Identificador:
Nombre:
Actor principal:
Objetivo:
Descripción breve:
Resultado esperado:

Esta versión es útil para armar una primera lista de casos de uso candidatos.

28.5 Plantilla intermedia

Una plantilla intermedia agrega información suficiente para analizar y validar comportamiento funcional sin llegar a un nivel excesivo de detalle.

Identificador:
Nombre:
Actor principal:
Actores secundarios:
Resumen:
Precondiciones:
Disparador:
Flujo principal:
Flujos alternativos:
Postcondiciones:
Reglas de negocio:

28.6 Plantilla completa

Una plantilla completa se usa cuando el caso de uso es importante, crítico, contractual o complejo. Puede incluir:

  • Identificador y versión.
  • Nombre y resumen.
  • Actor principal y actores secundarios.
  • Interesados y necesidades.
  • Garantía mínima y garantía de éxito.
  • Precondiciones y disparador.
  • Flujo principal.
  • Flujos alternativos.
  • Excepciones y recuperación.
  • Reglas de negocio.
  • Datos de entrada y salida.
  • Requisitos no funcionales asociados.
  • Casos de prueba relacionados.

28.7 Elegir la plantilla adecuada

No todos los casos de uso necesitan el mismo nivel de documentación. Un caso simple puede requerir una plantilla breve. Un caso con muchas reglas, integraciones o riesgos necesita una plantilla más completa.

La decisión debe considerar complejidad, criticidad, cantidad de actores, necesidad de validación, impacto legal, riesgos técnicos y utilidad para pruebas.

28.8 Campos obligatorios y opcionales

Conviene distinguir campos obligatorios de campos opcionales. Por ejemplo, identificador, nombre, actor principal, objetivo y flujo principal suelen ser obligatorios. Interesados, requisitos no funcionales o datos de auditoría pueden depender del proyecto.

Una plantilla demasiado rígida puede generar trabajo innecesario. Una plantilla demasiado débil puede producir especificaciones incompletas.

28.9 Ejemplo de plantilla aplicada

Para el caso de uso Solicitar turno, una ficha inicial podría ser:

Identificador: CU-01
Nombre: Solicitar turno
Actor principal: Paciente
Resumen: el paciente consulta disponibilidad, selecciona un horario y confirma una reserva.
Precondición: el paciente está registrado.
Disparador: el paciente selecciona la opción Solicitar turno.
Postcondición: el turno queda reservado y el paciente recibe confirmación.

28.10 Plantillas y trazabilidad

Una plantilla bien diseñada facilita la trazabilidad. Si cada caso de uso tiene identificador, reglas, requisitos no funcionales y pruebas relacionadas, es más fácil analizar el impacto de un cambio.

Por ejemplo, si cambia la regla de cancelación de turnos, se puede buscar qué casos de uso la referencian y qué pruebas deben actualizarse.

28.11 Plantillas y colaboración

Las plantillas también ayudan a que distintas personas documenten con un estilo similar. Esto mejora la colaboración entre analistas, desarrolladores, testers y usuarios revisores.

Cuando cada caso de uso tiene una estructura diferente, la revisión se vuelve más lenta y aparecen omisiones difíciles de detectar.

28.12 Evitar plantillas excesivas

Una plantilla con demasiados campos puede desalentar su uso o generar contenido de relleno. Si un campo no aporta valor, conviene revisarlo.

La documentación debe ser suficiente para tomar decisiones, validar comportamiento y construir el sistema correcto. Más campos no siempre significan mejor análisis.

28.13 Mantener plantillas actualizadas

Una plantilla debe evolucionar con el proyecto. Si el equipo descubre que necesita registrar datos de privacidad, dependencias externas o criterios de prueba, puede agregar esos campos.

También puede simplificarse si algunos campos no se usan o duplican información de otros documentos.

28.14 Errores frecuentes

Al usar plantillas, suelen aparecer estos errores:

  • Completar campos mecánicamente sin analizar el caso de uso.
  • Usar la misma plantilla completa para todos los casos, aunque sean simples.
  • Omitir campos críticos como precondiciones, alternativas o postcondiciones.
  • Duplicar reglas de negocio en muchos lugares con redacciones distintas.
  • No actualizar la plantilla cuando cambia la forma de trabajo del equipo.
  • No vincular la plantilla con pruebas o trazabilidad.
  • Usar una plantilla tan extensa que nadie la mantiene.

28.15 Lista de revisión

Antes de adoptar una plantilla, conviene revisar:

  • ¿Ayuda a comprender el caso de uso?
  • ¿Incluye los campos necesarios para validar comportamiento?
  • ¿Evita duplicación innecesaria?
  • ¿Puede adaptarse a casos simples y complejos?
  • ¿Facilita derivar pruebas?
  • ¿Permite trazabilidad?
  • ¿Será mantenible por el equipo?

28.16 Qué debes recordar de este tema

  • Una plantilla ordena la documentación de casos de uso.
  • No existe una única plantilla válida para todos los proyectos.
  • La plantilla debe ajustarse a complejidad, riesgo y necesidad de validación.
  • Puede ser breve, intermedia o completa.
  • Debe ayudar a pensar, no generar burocracia.
  • Debe facilitar trazabilidad y pruebas.
  • Debe revisarse si deja de aportar claridad.

28.17 Conclusión

Las plantillas para casos de uso permiten documentar de manera consistente y completa. Su valor está en guiar el análisis y asegurar que los aspectos importantes no queden olvidados.

La mejor plantilla es la que ayuda al equipo a comprender, validar, construir y probar el sistema sin agregar carga innecesaria. En el próximo tema estudiaremos casos de uso breves, casuales y completamente vestidos.