[Nombre de la Vista/Informe]

Módulo: [Ventas | Tesorería | CtaCte | Compra | Contabilidad | Stock | CRM] Tipo: [Vista | Informe | Modal | Dashboard] Estado: [Planificado | En desarrollo | Implementado] Plataforma: [Legacy PHP SSR | Vue.js SPA | Mixto]

---

1. Ubicación y propósito funcional

Ubicación en menú: Módulo → Sección → Subsección → Vista

Objetivo: [Descripción clara y concisa del propósito de la vista. Qué problema resuelve y qué valor aporta al usuario.]

Usuarios objetivo: [Roles o tipos de usuarios que utilizan esta vista]

---

2. Arquitectura y desarrollo

Plataforma

[Especificar si es Legacy PHP SSR, Vue.js SPA, o una combinación]

Características técnicas

• [Característica 1: ej. "Modal simple sin ruta propia"]
• [Característica 2: ej. "Reutiliza componentes de X módulo"]
• [Característica 3: ej. "Compatible con exportación PDF"]
• [Característica 4: ej. "Integrado con sistema de reportes"]

Componentes utilizados

• Frontend:
  • [Componente 1]
  • [Componente 2]
• Backend:
  • [Servicio/Controller usado]
  • [Helpers o utilidades]

---

3. Estructura de la vista

Layout

[Descripción del layout general: modal, fullscreen, sidebar, etc.]

Secciones principales

[Sección 1: ej. Filtros]

• Descripción: [Qué contiene esta sección]
• Elementos:
  • Campo 1: [descripción]
  • Campo 2: [descripción]
  • Botón/Acción: [descripción]

[Sección 2: ej. Resultados]

• Descripción: [Qué contiene esta sección]
• Elementos:
  • [Elemento 1]
  • [Elemento 2]

[Sección 3: ej. Acciones]

• Descripción: [Qué contiene esta sección]
• Acciones disponibles:
  • [Acción 1]
  • [Acción 2]

---

4. Formulario de parámetros / Filtros

[Si la vista tiene formulario o filtros, documentarlos aquí]

Campos obligatorios

• Campo 1:

  • Tipo: [text | select | date | etc.]
  • Validación: [validaciones]
  • Valor por defecto: [si aplica]
  • Descripción: [para qué sirve]

• Campo 2: [similar]

Campos opcionales

• Campo opcional 1: [descripción]
• Campo opcional 2: [descripción]

Validaciones

• [Validación 1]
• [Validación 2]

Comportamiento

• [Comportamiento al cargar]
• [Comportamiento al cambiar valores]
• [Comportamiento al enviar]

---

5. Presentación de datos

Formato de visualización

[Tabla | Grid | Lista | Gráfico | Cards | etc.]

Columnas/Campos mostrados

Columna	Tipo de dato	Formato	Descripción
[Campo 1]	[string]	[formato]	[descripción]
[Campo 2]	[decimal]	[$#,##0.00]	[descripción]
[Campo 3]	[date]	[DD/MM/YYYY]	[descripción]

Agrupaciones

[Si hay agrupaciones, describirlas]

• Agrupación principal: [criterio]
• Agrupaciones secundarias: [criterios]

Totalizaciones

• Subtotal: [qué totaliza y cómo]
• Total general: [qué totaliza y cómo]
• Porcentajes: [si aplica]

Ordenamiento

• Por defecto: [campo y dirección]
• Permitido: [campos ordenables]

---

6. Interacciones del usuario

Acciones principales

1. [Acción 1]: [descripción]

   • Trigger: [clic en botón | hover | etc.]
   • Resultado: [qué pasa]
   • Validaciones: [si aplica]

2. [Acción 2]: [similar]

Acciones secundarias

• [Acción secundaria 1]
• [Acción secundaria 2]

Navegación

• Entrar a la vista: [desde dónde y cómo]
• Salir de la vista: [cómo se cierra/sale]
• Links a otras vistas: [si aplica]

---

7. Exportación e impresión

Formatos soportados

• [ ] PDF
• [ ] Excel
• [ ] CSV
• [ ] Impresión directa

Configuración de exportación

• Encabezado: [qué incluye]
• Cuerpo: [qué incluye]
• Pie: [qué incluye]
• Paginación: [si aplica]
• Orientación: [Portrait | Landscape]

Formato del documento exportado

Encabezado

• [Elemento 1: ej. Razón social]
• [Elemento 2: ej. Rango de fechas]
• [Elemento 3: ej. Fecha de generación]
• [Título del reporte]

Cuerpo

• [Estructura del contenido]
• [Formato de datos]

Pie

• [Totales]
• [Firma o aclaraciones]
• [Número de página]

---

8. Permisos y seguridad

Permisos requeridos

Permiso	Descripción	Acciones habilitadas
MODULO_PERMISO_VIEW	Ver vista	Acceso, visualización
MODULO_PERMISO_EXPORT	Exportar	Descargar PDF, Excel
MODULO_PERMISO_PRINT	Imprimir	Impresión directa

Restricciones

• [Restricción 1: ej. "Solo puede ver datos de su sucursal"]
• [Restricción 2]

---

9. Backend - API

Endpoints utilizados

GET /api/[ruta]

• Descripción: [Qué hace]
• Query Params:
  • param1 (tipo): [descripción]
  • param2 (tipo): [descripción]
• Respuesta:

  {
    "status": 200,
    "message": "Datos recibidos correctamente.",
    "data": [...]
  }

Lógica de negocio

• [Regla 1]
• [Regla 2]
• [Cálculos específicos]

Performance

• Caché: [si aplica]
• Paginación: [si aplica]
• Límites: [límites de datos]

---

10. Casos de uso

Caso 1: [Nombre del caso]

Actor: [Usuario tipo X]

Flujo:

1. Usuario accede a [ubicación]
2. Usuario selecciona [parámetros]
3. Usuario ejecuta [acción]
4. Sistema muestra [resultado]
5. Usuario puede [acciones disponibles]

Resultado esperado: [Qué debe pasar]

Caso 2: [Nombre del caso]

[Similar]

---

11. Validaciones y reglas de negocio

Validaciones de entrada

1. [Validación 1]
2. [Validación 2]

Reglas de cálculo

1. [Regla 1: ej. "Las ventas incluyen facturas y restan notas de crédito"]
2. [Regla 2]

Manejo de casos especiales

• Sin datos: [qué mostrar]
• Error en carga: [cómo manejarlo]
• Timeout: [qué hacer]

---

12. Observaciones técnicas

Compatibilidad

• [Navegadores soportados]
• [Dispositivos soportados]
• [Resoluciones óptimas]

Limitaciones conocidas

• [Limitación 1]
• [Limitación 2]

Consideraciones de rendimiento

• [Consideración 1: ej. "Datos cacheados por 5 minutos"]
• [Consideración 2: ej. "Límite de 10,000 registros"]

Mejoras futuras

• [ ] [Mejora 1]
• [ ] [Mejora 2]

Integración con otros módulos

• [Módulo 1: descripción de la integración]
• [Módulo 2: descripción de la integración]

---

13. Anexos

Mockups / Screenshots

[Links o paths a imágenes de referencia]

Ejemplos de datos

[Ejemplos de cómo se ven los datos reales]

Referencias

• [Documento relacionado 1]
• [Documento relacionado 2]

---

Historial de cambios

Fecha	Versión	Autor	Descripción
YYYY-MM-DD	1.0	[Nombre]	Creación del documento