rckrdmrd/erp-core
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
main
erp-core/docs/README.md
rckrdmrd 0086695b4c
Some checks failed
ERP Core CI / Backend Lint (push) Has been cancelled
Details
ERP Core CI / Backend Unit Tests (push) Has been cancelled
Details
ERP Core CI / Backend Integration Tests (push) Has been cancelled
Details
ERP Core CI / Frontend Lint (push) Has been cancelled
Details
ERP Core CI / Frontend Unit Tests (push) Has been cancelled
Details
ERP Core CI / Frontend E2E Tests (push) Has been cancelled
Details
ERP Core CI / Database DDL Validation (push) Has been cancelled
Details
ERP Core CI / Backend Build (push) Has been cancelled
Details
ERP Core CI / Frontend Build (push) Has been cancelled
Details
ERP Core CI / CI Success (push) Has been cancelled
Details
Performance Tests / Lighthouse CI (push) Has been cancelled
Details
Performance Tests / Bundle Size Analysis (push) Has been cancelled
Details
Performance Tests / k6 Load Tests (push) Has been cancelled
Details
Performance Tests / Performance Summary (push) Has been cancelled
Details
[SIMCO-V38] feat: Actualizar a SIMCO v3.8.0 + cambios backend 
- HERENCIA-SIMCO.md actualizado con directivas v3.7 y v3.8
- Actualizaciones en modulos CRM y OpenAPI

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

361 lines
12 KiB
Markdown
Raw Permalink Blame History

