semillero-special-hotel/docs/REQUIREMENTS.md

9.7 KiB

Requerimientos y Historias de Usuario

Sistema de Remuneración Variable, Compensación y Comisiones - Hoteles Estelar


Objetivo General

Implementar una plataforma centralizada para la administración, cálculo, validación y seguimiento de remuneración variable, compensaciones e incentivos comerciales, reemplazando el manejo manual actual realizado en archivos Excel y permitiendo automatizar el proceso de liquidación, aprobación y trazabilidad.


Alcance Funcional

El sistema se compone de 7 características principales (Features) divididas en 14 Historias de Usuario (HU).

FEATURE 1 — Administración de Planes de Compensación

HU-COM-001 — Crear plan de compensación

  • Como: Administrador del sistema
  • Quiero: Crear planes de compensación y comisiones
  • Para: Definir las reglas de remuneración variable.
  • Descripción: El sistema deberá permitir configurar planes asociados a:
    • Hoteles
    • Regiones
    • Equipos comerciales
    • Cargos
    • Campañas
    • Temporadas
    • Unidades de negocio
  • Criterios de Aceptación:
    • Escenario 1 (Creación exitosa): Dado que el administrador ingresa al módulo de compensación, cuando selecciona "Crear plan" y diligencia los campos requeridos, entonces el sistema debe almacenar el plan correctamente.
    • Escenario 2 (Validación de obligatoriedad): Dado que existen campos obligatorios, cuando el usuario intenta guardar sin completarlos, entonces el sistema debe mostrar mensajes de validación.
  • Campos sugeridos:
    • Nombre del plan, Código, Vigencia, Tipo de compensación, Área, Cargo, Hotel, Región, Tipo de cálculo, Fórmula, Meta, Porcentaje, Topes máximos, Estado.
  • Operaciones (Sub-features):
    • Crear plan, Editar plan, Duplicar plan, Versionamiento, Inactivar plan.

HU-COM-002 — Configurar reglas de cálculo

  • Como: Administrador
  • Quiero: Parametrizar reglas de negocio
  • Para: Automatizar liquidaciones de comisiones e incentivos.
  • Descripción: El sistema deberá soportar:
    • Cálculos porcentuales
    • Escalas y Rangos
    • Cumplimiento de metas
    • Comisiones fijas y variables
    • Bonos especiales
  • Criterios de Aceptación:
    • Escenario 1 (Configuración de fórmula): Dado que existe un plan de compensación, cuando el usuario define las reglas, entonces el sistema debe almacenar la configuración.
    • Escenario 2 (Validación de topes): Dado que existe un tope máximo definido, cuando el cálculo supera el límite, entonces el sistema debe aplicar el tope configurado.
  • Operaciones (Sub-features):
    • Fórmulas dinámicas, Escalas de comisión, Topes máximos, Reglas condicionales, Bonificaciones especiales.

HU-COM-003 — Configurar metas comerciales

  • Como: Administrador
  • Quiero: Configurar metas comerciales
  • Para: Medir cumplimiento para cálculo de variables.
  • Criterios de Aceptación:
    • Escenario 1 (Configurar meta): Dado que existe un colaborador o equipo, cuando el usuario asigna metas, entonces el sistema debe almacenarlas por periodo.
  • Operaciones (Sub-features):
    • Metas mensuales, trimestrales, por hotel, por equipo, individuales.

FEATURE 2 — Carga e Integración de Información

HU-COM-004 — Importar resultados comerciales desde Excel

  • Como: Usuario
  • Quiero: Importar resultados comerciales desde Excel
  • Para: Evitar procesos manuales.
  • Criterios de Aceptación:
    • Escenario 1 (Importación válida): Dado que el usuario carga un archivo válido, cuando el sistema procesa la información, entonces debe actualizar resultados automáticamente.
    • Escenario 2 (Archivo inválido): Dado que el archivo contiene errores, cuando el sistema procesa el archivo, entonces debe mostrar inconsistencias.
  • Operaciones (Sub-features):
    • Importación XLSX/CSV, Validación de columnas, Plantillas de carga.

HU-COM-005 — Integración automática con sistemas externos

  • Como: Administrador
  • Quiero: Integrar automáticamente información de ventas
  • Para: Automatizar el cálculo de comisiones.
  • Descripción: El sistema deberá integrarse con:
    • ERP, PMS hotelero, CRM, Sistemas financieros, Plataformas de reservas, Revenue Management.
  • Criterios de Aceptación:
    • Escenario 1 (Integración exitosa): Dado que existe una integración configurada, cuando el proceso automático se ejecuta, entonces el sistema debe actualizar la información automáticamente.
    • Escenario 2 (Error de integración): Dado que existe una falla, cuando el proceso no finaliza correctamente, entonces el sistema debe registrar logs y notificar al administrador.
  • Operaciones (Sub-features):
    • Integraciones API, Jobs automáticos, Logs, Reintentos automáticos.

FEATURE 3 — Liquidación Automática

