- HERENCIA-SIMCO.md actualizado con directivas v3.7 y v3.8 - Cambios en backend y frontend Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
345 lines
10 KiB
Markdown
345 lines
10 KiB
Markdown
# PLAN DE ESTANDARIZACION DOCUMENTAL - MICHANGARRITO
|
|
**Fecha:** 2026-01-10
|
|
**Fase:** FASE 3 - Planeacion
|
|
**Estado:** EN ELABORACION
|
|
**Referencia:** ANALISIS-ESTANDARIZACION-DOCUMENTAL-FASE1-2026-01-10.md
|
|
**Sistema:** SIMCO v3.7.0
|
|
|
|
---
|
|
|
|
## 1. OBJETIVOS DEL PLAN
|
|
|
|
### 1.1 Objetivo General
|
|
|
|
Llevar la conformidad del proyecto MiChangarrito con los estandares SIMCO v3.7.0 del 82% actual al 95%+.
|
|
|
|
### 1.2 Objetivos Especificos
|
|
|
|
1. **Completar estructura de documentacion** - Crear archivos faltantes obligatorios
|
|
2. **Documentar integraciones formalmente** - Aplicar @TPL_INTEGRACION a 3+ integraciones principales
|
|
3. **Sincronizar inventarios** - Resolver discrepancias en conteos
|
|
4. **Estandarizar frontmatter** - Unificar metadatos en documentos
|
|
5. **Establecer ADRs base** - Documentar decisiones arquitectonicas retroactivas
|
|
|
|
---
|
|
|
|
## 2. PLAN DE TAREAS
|
|
|
|
### 2.1 BLOQUE A - Estructura Obligatoria (P0)
|
|
|
|
| ID | Tarea | Archivo | Accion | Estimacion |
|
|
|----|-------|---------|--------|------------|
|
|
| A1 | Crear README en docs | docs/README.md | CREAR | Inmediato |
|
|
| A2 | Crear README en orchestration | orchestration/README.md | CREAR | Inmediato |
|
|
| A3 | Verificar _MAP.md en 02-especificaciones | docs/02-especificaciones/_MAP.md | VERIFICAR | Ya existe |
|
|
|
|
### 2.2 BLOQUE B - Documentacion de Integraciones (P1)
|
|
|
|
| ID | Tarea | Archivo | Accion | Estimacion |
|
|
|----|-------|---------|--------|------------|
|
|
| B1 | Crear directorio integraciones | docs/02-integraciones/ | CREAR | Inmediato |
|
|
| B2 | Documentar WhatsApp Meta API | docs/02-integraciones/INT-001-whatsapp-meta.md | CREAR | 1 archivo |
|
|
| B3 | Documentar Stripe | docs/02-integraciones/INT-002-stripe.md | CREAR | 1 archivo |
|
|
| B4 | Documentar OpenRouter/LLM | docs/02-integraciones/INT-003-openrouter.md | CREAR | 1 archivo |
|
|
| B5 | Documentar Mercado Pago | docs/02-integraciones/INT-004-mercadopago.md | CREAR | 1 archivo |
|
|
| B6 | Crear _MAP.md integraciones | docs/02-integraciones/_MAP.md | CREAR | 1 archivo |
|
|
|
|
### 2.3 BLOQUE C - Sincronizacion de Inventarios (P1)
|
|
|
|
| ID | Tarea | Archivo | Accion | Detalle |
|
|
|----|-------|---------|--------|---------|
|
|
| C1 | Verificar schemas BD | DATABASE_INVENTORY.yml | VERIFICAR | 9 vs 12 |
|
|
| C2 | Verificar tablas BD | DATABASE_INVENTORY.yml | VERIFICAR | 29 vs 49 |
|
|
| C3 | Verificar modulos backend | BACKEND_INVENTORY.yml | VERIFICAR | 12 vs 18 |
|
|
| C4 | Sincronizar HERENCIA-SIMCO | HERENCIA-SIMCO.md | ACTUALIZAR | Con inventarios |
|
|
| C5 | Sincronizar CONTEXTO-PROYECTO | CONTEXTO-PROYECTO.md | ACTUALIZAR | Con inventarios |
|
|
| C6 | Sincronizar docs/_MAP.md | docs/_MAP.md | ACTUALIZAR | Con inventarios |
|
|
| C7 | Agregar changelog a inventarios | MASTER_INVENTORY.yml | AGREGAR | Seccion changelog |
|
|
|
|
### 2.4 BLOQUE D - ADRs y Decisiones (P2)
|
|
|
|
| ID | Tarea | Archivo | Accion | Contenido |
|
|
|----|-------|---------|--------|-----------|
|
|
| D1 | Crear directorio ADRs | docs/97-adr/ | CREAR | Directorio |
|
|
| D2 | ADR-0001 Multi-tenant | docs/97-adr/ADR-0001-multi-tenant-architecture.md | CREAR | Arquitectura MT |
|
|
| D3 | ADR-0002 WhatsApp First | docs/97-adr/ADR-0002-whatsapp-first-approach.md | CREAR | Estrategia canal |
|
|
| D4 | ADR-0003 LLM Agnostico | docs/97-adr/ADR-0003-llm-agnostic-strategy.md | CREAR | Multi-LLM |
|
|
| D5 | Crear _MAP.md ADRs | docs/97-adr/_MAP.md | CREAR | Indice |
|
|
|
|
### 2.5 BLOQUE E - Estandarizacion de Frontmatter (P2)
|
|
|
|
| ID | Tarea | Archivos Afectados | Accion | Detalle |
|
|
|----|-------|-------------------|--------|---------|
|
|
| E1 | Agregar frontmatter epicas | docs/01-epicas/MCH-*.md | AGREGAR | YAML header |
|
|
| E2 | Agregar frontmatter specs | docs/02-especificaciones/*.md | AGREGAR | YAML header |
|
|
| E3 | Agregar frontmatter vision | docs/00-vision-general/*.md | AGREGAR | YAML header |
|
|
|
|
### 2.6 BLOQUE F - Testing y Cobertura (P2)
|
|
|
|
| ID | Tarea | Archivo | Accion | Detalle |
|
|
|----|-------|---------|--------|---------|
|
|
| F1 | Ejecutar tests backend | - | EJECUTAR | npm run test:cov |
|
|
| F2 | Documentar cobertura backend | BACKEND_INVENTORY.yml | ACTUALIZAR | Seccion tests |
|
|
| F3 | Ejecutar tests frontend | - | EJECUTAR | npm run test |
|
|
| F4 | Documentar cobertura frontend | FRONTEND_INVENTORY.yml | ACTUALIZAR | Seccion tests |
|
|
|
|
---
|
|
|
|
## 3. FLUJO DE EJECUCION
|
|
|
|
### 3.1 Orden de Ejecucion
|
|
|
|
```
|
|
FASE 1: BLOQUE A (P0)
|
|
│
|
|
├── A1: docs/README.md
|
|
└── A2: orchestration/README.md
|
|
│
|
|
FASE 2: BLOQUE B + C (P1) [PARALELO]
|
|
│
|
|
├── B1-B6: Integraciones
|
|
│ └── WhatsApp → Stripe → OpenRouter → MercadoPago → _MAP
|
|
│
|
|
└── C1-C7: Sincronizacion
|
|
└── Verificar → Sincronizar → Changelog
|
|
│
|
|
FASE 3: BLOQUE D (P2)
|
|
│
|
|
└── D1-D5: ADRs
|
|
└── Directorio → ADR-0001 → ADR-0002 → ADR-0003 → _MAP
|
|
│
|
|
FASE 4: BLOQUE E (P2) [OPCIONAL]
|
|
│
|
|
└── E1-E3: Frontmatter
|
|
└── Epicas → Specs → Vision
|
|
│
|
|
FASE 5: BLOQUE F (P2) [OPCIONAL]
|
|
│
|
|
└── F1-F4: Testing
|
|
└── Backend → Frontend → Documentar
|
|
```
|
|
|
|
### 3.2 Dependencias Entre Tareas
|
|
|
|
| Tarea | Depende de | Bloquea a |
|
|
|-------|------------|-----------|
|
|
| A1 | - | - |
|
|
| A2 | - | - |
|
|
| B1 | - | B2-B6 |
|
|
| B2-B5 | B1 | B6 |
|
|
| B6 | B2-B5 | - |
|
|
| C1-C3 | - | C4-C6 |
|
|
| C4-C6 | C1-C3 | - |
|
|
| D1 | - | D2-D5 |
|
|
| D2-D4 | D1 | D5 |
|
|
| D5 | D2-D4 | - |
|
|
| E1-E3 | - | - |
|
|
| F1-F4 | - | - |
|
|
|
|
---
|
|
|
|
## 4. CONTENIDO DE ARCHIVOS A CREAR
|
|
|
|
### 4.1 docs/README.md
|
|
|
|
```markdown
|
|
# MiChangarrito - Documentacion
|
|
|
|
## Descripcion
|
|
|
|
Documentacion completa del proyecto MiChangarrito, punto de venta inteligente para micro-negocios informales en Mexico.
|
|
|
|
## Estructura
|
|
|
|
| Directorio | Contenido |
|
|
|------------|-----------|
|
|
| 00-vision-general/ | Vision, requerimientos, arquitectura |
|
|
| 01-epicas/ | 28 epicas del proyecto (MCH-001 a MCH-028) |
|
|
| 02-especificaciones/ | Especificaciones tecnicas |
|
|
| 02-integraciones/ | Documentacion de integraciones externas |
|
|
| 90-transversal/ | Documentacion transversal |
|
|
| 97-adr/ | Decisiones arquitectonicas |
|
|
|
|
## Navegacion
|
|
|
|
- [Mapa de Documentacion](./_MAP.md)
|
|
- [Vision del Proyecto](./00-vision-general/VISION-PROYECTO.md)
|
|
- [Indice de Epicas](./01-epicas/_MAP.md)
|
|
|
|
## Estado del Proyecto
|
|
|
|
- **Progreso MVP:** 95%
|
|
- **Epicas Completadas:** 22 de 28
|
|
- **Sistema:** SIMCO v3.7.0
|
|
|
|
---
|
|
|
|
**Ultima actualizacion:** 2026-01-10
|
|
```
|
|
|
|
### 4.2 orchestration/README.md
|
|
|
|
```markdown
|
|
# MiChangarrito - Orchestration
|
|
|
|
## Proposito
|
|
|
|
Este directorio contiene los archivos de orquestacion para agentes de IA que trabajan en el proyecto MiChangarrito.
|
|
|
|
## Estructura
|
|
|
|
| Archivo/Directorio | Proposito |
|
|
|--------------------|-----------|
|
|
| 00-guidelines/ | Lineamientos y herencia SIMCO |
|
|
| inventarios/ | SSOT: Inventarios YAML del proyecto |
|
|
| analisis/ | Documentos de analisis y planes |
|
|
| reportes/ | Reportes de progreso |
|
|
| trazas/ | Trazas de tareas |
|
|
| CONTEXT-MAP.yml | Mapeo de contexto del proyecto |
|
|
| PROJECT-STATUS.md | Estado actual del proyecto |
|
|
| PROXIMA-ACCION.md | Siguiente accion recomendada |
|
|
|
|
## Archivos Clave
|
|
|
|
### Para Agentes Nuevos
|
|
|
|
1. Leer `00-guidelines/CONTEXTO-PROYECTO.md`
|
|
2. Revisar `00-guidelines/HERENCIA-SIMCO.md`
|
|
3. Consultar inventario relevante en `inventarios/`
|
|
4. Verificar `PROJECT-STATUS.md`
|
|
|
|
### Single Source of Truth (SSOT)
|
|
|
|
| Inventario | Proposito |
|
|
|------------|-----------|
|
|
| MASTER_INVENTORY.yml | Estado consolidado |
|
|
| DATABASE_INVENTORY.yml | Schemas, tablas, funciones |
|
|
| BACKEND_INVENTORY.yml | Modulos, endpoints, tests |
|
|
| FRONTEND_INVENTORY.yml | Paginas, componentes, hooks |
|
|
|
|
## Sistema de Estandares
|
|
|
|
- **SIMCO:** v3.7.0
|
|
- **CCA Protocol:** v2.0
|
|
- **CAPVED:** Habilitado
|
|
|
|
---
|
|
|
|
**Ultima actualizacion:** 2026-01-10
|
|
```
|
|
|
|
### 4.3 Template INT-XXX (para integraciones)
|
|
|
|
Ver `orchestration/templates/TEMPLATE-INTEGRACION-EXTERNA.md` del workspace.
|
|
|
|
Aplicar a:
|
|
- INT-001-whatsapp-meta.md
|
|
- INT-002-stripe.md
|
|
- INT-003-openrouter.md
|
|
- INT-004-mercadopago.md
|
|
|
|
---
|
|
|
|
## 5. ASIGNACION DE PERFILES DE AGENTES
|
|
|
|
### 5.1 Por Bloque
|
|
|
|
| Bloque | Perfil Principal | Perfiles Soporte |
|
|
|--------|------------------|------------------|
|
|
| A (Estructura) | PERFIL-DOCUMENTATION | - |
|
|
| B (Integraciones) | PERFIL-DOCUMENTATION | PERFIL-BACKEND |
|
|
| C (Inventarios) | PERFIL-DOCUMENTATION-VALIDATOR | PERFIL-DATABASE |
|
|
| D (ADRs) | PERFIL-ARCHITECT | PERFIL-DOCUMENTATION |
|
|
| E (Frontmatter) | PERFIL-DOCUMENTATION | - |
|
|
| F (Testing) | PERFIL-BACKEND | PERFIL-FRONTEND |
|
|
|
|
### 5.2 Flujo de Trabajo
|
|
|
|
1. **Orquestador** coordina y valida
|
|
2. **Documentation** ejecuta creacion de archivos
|
|
3. **Documentation-Validator** verifica conformidad
|
|
4. **Especialistas** (Backend, Frontend, Database) proveen datos
|
|
|
|
---
|
|
|
|
## 6. CRITERIOS DE EXITO
|
|
|
|
### 6.1 Por Bloque
|
|
|
|
| Bloque | Criterio de Exito |
|
|
|--------|-------------------|
|
|
| A | 2 READMEs creados y funcionando |
|
|
| B | 4 integraciones documentadas + _MAP |
|
|
| C | 0 discrepancias en inventarios |
|
|
| D | 3 ADRs + directorio + _MAP |
|
|
| E | 100% de archivos con frontmatter YAML |
|
|
| F | Cobertura reportada en inventarios |
|
|
|
|
### 6.2 Global
|
|
|
|
- **Conformidad SIMCO:** >= 95%
|
|
- **Checklists pasados:** 3/3 al 90%+
|
|
- **Discrepancias:** 0
|
|
|
|
---
|
|
|
|
## 7. VALIDACION DEL PLAN
|
|
|
|
### 7.1 Puntos de Validacion
|
|
|
|
| Checkpoint | Momento | Validacion |
|
|
|------------|---------|------------|
|
|
| CP1 | Post BLOQUE A | Estructura completa |
|
|
| CP2 | Post BLOQUE B | Integraciones documentadas |
|
|
| CP3 | Post BLOQUE C | Inventarios sincronizados |
|
|
| CP4 | Post BLOQUE D | ADRs creados |
|
|
| CP5 | Final | Conformidad >= 95% |
|
|
|
|
### 7.2 Rollback
|
|
|
|
Si alguna tarea falla:
|
|
1. Documentar error en REPORTE-EJECUCION
|
|
2. Restaurar archivo previo si aplica
|
|
3. Continuar con siguiente tarea
|
|
4. Marcar como pendiente para revision
|
|
|
|
---
|
|
|
|
## 8. ESTIMACION TOTAL
|
|
|
|
| Bloque | Archivos | Lineas Est. |
|
|
|--------|----------|-------------|
|
|
| A | 2 | ~100 |
|
|
| B | 6 | ~1,500 |
|
|
| C | 7 | ~200 (ediciones) |
|
|
| D | 5 | ~500 |
|
|
| E | 35+ | ~350 (ediciones) |
|
|
| F | 0 | N/A (ejecucion) |
|
|
| **TOTAL** | **55+** | **~2,650** |
|
|
|
|
---
|
|
|
|
## 9. PROXIMOS PASOS
|
|
|
|
1. **FASE 4:** Validar este plan contra el analisis
|
|
2. **FASE 5:** Refinar plan segun validacion
|
|
3. **FASE 6:** Ejecutar bloques en orden
|
|
4. **FASE 7:** Validar ejecucion con checklists
|
|
|
|
---
|
|
|
|
## 10. REGISTRO
|
|
|
|
| Campo | Valor |
|
|
|-------|-------|
|
|
| **Creado por** | Orquestador SIMCO |
|
|
| **Fecha** | 2026-01-10 |
|
|
| **Estado** | EN ELABORACION |
|
|
| **Requiere aprobacion** | SI |
|
|
| **Proxima fase** | FASE 4 - Validacion |
|
|
|
|
---
|
|
|
|
**Ultima actualizacion:** 2026-01-10
|
|
**Version:** 1.0.0
|