Ejemplo de Documento de Requerimientos
♟️

Modelo de Documento de Requerimientos

Versión del documento

  • Requerido por:
  • Revisado por:
  • Aprobado por:

1. Configuración del Proyecto

Versión de Odoo:

16.0

Tipo de Alojamiento

Odoo.sh

URL de Producción

cliente.gaheos.com

URL de Pruebas

cliente-stg.gaheos.com

Usuario del sistema

admin@cliente.gaheos.com

Horas Estimadas:

-

Fecha de Entrega estimada:

10/10/2023

2. Historias de Usuario y Justificación 

2.1 Titulo

Breve y descriptivo, con el propósito de identificar claramente la funcionalidad o característica asociada, proporcionando una visión concisa de su contenido y enfoque.

Ejemplo:

  • “Sincronización Automática de Fechas y Navegación Intuitiva entre Documentos Relacionados”

2.2 Descripción

Presenta de manera breve y directa la esencia de la historia de usuario, ya sea a través de un párrafo conciso o viñetas, con el objetivo de comunicar claramente la necesidad o problema del usuario, y proporcionar una comprensión clara de la funcionalidad deseada

Ejemplo: 

  • El coordinador logístico necesita una funcionalidad que sincronice automáticamente las fechas de picking y entrega, y permita una navegación rápida y directa entre documentos de confirmación de venta y los correspondientes documentos de picking/entrega en el sistema Odoo.

2.3 Detalles del Usuario

Perfil del usuario y relevancia de la funcionalidad: Identificación del usuario, sus responsabilidades y un análisis de cómo esta funcionalidad impacta directamente en sus responsabilidades laborales
Incluye: Rol, responsabilidades, y cómo esta funcionalidad impacta en su trabajo. 

Ejemplo:

  • Rol: Coordinador Logístico
  • Responsabilidades: Coordinar y gestionar eficientemente la preparación y entrega de paquetes de material de TI en escuelas.
  • Impacto de la Funcionalidad: Mejora de la eficiencia operativa, reducción de errores y optimización del tiempo.

2.4 Justificación de Valor / Necesidad del Negocio

Expone o detalla la razón fundamental que respalda la necesidad de validar la importancia de las historias de usuario. Esta validación se presenta como un elemento esencial en nuestro proceso, proporcionando un fundamento sólido para respaldar con éxito la implementación de las historias de usuario.

Incluye:
- Necesidad: ¿Por qué es importante esta historia?
- Impacto: ¿Cómo afecta al negocio o al usuario si no se implementa?
- Beneficios: ¿Cuál será el impacto positivo después de implementarlo?

Ejemplo:

  • Necesidad: Asegurar la precisión en las fechas de preparación y entrega de los paquetes y facilitar la navegación entre documentos relacionados.
  • Impacto si no se Implementa: Retrasos en las entregas, errores de coordinación y posible insatisfacción del cliente (escuelas).
  • Beneficios de la Implementación: Optimización del proceso logístico, mejora en la satisfacción del cliente y reducción de errores.

2.5 Criterios de aceptación:

Definir las condiciones que deben cumplirse para que una historia de usuario se considere completa y funcione según lo previsto. Esto abarca la descripción de escenarios específicos que deben ser aprobados, así como la especificación de los resultados esperados.

Ejemplo:

  • Las fechas de picking y entrega se sincronizan automáticamente en el sistema.
  • Existe un enlace o botón en el documento de confirmación de venta que redirige directamente a los documentos de picking/entrega relacionados.
  • La funcionalidad de navegación es intuitiva y fácil de usar para los usuarios.

2.6 Supuestos y Dependencias (opcional)

Identificar elementos críticos asumidos como verdaderos para el desarrollo de la historia de usuario, tales como dependencias tecnológicas o de negocio, así como supuestos relacionados con datos, tecnología, aspectos comerciales o riesgos asociados con la implementación de esta historia. Enumerar de manera clara cualquier elemento dependiente o suposición realizada durante el proceso de desarrollo de la historia.

Ejemplo:

  • Supuestos: Los usuarios están familiarizados con la tecnología y recibirán formación adecuada para utilizar la nueva funcionalidad.
  • Dependencias: La implementación depende de las capacidades técnicas y de desarrollo del sistema Odoo.
  • Riesgos: Requiere adaptación del equipo logístico a los nuevos flujos de trabajo y procesos.

2.7 Aspectos Técnicos (opcional)

Proporciona detalles técnicos relevantes, como tecnologías, APIs o normas, que puedan influir en el desarrollo de la historia de usuario.

Ejemplo:

  • Desarrollo de un módulo adicional o personalización en Odoo para sincronizar automáticamente las fechas y mejorar la navegación entre documentos relacionados.

2.8 Esquemas Visuales

Facilita la comprensión visual de la funcionalidad deseada mediante la inclusión de mockups, esquemas o diagramas, según sea necesario.

Ejemplo:

  • Se podrían crear mockups para visualizar la funcionalidad de navegación y diagramas de flujo para el proceso de sincronización de fechas.

3. Análisis Funcional

