erp-retail/orchestration/00-guidelines/HERENCIA-SIMCO.md
rckrdmrd 35718d707e [SIMCO-V38] docs: Actualizar HERENCIA-SIMCO.md a v3.8.0
- Agregar seccion Directivas de Documentacion (v3.7)
- Agregar seccion Directivas de Mantenimiento (v3.8)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 08:53:31 -06:00

193 lines
5.8 KiB
Markdown

# Herencia SIMCO - ERP Retail
**Sistema:** SIMCO v3.8.0 + CAPVED + CCA Protocol + Estándares Documentación + Mantenimiento Docs
**Fecha:** 2026-01-10
---
## Configuración del Proyecto
| Propiedad | Valor |
|-----------|-------|
| **Proyecto** | ERP Retail - Vertical para Comercios |
| **Nivel** | VERTICAL (Nivel 3) |
| **Padre** | erp-core |
| **Suite** | erp-suite |
| **SIMCO Version** | 3.8.0 |
| **CAPVED** | Habilitado |
| **CCA Protocol** | Habilitado |
| **Estado** | 0% - Futuro |
## Jerarquía de Herencia
```
Nivel 0: core/orchestration/ ← FUENTE PRINCIPAL
└── Nivel 1: erp-suite/orchestration/
└── Nivel 2: erp-core/orchestration/ ← PADRE DIRECTO
└── Nivel 3: retail/orchestration/ ← ESTE PROYECTO
```
---
## Directivas Heredadas de CORE (OBLIGATORIAS)
### Ciclo de Vida
| Alias | Propósito |
|-------|-----------|
| `@TAREA` | Punto de entrada para toda HU |
| `@CAPVED` | Ciclo de 6 fases |
| `@INICIALIZACION` | Bootstrap de agentes |
### Operaciones Universales
| Alias | Propósito |
|-------|-----------|
| `@CREAR` | Crear archivos nuevos |
| `@MODIFICAR` | Modificar existentes |
| `@VALIDAR` | Validar código |
| `@DOCUMENTAR` | Documentar trabajo |
| `@BUSCAR` | Buscar información |
| `@DELEGAR` | Delegar a subagentes |
### Principios Fundamentales
| Alias | Resumen |
|-------|---------|
| `@CAPVED` | Toda tarea pasa por 6 fases |
| `@DOC_PRIMERO` | Consultar docs/ antes de implementar |
| `@ANTI_DUP` | Verificar que no existe |
| `@VALIDACION` | Build y lint DEBEN pasar |
| `@TOKENS` | Desglosar tareas grandes |
---
## Directivas por Dominio Técnico
| Alias | Aplica | Notas |
|-------|--------|-------|
| `@OP_DDL` | **SÍ** | Schemas de comercio |
| `@OP_BACKEND` | **SÍ** | Servicios POS, inventario |
| `@OP_FRONTEND` | **SÍ** | UI de punto de venta |
| `@OP_MOBILE` | **SÍ** | App de ventas |
| `@OP_ML` | Futuro | Predicción de demanda |
---
## Patrones Heredados (OBLIGATORIOS)
Todos los patrones de `core/orchestration/patrones/` aplican.
---
## Directivas de Documentación (SIMCO v3.7)
Ubicación: `workspace/orchestration/directivas/simco/`
**Directivas de estandarización de documentación:**
| Alias | Directiva | Propósito | Aplica |
|-------|-----------|-----------|--------|
| `@DOC_PROYECTO` | `SIMCO-DOCUMENTACION-PROYECTO.md` | Estructura base de documentación | **SÍ** |
| `@NOMENCLATURA` | `SIMCO-NOMENCLATURA.md` | Convenciones de nomenclatura | **SÍ** |
| `@ESTRUCTURA_DOCS` | `SIMCO-ESTRUCTURA-DOCS.md` | Estructura interna de documentos | **SÍ** |
| `@INVENTARIOS` | `SIMCO-INVENTARIOS.md` | Estándares de inventarios YAML | **SÍ** |
| `@TESTING` | `SIMCO-TESTING.md` | Cobertura y estándares de testing | **SÍ** |
| `@MIGRACIONES` | `SIMCO-MIGRACIONES-BD.md` | Migraciones y DDL | **SÍ** |
| `@INTEGRACIONES` | `SIMCO-INTEGRACIONES-EXTERNAS.md` | Documentación de integraciones | **SÍ** |
### Checklists Asociados
| Alias | Checklist | Items |
|-------|-----------|-------|
| `@CHK_DOCUMENTACION` | `CHECKLIST-DOCUMENTACION-PROYECTO.md` | 44 |
| `@CHK_INVENTARIOS` | `CHECKLIST-INVENTARIOS.md` | 63 |
| `@CHK_NOMENCLATURA` | `CHECKLIST-NOMENCLATURA.md` | 40 |
### Templates Disponibles
| Alias | Template | Uso |
|-------|----------|-----|
| `@TPL_INVENTARIO` | `TEMPLATE-INVENTARIO-PROYECTO.md` | Crear inventarios YAML |
| `@TPL_INTEGRACION` | `TEMPLATE-INTEGRACION-EXTERNA.md` | Documentar integraciones |
| `@TPL_MODULO_ESTANDAR` | `TEMPLATE-MODULO-ESTANDAR.md` | Documentar módulos |
---
## Directivas de Mantenimiento de Documentación (SIMCO v3.8)
Ubicación: `workspace/orchestration/directivas/simco/`
**Directivas de mantenimiento, purga y sincronización:**
| Alias | Directiva | Propósito | Aplica |
|-------|-----------|-----------|--------|
| `@MANTENIMIENTO_DOCS` | `SIMCO-MANTENIMIENTO-DOCUMENTACION.md` | Ciclo de mantenimiento, purga y deprecación | **SÍ** |
| `@SYNC_BD` | `SIMCO-SINCRONIZACION-BD.md` | Sincronización BD ↔ Código ↔ Docs | **SÍ** |
### Checklists de Mantenimiento
| Alias | Checklist | Items |
|-------|-----------|-------|
| `@CHK_MANTENIMIENTO` | `CHECKLIST-MANTENIMIENTO-DOCS.md` | 80 |
| `@CHK_SYNC_BD` | `CHECKLIST-SINCRONIZACION-BD.md` | 70 |
### Templates y Perfiles
| Alias | Archivo | Uso |
|-------|---------|-----|
| `@TPL_DEPRECACION` | `TEMPLATE-DEPRECACION.md` | Marcar documentos como deprecados |
| `@PERFIL_DOC_MAINT` | `PERFIL-DOCUMENTATION-MAINTAINER.md` | Perfil especializado en mantenimiento |
### Cuándo Usar
| Evento | Acción |
|--------|--------|
| Tarea completada (código) | `@MANTENIMIENTO_DOCS` nivel básico |
| Cambio en DDL | `@SYNC_BD` + `@CHK_SYNC_BD` |
| Fin de sprint/fase | `@CHK_MANTENIMIENTO` completo |
| Deprecar documentos | `@TPL_DEPRECACION` |
---
## Directivas Heredadas de ERP Core
| Directiva | Extensión Local |
|-----------|-----------------|
| `DIRECTIVA-MULTI-TENANT.md` | Por `comercio_id` |
| `DIRECTIVA-EXTENSION-VERTICALES.md` | Módulos de retail |
---
## Variables de Contexto CCA
```yaml
PROJECT_NAME: "retail"
PROJECT_LEVEL: "VERTICAL"
PROJECT_ROOT: "./"
PARENT_PROJECT: "erp-core"
SUITE_PROJECT: "erp-suite"
DB_DDL_PATH: "database/ddl"
BACKEND_ROOT: "backend/src"
FRONTEND_ROOT: "frontend/src"
TENANT_COLUMN: "comercio_id"
RLS_CONTEXT: "app.current_comercio_id"
```
---
## Módulos Específicos de Retail (Por definir)
| Módulo | Descripción | Estado |
|--------|-------------|--------|
| RET-POS | Punto de venta | Por definir |
| RET-INV | Inventario | Por definir |
| RET-PRO | Productos | Por definir |
| RET-CLI | Clientes/fidelización | Por definir |
| RET-REP | Reportes de ventas | Por definir |
---
**Sistema:** SIMCO v3.8.0 + CAPVED + CCA Protocol + Estándares Documentación + Mantenimiento Docs
**Nivel:** VERTICAL (3)
**Última actualización:** 2026-01-10