HU-COM-006 — Calcular comisiones automáticamente

  • Como: Sistema
  • Quiero: Calcular automáticamente las comisiones
  • Para: Reducir errores manuales.
  • Criterios de Aceptación:
    • Escenario 1 (Cálculo individual): Dado que existen ventas registradas, cuando el sistema ejecuta la liquidación, entonces debe calcular automáticamente: Comisión individual, Cumplimiento, Bono e Incentivo.
    • Escenario 2 (Cálculo grupal): Dado que existen reglas grupales, cuando el sistema procesa el cálculo, entonces debe generar comisión grupal automáticamente.
  • Operaciones (Sub-features):
    • Motor de cálculo, Liquidación automática, Cálculos masivos, Simulación de pagos.

HU-COM-007 — Simular liquidación antes de aprobar

  • Como: Líder Comercial
  • Quiero: Simular liquidaciones
  • Para: Validar resultados antes de aprobar pagos.
  • Criterios de Aceptación:
    • Escenario 1 (Simulación): Dado que existe un periodo de liquidación, cuando el usuario ejecuta simulación, entonces el sistema debe mostrar resultados preliminares.
  • Operaciones (Sub-features):
    • Simulación, Validación previa, Comparativos, Ajustes antes de cierre.

FEATURE 4 — Aprobaciones y Flujo de Validación

HU-COM-008 — Aprobar liquidaciones

  • Como: Líder Comercial
  • Quiero: Aprobar o rechazar liquidaciones
  • Para: Validar pagos variables.
  • Criterios de Aceptación:
    • Escenario 1 (Aprobar): Dado que existe una liquidación generada, cuando el líder revisa la información, entonces puede aprobarla.
    • Escenario 2 (Rechazar): Dado que existen inconsistencias, cuando el líder rechaza la liquidación, entonces debe registrar observaciones obligatorias.
  • Operaciones (Sub-features):
    • Flujo de aprobación, Observaciones, Rechazos, Reenvío de liquidación.

HU-COM-009 — Notificar aprobación o rechazo

  • Como: Sistema
  • Quiero: Notificar resultados de aprobación
  • Para: Informar a los responsables.
  • Criterios de Aceptación:
    • Escenario 1 (Notificación de aprobación): Dado que la liquidación fue aprobada, cuando finaliza el proceso, entonces el sistema debe enviar notificación automática.
  • Operaciones (Sub-features):
    • Correos automáticos, Notificaciones push, Historial de notificaciones.

FEATURE 5 — Consulta y Trazabilidad

HU-COM-010 — Consultar histórico de comisiones

  • Como: Colaborador
  • Quiero: Consultar mi histórico de pagos variables
  • Para: Validar liquidaciones realizadas.
  • Criterios de Aceptación:
    • Escenario 1 (Consulta histórica): Dado que existen periodos liquidados, cuando el usuario consulta la información, entonces el sistema debe mostrar: Periodo, Meta, Resultado, Comisión, Estado.
  • Operaciones (Sub-features):
    • Histórico de pagos, Filtros, Descarga PDF, Consulta por periodos.

HU-COM-011 — Registrar trazabilidad y auditoría

  • Como: Sistema
  • Quiero: Registrar cambios y aprobaciones
  • Para: Mantener trazabilidad histórica.
  • Criterios de Aceptación:
    • Escenario 1 (Registro automático): Dado que un usuario modifica reglas o liquidaciones, cuando guarda cambios, entonces el sistema debe registrar: Usuario, Fecha, Hora, Acción, Valor anterior, Valor nuevo.
  • Operaciones (Sub-features):
    • Auditoría, Logs, Histórico, Bitácora.

FEATURE 6 — Reportes y Analítica

HU-COM-012 — Visualizar dashboard de compensación

  • Como: Director Comercial
  • Quiero: Visualizar dashboards de compensación
  • Para: Analizar desempeño y costos variables.
  • Criterios de Aceptación:
    • Escenario 1 (Dashboard ejecutivo): Dado que existen liquidaciones generadas, cuando el usuario consulta el dashboard, entonces el sistema debe mostrar: Comisiones pagadas, Cumplimiento, Ranking comercial, Costos variables, Tendencias.
  • Operaciones (Sub-features):
    • Dashboards, KPIs financieros, Tendencias, Comparativos.

HU-COM-013 — Exportar reportes financieros

  • Como: Usuario Financiero
  • Quiero: Exportar reportes
  • Para: Realizar análisis presupuestal y operativo.
  • Criterios de Aceptación:
    • Escenario 1 (Exportación): Dado que existen resultados liquidados, cuando el usuario selecciona exportar, entonces el sistema debe generar: PDF, Excel, Consolidados por hotel, Consolidados por región.
  • Operaciones (Sub-features):
    • Exportación PDF, Exportación Excel, Reportes consolidados, Programación automática de reportes.

FEATURE 7 — Seguridad y Permisos

HU-COM-014 — Gestionar roles y permisos

  • Como: Administrador
  • Quiero: Gestionar roles y accesos
  • Para: Proteger información sensible.
  • Roles sugeridos:
    • Administrador, Director Comercial, Gerente Hotel, Líder Comercial, Analista Financiero, Consulta.
  • Operaciones (Sub-features):
    • Roles, Permisos, Restricción por hotel, Restricción por región, Restricción por área.