# DOCUMENTACIÓN - ERP CORE
**Proyecto:** ERP Core (Base Reutilizable Multi-Proyecto + SaaS)
**Versión:** 3.0.0
**Fecha:** 2025-12-05
**Estado:** 📋 Fase 2 - Modelado en progreso
---
## 🎯 OBJETIVO DEL PROYECTO
Crear el **ERP Genérico** como base reutilizable (60-70%) para los 3 ERPs especializados:
- ERP Construcción (vivienda e INFONAVIT)
- ERP Vidrio Templado (producción de vidrio)
- ERP Mecánicas Diesel (laboratorios diesel)
---
## 📚 DOCUMENTOS PRINCIPALES
### 📋 Planificación
- **[PLAN-MAESTRO-MIGRACION-CONSOLIDACION.md](PLAN-MAESTRO-MIGRACION-CONSOLIDACION.md)** - Plan completo de 4 fases (9-12 semanas)
- [PLAN-DOCUMENTACION-ERP-GENERICO.md](PLAN-DOCUMENTACION-ERP-GENERICO.md) - Plan original (3 etapas)
- [INSTRUCCIONES-AGENTE-ARQUITECTURA.md](INSTRUCCIONES-AGENTE-ARQUITECTURA.md) - Instrucciones previas
### 🚀 Ejecución
- **[LANZAR-FASE-0.md](LANZAR-FASE-0.md)** - ⭐ Instrucciones para lanzar Fase 0 (USAR ESTE)
### 🔧 Recursos Técnicos
- [Prompt Architecture-Analyst Extendido]([RUTA-LEGACY-ELIMINADA]/shared/orchestration/prompts/PROMPT-ARCHITECTURE-ANALYST-EXTENDED.md)
- [Referencias Odoo]([RUTA-LEGACY-ELIMINADA]/shared/reference/ODOO-MODULES-ANALYSIS.md)
- [Referencias Gamilit]([RUTA-LEGACY-ELIMINADA]/shared/reference/gamilit/)
- [ERP Construcción]([RUTA-LEGACY-ELIMINADA]/projects/erp-construccion/docs/)
---
## 🗺️ METODOLOGÍA: 4 FASES
### ✅ **FASE 0: ANÁLISIS DE REFERENCIAS** (2 semanas) - **ACTUAL**
**Objetivo:** Analizar Odoo + Gamilit + ERP Construcción para fundamentar decisiones
**Entregables:** 38 archivos
- 14 análisis de módulos Odoo
- 7 análisis de Gamilit
- 5 validaciones con ERP Construcción
- 10 ADRs (Architecture Decision Records)
- 1 mapeo de componentes genéricos
- 1 resumen ejecutivo
**👉 [LANZAR FASE 0](LANZAR-FASE-0.md)**
---
### 📌 **FASE 1: ANÁLISIS Y RETROALIMENTACIÓN** (2-3 semanas)
**Objetivo:** Migrar componentes genéricos del ERP Construcción
**Entregables:** 48-58 archivos
- Definición de módulos MGN-001 a MGN-014
- Extracción de 30-40 RF genéricos
- Gap analysis por módulo
- Retroalimentación a ERP Construcción
---
### 📌 **FASE 2: MODELADO DE REQUERIMIENTOS Y BD** (3-4 semanas)
**Objetivo:** Crear RF, ET, diseño de BD para ERP Genérico
**Entregables:** 244 archivos
- 8 modelos de dominio
- 12 schemas de BD (DDL)
- 70 RF (Requerimientos Funcionales)
- 70 ET backend
- 70 ET frontend
- 14 matrices de trazabilidad
---
### 📌 **FASE 3: DOCUMENTACIÓN DETALLADA** (2-3 semanas)
**Objetivo:** US, inventarios, planes de pruebas, docs transversales
**Entregables:** 246 archivos
- 140 US (Historias de Usuario)
- 28 README + _MAP (por módulo)
- 42 inventarios YAML
- 28 planes de pruebas
- 8 documentos transversales
---
## 📦 MÓDULOS DEL ERP GENÉRICO
### Fase Core (8 módulos - Prioridad P0)
| Código | Nombre | Referencia Odoo |
|--------|--------|-----------------|
| **MGN-001** | Fundamentos | base, auth_signup |
| **MGN-002** | Empresas y Organizaciones | base (res.company) |
| **MGN-003** | Catálogos Maestros | base, product |
| **MGN-004** | Financiero Básico | account |
| **MGN-005** | Inventario Básico | stock |
| **MGN-006** | Compras Básico | purchase |
| **MGN-007** | Ventas Básico | sale |
| **MGN-008** | Contabilidad Analítica | analytic |
### Fase Complementaria (6 módulos - Prioridad P1)
| Código | Nombre | Referencia Odoo |
|--------|--------|-----------------|
| **MGN-009** | CRM Básico | crm |
| **MGN-010** | Recursos Humanos Básico | hr |
| **MGN-011** | Proyectos Genéricos | project |
| **MGN-012** | Reportes y Analytics | reporting |
| **MGN-013** | Portal de Usuarios | portal |
| **MGN-014** | Mensajería y Notificaciones | mail |
### Fase SaaS Platform (4 módulos - Prioridad P3)
| Código | Nombre | Descripción |
|--------|--------|-------------|
| **MGN-016** | Billing SaaS | Per-seat pricing, suscripciones, feature flags |
| **MGN-017** | Payments POS | MercadoPago, Clip, terminales de pago |
| **MGN-018** | WhatsApp Business | Cloud API, chatbots, campañas |
| **MGN-019** | AI Agents | RAG, pgvector, knowledge bases, tools |
**Total:** 19 módulos (14 core + 1 projects + 4 SaaS)
---
## ESTRUCTURA DE DOCUMENTACION (v4.0 - Filosofia GAMILIT)
**Reestructurado:** 2025-12-05
**Filosofia:** Documentacion modular con trazabilidad completa
### Principios
1. **Modulos autocontenidos:** Todo lo de un modulo esta junto
2. **Trazabilidad completa:** RF -> ET -> US -> Codigo
3. **Inventarios globales:** Previenen duplicacion de objetos
4. **_MAP.md por modulo:** Indice con metricas y estado
### Estructura Nueva (Recomendada)
```
erp-suite/apps/erp-core/
│
├── docs/
│ ├── 01-fase-foundation/ # Modulos base
│ │ ├── README.md # Resumen de fase
│ │ ├── MGN-001-auth/ # MODULO AUTOCONTENIDO
│ │ │ ├── _MAP.md # Indice con metricas
│ │ │ ├── README.md # Descripcion
│ │ │ ├── requerimientos/ # RF del modulo
│ │ │ │ ├── RF-AUTH-001.md
│ │ │ │ └── RF-AUTH-002.md
│ │ │ ├── especificaciones/ # ET del modulo
│ │ │ │ ├── ET-AUTH-001-backend.md
│ │ │ │ └── ET-AUTH-002-frontend.md
│ │ │ ├── historias-usuario/ # US del modulo
│ │ │ │ ├── US-MGN001-001.md
│ │ │ │ └── US-MGN001-002.md
│ │ │ └── implementacion/
│ │ │ └── TRACEABILITY.yml # RF -> ET -> US -> Codigo
│ │ │
│ │ ├── MGN-002-users/ # Mismo patron
│ │ ├── MGN-003-roles/
│ │ └── MGN-004-tenants/
│ │
│ ├── 02-fase-core-business/ # Modulos de negocio
│ │ ├── MGN-005-catalogs/
│ │ ├── MGN-006-inventory/
│ │ ├── MGN-007-sales/
│ │ ├── MGN-008-purchases/
│ │ ├── MGN-009-reports/
│ │ └── MGN-010-accounting/
│ │
│ ├── 03-fase-extended/ # Modulos extendidos
│ │ ├── MGN-011-hr/
│ │ ├── MGN-012-manufacturing/
│ │ ├── MGN-013-projects/
│ │ ├── MGN-014-crm/
│ │ └── MGN-015-assets/
│ │
│ ├── 04-fase-saas/ # Modulos SaaS
│ │ ├── MGN-016-subscriptions/
│ │ ├── MGN-017-payments/
│ │ ├── MGN-018-whatsapp/
│ │ └── MGN-019-audit/
│ │
│ ├── 90-transversal/ # Documentos compartidos
│ │ ├── templates/
│ │ └── guias/
│ │
│ └── 97-adr/ # Architecture Decision Records
│
└── orchestration/
└── inventarios/ # INVENTARIOS CANONICOS
├── README.md
├── MASTER_INVENTORY.yml # Resumen global
├── DATABASE_INVENTORY.yml # Tablas, funciones, triggers
├── BACKEND_INVENTORY.yml # Services, controllers, endpoints
├── FRONTEND_INVENTORY.yml # Pages, components, stores
├── DEPENDENCY_GRAPH.yml # Grafo de dependencias
└── TRACEABILITY_MATRIX.yml # Matriz global RF->Codigo
```
### Beneficios
- **Localizacion rapida:** Todo de un modulo en una carpeta
- **Prevencion de duplicados:** Inventarios detectan colisiones
- **Trazabilidad completa:** Cualquier linea de codigo tiene traza a RF
- **Metricas precisas:** Story points, coverage, bugs por modulo
### Estructura Legacy (En Migracion)
```
docs/
├── 00-vision-general/ # Vision del proyecto
├── 01-analisis-referencias/ # Analisis Odoo/Gamilit
├── 02-definicion-modulos/ # Definiciones de modulos
├── 03-fase-vertical/ # Módulos verticales (MGN-011 a MGN-018)
├── 04-modelado/ # ET y DDL consolidados
├── 05-user-stories/ # US consolidadas (147 archivos)
├── 06-test-plans/ # Planes de prueba
├── 07-devops/ # CI/CD
├── 08-epicas/ # Epicas
├── 90-transversal/ # Transversal
├── 95-guias-desarrollo/ # Guias
└── 97-adr/ # ADRs
```
---
## 🚀 CÓMO EMPEZAR
### 1. Revisar el Plan Maestro
Lee [PLAN-MAESTRO-MIGRACION-CONSOLIDACION.md](PLAN-MAESTRO-MIGRACION-CONSOLIDACION.md) completo
### 2. Lanzar Fase 0
Sigue las instrucciones en [LANZAR-FASE-0.md](LANZAR-FASE-0.md)
### 3. Validar Entregables Fase 0
Al completar, revisar:
- 38 archivos creados
- 10 ADRs fundamentados
- Mapeo de componentes completo
- Resumen ejecutivo consolidado
### 4. Aprobar antes de Fase 1
No avanzar a Fase 1 sin aprobar Fase 0
---
## 📊 MÉTRICAS DEL PROYECTO
### Duración Total
- **9-12 semanas** (Fase 0-3)
### Archivos a Crear
- **576-586 archivos** de documentación completa
### Distribución de Trabajo
- **Architecture-Analyst (coordinador):** 19% trabajo directo
- **Agentes delegados:** 81% trabajo especializado
### Reutilización Esperada
- **60-70%** de componentes reutilizables en los 3 ERPs especializados
---
## 🎯 RESULTADO FINAL ESPERADO
Al completar las 4 fases:
✅ **14 módulos** completamente documentados (MGN-001 a MGN-014)
✅ **10 ADRs** que guían decisiones arquitectónicas
✅ **70 RF** validados contra Odoo
✅ **140 ET** (backend + frontend)
✅ **140 US** listas para desarrollo
✅ **12 schemas de BD** diseñados
✅ **Inventarios completos** de objetos a implementar
✅ **Planes de pruebas** por módulo
✅ **Retroalimentación** al ERP Construcción
✅ **Base reutilizable** para 3 proyectos especializados
---
## 📚 REFERENCIAS EXTERNAS
### Proyectos de Referencia
- [Odoo Community Edition](https://github.com/odoo/odoo) - Lógica de negocio ERP
- Análisis Odoo: `/shared/reference/ODOO-MODULES-ANALYSIS.md`
- Proyecto Gamilit: `/shared/reference/gamilit/` - Arquitectura moderna
### ERP Construcción
- Documentación: `/projects/erp-construccion/docs/`
- 18 módulos documentados (35% progreso)
- Fuente de componentes a migrar
### Directivas y Estándares
- Prompts de agentes: `/shared/orchestration/prompts/`
- Directivas: `/shared/orchestration/directivas/`
---
## ✅ CHECKLIST DE PROGRESO
### Fase 0 (Actual)
- [ ] 14 análisis Odoo completados
- [ ] 7 análisis Gamilit completados
- [ ] 5 validaciones construcción completadas
- [ ] 10 ADRs creados
- [ ] Mapeo de componentes completo
- [ ] Resumen ejecutivo consolidado
- [ ] **Total: 38 archivos** ✅
### Fase 1
- [ ] Módulos MGN definidos
- [ ] RF genéricos extraídos
- [ ] Gap analysis completado
- [ ] Retroalimentación generada
### Fase 2
- [ ] Modelos de dominio creados
- [ ] Schemas BD diseñados
- [ ] RF completos
- [ ] ET backend y frontend
### Fase 3
- [ ] US creadas
- [ ] Inventarios completos
- [ ] Planes de pruebas
- [ ] Docs transversales
---
## 🔗 NAVEGACIÓN RÁPIDA
| Documento | Propósito |
|-----------|-----------|
| [PLAN-MAESTRO](PLAN-MAESTRO-MIGRACION-CONSOLIDACION.md) | Plan completo 4 fases |
| [LANZAR-FASE-0](LANZAR-FASE-0.md) | ⭐ Ejecutar ahora |
| [Prompt Extendido](../../../shared/orchestration/prompts/PROMPT-ARCHITECTURE-ANALYST-EXTENDED.md) | Capacidades del agente |
| [Odoo Analysis](../../../shared/reference/ODOO-MODULES-ANALYSIS.md) | Referencia Odoo |
| [Gamilit](../../../shared/reference/gamilit/) | Referencia Gamilit |
| [ERP Construcción](../../erp-construccion/docs/) | Documentación a migrar |
---
## 📋 ESTRUCTURA ACTUALIZADA (v3.0)
La estructura de carpetas ha sido reorganizada el 2025-12-05 para eliminar numeración duplicada.
Ver directiva: `/workspace/core/orchestration/directivas/DIRECTIVA-ESTRUCTURA-DOCUMENTACION-PROYECTOS.md`
---
**Última actualización:** 2025-12-05
**Coordinador:** Architecture-Analyst
**Estado:** 📋 Fase 2 - Modelado en progreso
**Próximo paso:** Completar especificaciones técnicas de módulos SaaS
Reference in New Issue View Git Blame Copy Permalink