Análisis Funcional: Garantiza que el requerimiento se traduzca en una solución viable dentro de Odoo, mediante capturas de pantalla, flujos de trabajo propuestos y descripciones detalladas para un correcto funcionamiento, respaldando la justificación de valor.

Ejemplo: 

  • Creación de la Orden de Venta:
  • El usuario crea una orden de venta e incluye las líneas correspondientes al producto o servicio.
  • Validación de la Orden de Venta:
  • El usuario valida la orden de venta en el sistema.
  • Creación Automática de Documentos de Transferencia:
  • Se crean automáticamente dos documentos de transferencia relacionados:
  • WH/PICK: Inicialmente en estado "en espera". Debe mostrar un enlace al WH/OUT.
  • WH/OUT: Inicialmente en estado "esperando otra operación" y debe mostrar un enlace al WH/PICK.
  • Coordinación de Fecha de Entrega:
  • Se establece una discusión entre [CLIENTE] y las escuelas para acordar una fecha de entrega en WH/OUT.
  • Sincronización de Fechas:
  • La fecha acordada se establece en WH/OUT y automáticamente se sincroniza y establece la misma fecha en WH/PICK.
  • La fecha en WH/PICK no puede ser modificada manualmente.
  • Preparación de Paquetes por Logística:
  • Según la fecha de entrega programada definitiva, el logístico preparará los paquetes y validará WH/PICK (posiblemente usando un escáner de código de barras) cuando el paquete esté listo.
  • Entrega de Material y Validación:

El material se entrega a las escuelas en la fecha programada y se valida WH/OUT.

4. Análisis Técnico

Esencial cuando los requisitos no pueden cumplirse con la funcionalidad estándar de Odoo, incluye detalles técnicos como módulos, tecnologías y esfuerzos necesarios para el desarrollo personalizado de la funcionalidad requerida, explorando cómo las necesidades se convierten en implementaciones técnicas.

Ejemplo:

Característica: Sincronización de Fechas

  • Cambio de Vista de stock.picking:
  • Si el tipo de operación = pick => sólo lectura.
  • Cambio en el Flujo de Negocio:
  • Al editar la fecha programada de stock.picking, verificar otra selección del mismo group_id y si el tipo = pick, establecer la misma fecha.

Característica: Enlace entre Documentos

  • Modelo de Datos:
  • Añadir dos campos calculados (out_id, pick_id): Muchos a uno para stock.picking.
  • Cambio en el Flujo de Negocio:
  • Cómo calcular los campos: desde el picking, encontrar el otro picking del mismo grupo, donde out_id tendrá el picking con el tipo de operación out y pick_id tendrá el picking con el tipo de operación pick.
  • Cambio de Vista:
  • Añadir los 2 campos en la vista de formulario stock.picking, mostrando out_id sólo si el tipo de operación es pick y pick_id sólo si el tipo de operación es out.

** Detalles Técnicos **

  • Módulos Involucrados: stock.picking.
  • Modelos a Modificar: stock.picking.

Vistas a Modificar: Formulario de stock.picking.

5. Notas y Observaciones

Sirve como espacio vital para información adicional, preocupaciones o puntos que requieran revisión futura. Incluye comentarios adicionales, preguntas sin respuesta y cualquier detalle relevante para implementaciones o revisiones posteriores al proyecto. Este apartado registra el progreso y las observaciones cruciales del proyecto.

Ejemplo:

  • Nota 1: La implementación de la sincronización automática de fechas debe ser revisada cuidadosamente para evitar posibles conflictos o sobrescrituras no deseadas.
  • Nota 2: Es crucial ofrecer capacitación y documentación detallada a los usuarios finales para facilitar la transición hacia los nuevos flujos de trabajo.
  • Observación: La estrategia de monitoreo debe ser suficientemente robusta para identificar y abordar rápidamente cualquier problema o mejora necesaria en las nuevas funcionalidades.

6. Seguimiento

Esencial para rastrear el progreso del proyecto, identificar riesgos tempranamente e informar a las partes interesadas. Comprende actualizaciones de estado, revisiones de progreso y ajustes al plan del proyecto basados en aprendizajes y obstáculos encontrados durante la implementación. Este espacio facilita comentarios, señala riesgos potenciales y destaca puntos clave para la atención.

Ejemplo:

  • 01/03/2023: Implementación inicial

Inicio del seguimiento del comportamiento de las nuevas funcionalidades.

  • 08/03/2023: Revisión 1

Los usuarios reportan un comportamiento estable y las funcionalidades trabajan como se esperaba.

  • 15/03/2023: Revisión 2

Se observa que los usuarios utilizan activamente los enlaces para navegar entre documentos relacionados. No se reportan problemas.

  • 22/03/2023: Revisión 3

Los usuarios confirman que la sincronización de fechas está funcionando eficientemente y ha optimizado el flujo de trabajo.

  • 01/04/2023: Evaluación del seguimiento

Las funcionalidades implementadas son estables y cumplen con los requerimientos. Finalización del seguimiento activo y cambio a seguimiento pasivo.