## Directivas SIMCO v3.7.0 - Estandarizacion de Documentacion (7) - SIMCO-DOCUMENTACION-PROYECTO.md - SIMCO-NOMENCLATURA.md - SIMCO-ESTRUCTURA-DOCS.md - SIMCO-INVENTARIOS.md - SIMCO-TESTING.md - SIMCO-MIGRACIONES-BD.md - SIMCO-INTEGRACIONES-EXTERNAS.md ## Directivas SIMCO v3.8.0 - Mantenimiento de Documentacion (2) - SIMCO-MANTENIMIENTO-DOCUMENTACION.md - SIMCO-SINCRONIZACION-BD.md ## Templates (4) - TEMPLATE-INVENTARIO-PROYECTO.md - TEMPLATE-INTEGRACION-EXTERNA.md - TEMPLATE-MODULO-ESTANDAR.md - TEMPLATE-DEPRECACION.md ## Checklists (6) - CHECKLIST-DOCUMENTACION-PROYECTO.md - CHECKLIST-INVENTARIOS.md - CHECKLIST-NOMENCLATURA.md - CHECKLIST-MANTENIMIENTO-DOCS.md - CHECKLIST-SINCRONIZACION-BD.md - _MAP.md ## Perfil de Agente (1) - PERFIL-DOCUMENTATION-MAINTAINER.md ## Indices - INDICE-DIRECTIVAS-WORKSPACE.yml actualizado a v3.8.0 ## Submodulos actualizados (14) - gamilit, erp-core, michangarrito, template-saas - erp-suite, erp-construccion, erp-clinicas - erp-mecanicas-diesel, erp-retail, erp-vidrio-templado - trading-platform, betting-analytics - inmobiliaria-analytics, platform_marketing_content Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
730 lines
21 KiB
Markdown
730 lines
21 KiB
Markdown
# PLAN - DIRECTIVA DE MANTENIMIENTO Y PURGA DE DOCUMENTACIÓN
|
|
**Fecha:** 2026-01-10
|
|
**Fase:** 3 - Planificación
|
|
**Estado:** EN PROGRESO
|
|
**Basado en:** ANALISIS-DIRECTIVA-MANTENIMIENTO-DOCUMENTACION-2026-01-10.md
|
|
|
|
---
|
|
|
|
## 1. RESUMEN DEL PLAN
|
|
|
|
### 1.1 Objetivo
|
|
|
|
Crear una directiva integral que establezca:
|
|
1. **Ciclo de mantenimiento** obligatorio post-tarea/fase
|
|
2. **Purga gradual** de documentación obsoleta
|
|
3. **Deprecación sistemática** de históricos
|
|
4. **Sincronización** docs ↔ código ↔ BD
|
|
5. **Validación de dependencias** completa
|
|
6. **Carga automática de contexto** para subagentes
|
|
|
|
### 1.2 Artefactos a Crear
|
|
|
|
| # | Artefacto | Tipo | Alias | Prioridad |
|
|
|---|-----------|------|-------|-----------|
|
|
| 1 | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Directiva | @MANTENIMIENTO_DOCS | P0 |
|
|
| 2 | SIMCO-SINCRONIZACION-BD.md | Directiva | @SYNC_BD | P0 |
|
|
| 3 | CHECKLIST-MANTENIMIENTO-DOCS.md | Checklist | @CHK_MANTENIMIENTO | P0 |
|
|
| 4 | CHECKLIST-SINCRONIZACION-BD.md | Checklist | @CHK_SYNC_BD | P0 |
|
|
| 5 | TEMPLATE-DEPRECACION.md | Template | @TPL_DEPRECACION | P1 |
|
|
| 6 | PERFIL-DOCUMENTATION-MAINTAINER.md | Perfil | @PERFIL_DOC_MAINT | P1 |
|
|
|
|
### 1.3 Integraciones Requeridas
|
|
|
|
| Directiva Existente | Tipo de Integración | Cambio |
|
|
|---------------------|---------------------|--------|
|
|
| INDICE-DIRECTIVAS-WORKSPACE.yml | Actualización | Agregar nuevas directivas y aliases |
|
|
| SIMCO-ESTRUCTURA-DOCS.md | Extensión | Agregar campos de mantenimiento |
|
|
| PRINCIPIO-CAPVED.md | Referencia | Documentar Fase M como extensión |
|
|
| SIMCO-DELEGACION.md | Referencia | Agregar perfil de mantenimiento |
|
|
|
|
---
|
|
|
|
## 2. ESPECIFICACIÓN DE ARTEFACTOS
|
|
|
|
### 2.1 SIMCO-MANTENIMIENTO-DOCUMENTACION.md
|
|
|
|
**Propósito:** Directiva maestra para mantenimiento y purga de documentación
|
|
|
|
**Estructura Detallada:**
|
|
|
|
```markdown
|
|
# SIMCO: MANTENIMIENTO DE DOCUMENTACIÓN
|
|
|
|
## Metadata
|
|
- Version: 1.0.0
|
|
- Alias: @MANTENIMIENTO_DOCS
|
|
- Categoria: operaciones_documentacion
|
|
- Obligatoria: SI (post-tarea/fase)
|
|
|
|
## 1. Propósito y Alcance
|
|
- Por qué existe esta directiva
|
|
- Problemas que resuelve
|
|
- Cuándo es obligatoria
|
|
|
|
## 2. Principios Fundamentales
|
|
2.1 Documentación como Activo Vivo
|
|
2.2 Coherencia sobre Completitud
|
|
2.3 Purga Gradual, No Masiva
|
|
2.4 Deprecación Antes de Eliminación
|
|
2.5 Validación de Dependencias Obligatoria
|
|
|
|
## 3. Triggers de Mantenimiento (Cuándo Aplicar)
|
|
3.1 Post-Tarea Completada
|
|
3.2 Post-Fase/Sprint Completado
|
|
3.3 Post-Cambio en DDL
|
|
3.4 Post-Cambio en API
|
|
3.5 Auditoría Programada (mensual)
|
|
|
|
## 4. Ciclo de Mantenimiento (6 Pasos)
|
|
4.1 IDENTIFICAR - Docs afectados y dependencias
|
|
4.2 SINCRONIZAR - Docs ↔ Código ↔ BD
|
|
4.3 VALIDAR - Dependencias y referencias
|
|
4.4 DEPRECAR - Marcar obsoletos
|
|
4.5 PURGAR - Eliminar/consolidar redundante
|
|
4.6 VERIFICAR - Checklist de cierre
|
|
|
|
## 5. Validación de Dependencias
|
|
5.1 Dependencias Verticales (jerarquía docs)
|
|
5.2 Dependencias Horizontales (entre capas)
|
|
5.3 Dependencias de Scripts (BD)
|
|
5.4 Matriz de Impacto de Cambios
|
|
5.5 Checklist de Validación por Tipo de Cambio
|
|
|
|
## 6. Sincronización BD ↔ Docs ↔ Código
|
|
6.1 Al Modificar DDL
|
|
6.2 Al Modificar Backend
|
|
6.3 Al Modificar Frontend
|
|
6.4 Scripts de Recreación
|
|
6.5 Referencia: @SYNC_BD
|
|
|
|
## 7. Protocolo de Deprecación
|
|
7.1 Cuándo Deprecar
|
|
7.2 Cómo Marcar (formato [DEPRECATED])
|
|
7.3 Período de Gracia (30-90 días)
|
|
7.4 Movimiento a 99-archivo/
|
|
7.5 Registro en Changelog
|
|
|
|
## 8. Purga Gradual
|
|
8.1 Principios de Purga
|
|
8.2 Qué Purgar (secciones redundantes)
|
|
8.3 Qué NO Purgar (histórico valioso)
|
|
8.4 Consolidación de Información
|
|
8.5 Reducción de Verbosidad
|
|
|
|
## 9. Integración con CAPVED
|
|
9.1 Fase D Extendida
|
|
9.2 Fase M (Mantenimiento) como Extensión
|
|
9.3 Cuándo Omitir Fase M
|
|
9.4 Diagrama de Flujo CAPVED+M
|
|
|
|
## 10. Carga de Contexto para Subagentes
|
|
10.1 Problema: Pérdida de Contexto
|
|
10.2 Solución: Contexto Obligatorio por Operación
|
|
10.3 Template de Carga de Contexto
|
|
10.4 Instrucciones para Subagentes
|
|
10.5 Validación de Carga
|
|
|
|
## 11. Delegación de Mantenimiento
|
|
11.1 Cuándo Delegar
|
|
11.2 Perfil: @PERFIL_DOC_MAINT
|
|
11.3 Estructura de Delegación
|
|
11.4 Validación de Resultados
|
|
|
|
## 12. Checklist de Cierre
|
|
- Referencia: @CHK_MANTENIMIENTO
|
|
|
|
## 13. Referencias
|
|
- @SYNC_BD
|
|
- @DOC_PROYECTO
|
|
- @NOMENCLATURA
|
|
- @INVENTARIOS
|
|
- @CAPVED
|
|
|
|
## 14. Changelog
|
|
```
|
|
|
|
**Líneas Estimadas:** 400-500
|
|
|
|
---
|
|
|
|
### 2.2 SIMCO-SINCRONIZACION-BD.md
|
|
|
|
**Propósito:** Directiva específica para sincronización BD ↔ Código ↔ Docs
|
|
|
|
**Estructura Detallada:**
|
|
|
|
```markdown
|
|
# SIMCO: SINCRONIZACIÓN BASE DE DATOS
|
|
|
|
## Metadata
|
|
- Version: 1.0.0
|
|
- Alias: @SYNC_BD
|
|
- Categoria: operaciones_documentacion
|
|
- Obligatoria: SI (post-cambio DDL)
|
|
|
|
## 1. Propósito
|
|
- Garantizar coherencia DDL ↔ Scripts ↔ Entities ↔ Docs
|
|
|
|
## 2. Triggers de Sincronización
|
|
2.1 Cambio en archivo DDL
|
|
2.2 Nuevo schema/tabla/columna
|
|
2.3 Modificación de constraint/index
|
|
2.4 Cambio en función/trigger/view
|
|
|
|
## 3. Flujo de Sincronización
|
|
3.1 DDL → Scripts create/recreate
|
|
3.2 DDL → Entity/Model
|
|
3.3 DDL → DTO
|
|
3.4 DDL → Repository
|
|
3.5 DDL → Inventario BD
|
|
3.6 DDL → Docs/specs
|
|
|
|
## 4. Validación de Scripts BD
|
|
4.1 Estructura de Scripts Requeridos
|
|
4.2 Orden de Ejecución
|
|
4.3 Validación Pre-Recreación
|
|
4.4 Ejecución de Recreación
|
|
4.5 Validación Post-Recreación
|
|
|
|
## 5. Matriz de Dependencias DDL
|
|
5.1 Tabla → Dependientes
|
|
5.2 Vista → Tablas Base
|
|
5.3 Función → Referencias
|
|
5.4 Trigger → Tablas
|
|
|
|
## 6. Checklist por Tipo de Cambio
|
|
6.1 Nueva Tabla
|
|
6.2 Nueva Columna
|
|
6.3 Modificación de Tipo
|
|
6.4 Nuevo Constraint
|
|
6.5 Nueva Función/Trigger
|
|
|
|
## 7. Actualización de Inventarios
|
|
7.1 DATABASE_INVENTORY.yml
|
|
7.2 BACKEND_INVENTORY.yml (entities)
|
|
7.3 Sección de schemas en MASTER
|
|
|
|
## 8. Documentación de Cambios
|
|
8.1 ADR si cambio arquitectural
|
|
8.2 Actualización de ET-*
|
|
8.3 Actualización de _MAP.md
|
|
|
|
## 9. Referencia: Checklist Completo
|
|
- @CHK_SYNC_BD
|
|
|
|
## 10. Errores Comunes
|
|
- Scripts desactualizados
|
|
- Entities sin sincronizar
|
|
- Inventarios obsoletos
|
|
```
|
|
|
|
**Líneas Estimadas:** 300-350
|
|
|
|
---
|
|
|
|
### 2.3 CHECKLIST-MANTENIMIENTO-DOCS.md
|
|
|
|
**Propósito:** Checklist ejecutable para validar mantenimiento completo
|
|
|
|
**Estructura:**
|
|
|
|
```markdown
|
|
# CHECKLIST: Mantenimiento de Documentación
|
|
|
|
## Metadata
|
|
- Alias: @CHK_MANTENIMIENTO
|
|
- Referencia: SIMCO-MANTENIMIENTO-DOCUMENTACION.md
|
|
- Items: ~80
|
|
|
|
## Uso
|
|
- Ejecutar al completar tarea/fase
|
|
- Marcar cada item conforme se valida
|
|
- Documentar excepciones
|
|
|
|
## Secciones
|
|
|
|
### 1. Identificación (10 items)
|
|
- [ ] Listar documentos modificados en la tarea
|
|
- [ ] Listar documentos con dependencia directa
|
|
- [ ] Listar documentos dependientes
|
|
- [ ] Identificar docs con >3 meses sin actualizar
|
|
- [ ] Verificar frontmatter de cada doc
|
|
- [ ] Identificar secciones potencialmente obsoletas
|
|
- [ ] Revisar referencias cruzadas
|
|
- [ ] Listar inventarios afectados
|
|
- [ ] Identificar scripts BD afectados
|
|
- [ ] Documentar alcance de mantenimiento
|
|
|
|
### 2. Sincronización (15 items)
|
|
- [ ] Specs actualizados vs código implementado
|
|
- [ ] Entities sincronizadas con DDL
|
|
- [ ] DTOs sincronizados con entities
|
|
- [ ] API specs vs controllers
|
|
- [ ] Frontend types vs API responses
|
|
- [ ] Inventario BD vs DDL real
|
|
- [ ] Inventario Backend vs código real
|
|
- [ ] Inventario Frontend vs componentes
|
|
- [ ] MASTER_INVENTORY actualizado
|
|
- [ ] Scripts create-database actualizados
|
|
- [ ] Scripts recreate-database actualizados
|
|
- [ ] Seeds actualizados si aplica
|
|
- [ ] _MAP.md actualizados
|
|
- [ ] Fechas updated_date correctas
|
|
- [ ] Versiones incrementadas
|
|
|
|
### 3. Validación de Dependencias (15 items)
|
|
- [ ] Dependencias verticales validadas
|
|
- [ ] Dependencias horizontales validadas
|
|
- [ ] Referencias cruzadas funcionan
|
|
- [ ] Links internos válidos
|
|
- [ ] Links externos válidos (si aplica)
|
|
- [ ] Diagrama de dependencias actualizado
|
|
- [ ] Módulos dependientes notificados
|
|
- [ ] Módulos de los que depende verificados
|
|
- [ ] No hay referencias a docs eliminados
|
|
- [ ] No hay referencias a código eliminado
|
|
- [ ] Tests actualizados para cambios
|
|
- [ ] Build exitoso post-cambios
|
|
- [ ] Lint exitoso post-cambios
|
|
- [ ] Tests exitosos post-cambios
|
|
- [ ] Recreación BD exitosa (si aplica)
|
|
|
|
### 4. Deprecación (10 items)
|
|
- [ ] Docs obsoletos identificados
|
|
- [ ] Docs marcados con [DEPRECATED]
|
|
- [ ] Fecha de deprecación documentada
|
|
- [ ] Alternativa/reemplazo indicado
|
|
- [ ] Período de gracia establecido
|
|
- [ ] _MAP.md actualizado con estado DEPRECATED
|
|
- [ ] Changelog actualizado
|
|
- [ ] Notificación a equipos afectados
|
|
- [ ] Plan de eliminación documentado
|
|
- [ ] No se deprecó información valiosa
|
|
|
|
### 5. Purga Gradual (10 items)
|
|
- [ ] Secciones redundantes identificadas
|
|
- [ ] Información duplicada consolidada
|
|
- [ ] Verbosidad reducida manteniendo esencia
|
|
- [ ] Ejemplos obsoletos eliminados
|
|
- [ ] Comentarios TODO antiguos resueltos/eliminados
|
|
- [ ] Referencias a versiones antiguas eliminadas
|
|
- [ ] Información temporal eliminada
|
|
- [ ] Formato limpiado (espacios, tabs)
|
|
- [ ] Estructura de secciones optimizada
|
|
- [ ] Tamaño de archivo razonable
|
|
|
|
### 6. Verificación Final (15 items)
|
|
- [ ] Todos los docs tienen frontmatter válido
|
|
- [ ] Todas las fechas actualizadas
|
|
- [ ] Todas las versiones incrementadas
|
|
- [ ] Todos los _MAP.md actualizados
|
|
- [ ] Todos los inventarios actualizados
|
|
- [ ] Scripts BD ejecutables
|
|
- [ ] Build exitoso
|
|
- [ ] Tests exitosos
|
|
- [ ] No hay warnings de deprecación sin resolver
|
|
- [ ] Documentación de cambios completa
|
|
- [ ] Traza de mantenimiento creada
|
|
- [ ] PROXIMA-ACCION actualizado si aplica
|
|
- [ ] Propagación completada si aplica
|
|
- [ ] Revisión por pares si crítico
|
|
- [ ] Commit con mensaje descriptivo
|
|
|
|
### 7. Carga de Contexto Subagentes (5 items)
|
|
- [ ] Directivas relevantes identificadas
|
|
- [ ] Contexto heredable documentado
|
|
- [ ] Instrucciones para subagentes claras
|
|
- [ ] Perfiles compactos actualizados si aplica
|
|
- [ ] SESSION-TRACKING actualizado si paralelo
|
|
```
|
|
|
|
**Items Totales:** ~80
|
|
|
|
---
|
|
|
|
### 2.4 CHECKLIST-SINCRONIZACION-BD.md
|
|
|
|
**Propósito:** Checklist específico para sincronización de base de datos
|
|
|
|
**Estructura:**
|
|
|
|
```markdown
|
|
# CHECKLIST: Sincronización Base de Datos
|
|
|
|
## Metadata
|
|
- Alias: @CHK_SYNC_BD
|
|
- Referencia: SIMCO-SINCRONIZACION-BD.md
|
|
- Items: ~70
|
|
|
|
## Secciones
|
|
|
|
### 1. Pre-Sincronización (10 items)
|
|
- [ ] Backup de BD existente
|
|
- [ ] Documentar estado inicial
|
|
- [ ] Listar cambios DDL a sincronizar
|
|
- [ ] Identificar objetos dependientes
|
|
- [ ] Verificar no hay transacciones pendientes
|
|
- [ ] Revisar scripts actuales
|
|
- [ ] Verificar permisos de ejecución
|
|
- [ ] Documentar versión actual de schemas
|
|
- [ ] Revisar changelog de BD
|
|
- [ ] Confirmar ambiente de trabajo
|
|
|
|
### 2. Sincronización DDL → Scripts (15 items)
|
|
- [ ] Archivo DDL actualizado
|
|
- [ ] create-database.sh actualizado
|
|
- [ ] recreate-database.sh actualizado
|
|
- [ ] drop-database.sh actualizado si existe
|
|
- [ ] Orden de ejecución correcto
|
|
- [ ] Dependencias de schemas respetadas
|
|
- [ ] Extensions declaradas
|
|
- [ ] Schemas creados en orden
|
|
- [ ] Tablas creadas en orden
|
|
- [ ] Constraints creados después de tablas
|
|
- [ ] Índices incluidos
|
|
- [ ] Funciones incluidas
|
|
- [ ] Triggers incluidos
|
|
- [ ] Views incluidas
|
|
- [ ] RLS policies incluidas
|
|
|
|
### 3. Sincronización DDL → Backend (15 items)
|
|
- [ ] Entity actualizada para cada tabla modificada
|
|
- [ ] Decoradores @Column correctos
|
|
- [ ] Tipos TypeScript correctos
|
|
- [ ] Relaciones actualizadas
|
|
- [ ] DTO de creación actualizado
|
|
- [ ] DTO de actualización actualizado
|
|
- [ ] DTO de respuesta actualizado
|
|
- [ ] Repository actualizado si nuevos métodos
|
|
- [ ] Service actualizado si lógica cambia
|
|
- [ ] Controller actualizado si endpoints cambian
|
|
- [ ] Validadores actualizados
|
|
- [ ] Transformers actualizados
|
|
- [ ] Tests de entity actualizados
|
|
- [ ] Tests de service actualizados
|
|
- [ ] Tests e2e actualizados
|
|
|
|
### 4. Sincronización DDL → Frontend (10 items)
|
|
- [ ] Types/interfaces actualizados
|
|
- [ ] DTOs frontend actualizados
|
|
- [ ] Formularios actualizados
|
|
- [ ] Validaciones frontend actualizadas
|
|
- [ ] Queries/mutations actualizados
|
|
- [ ] Estado (store) actualizado si aplica
|
|
- [ ] Componentes afectados actualizados
|
|
- [ ] Tests frontend actualizados
|
|
- [ ] Mocks actualizados
|
|
- [ ] Fixtures actualizados
|
|
|
|
### 5. Validación de Ejecución (10 items)
|
|
- [ ] Ejecutar recreate-database.sh
|
|
- [ ] Verificar salida sin errores
|
|
- [ ] Verificar todos los schemas creados
|
|
- [ ] Verificar todas las tablas creadas
|
|
- [ ] Verificar constraints activos
|
|
- [ ] Verificar índices creados
|
|
- [ ] Verificar funciones creadas
|
|
- [ ] Verificar triggers activos
|
|
- [ ] Verificar RLS policies activas
|
|
- [ ] Ejecutar seeds si aplica
|
|
|
|
### 6. Validación de Inventarios (10 items)
|
|
- [ ] DATABASE_INVENTORY.yml actualizado
|
|
- [ ] Schemas listados correctamente
|
|
- [ ] Conteo de tablas correcto
|
|
- [ ] Funciones documentadas
|
|
- [ ] Triggers documentados
|
|
- [ ] Views documentadas
|
|
- [ ] BACKEND_INVENTORY.yml actualizado
|
|
- [ ] Entities listadas
|
|
- [ ] Endpoints actualizados
|
|
- [ ] MASTER_INVENTORY.yml actualizado
|
|
```
|
|
|
|
**Items Totales:** ~70
|
|
|
|
---
|
|
|
|
### 2.5 TEMPLATE-DEPRECACION.md
|
|
|
|
**Propósito:** Template para documentar deprecación de archivos
|
|
|
|
**Estructura:**
|
|
|
|
```markdown
|
|
# TEMPLATE: Deprecación de Documento
|
|
|
|
## Uso
|
|
1. Agregar este bloque al inicio del documento deprecado
|
|
2. Actualizar _MAP.md con estado DEPRECATED
|
|
3. Planificar eliminación o archivado
|
|
|
|
## Template
|
|
|
|
---
|
|
[DEPRECATED]
|
|
Fecha de deprecación: {YYYY-MM-DD}
|
|
Deprecado por: {Motivo o referencia a cambio}
|
|
Reemplazo: {Documento o recurso que lo reemplaza}
|
|
Eliminar después de: {YYYY-MM-DD} (mínimo 30 días)
|
|
---
|
|
|
|
## Ejemplo de Uso
|
|
|
|
---
|
|
[DEPRECATED]
|
|
Fecha de deprecación: 2026-01-10
|
|
Deprecado por: Refactorización de módulo de autenticación (ver MCH-E05)
|
|
Reemplazo: docs/02-especificaciones/ET-API-AUTH-002.md
|
|
Eliminar después de: 2026-02-10
|
|
---
|
|
|
|
## Proceso Post-Deprecación
|
|
|
|
1. Notificar a equipos afectados
|
|
2. Actualizar referencias en otros documentos
|
|
3. Mover a 99-archivo/ después de período de gracia
|
|
4. Eliminar definitivamente después de 90 días en archivo
|
|
```
|
|
|
|
---
|
|
|
|
### 2.6 PERFIL-DOCUMENTATION-MAINTAINER.md
|
|
|
|
**Propósito:** Perfil de agente especializado en mantenimiento de documentación
|
|
|
|
**Estructura:**
|
|
|
|
```markdown
|
|
# PERFIL: Documentation Maintainer
|
|
|
|
## Metadata
|
|
- Alias: @PERFIL_DOC_MAINT
|
|
- Tokens: ~300
|
|
- Especialización: Mantenimiento y auditoría de documentación
|
|
|
|
## Responsabilidades
|
|
1. Ejecutar ciclo de mantenimiento de docs
|
|
2. Validar coherencia docs ↔ código
|
|
3. Deprecar documentación obsoleta
|
|
4. Actualizar inventarios
|
|
5. Generar reportes de auditoría
|
|
|
|
## Contexto a Cargar
|
|
- @MANTENIMIENTO_DOCS
|
|
- @SYNC_BD
|
|
- @DOC_PROYECTO
|
|
- @NOMENCLATURA
|
|
- @INVENTARIOS
|
|
|
|
## Checklist a Usar
|
|
- @CHK_MANTENIMIENTO
|
|
- @CHK_SYNC_BD
|
|
|
|
## Output Esperado
|
|
- Lista de cambios realizados
|
|
- Lista de docs deprecados
|
|
- Lista de inventarios actualizados
|
|
- Reporte de auditoría
|
|
|
|
## Limitaciones
|
|
- NO modifica código
|
|
- NO modifica DDL
|
|
- Solo documenta y audita
|
|
- Escala problemas al agente principal
|
|
```
|
|
|
|
---
|
|
|
|
## 3. PLAN DE INTEGRACIÓN
|
|
|
|
### 3.1 Actualización de INDICE-DIRECTIVAS-WORKSPACE.yml
|
|
|
|
```yaml
|
|
# Agregar a sección operaciones_documentacion:
|
|
|
|
- archivo: "directivas/simco/SIMCO-MANTENIMIENTO-DOCUMENTACION.md"
|
|
alias: "@MANTENIMIENTO_DOCS"
|
|
obligatoria: true
|
|
descripcion: "Mantenimiento y purga de documentación"
|
|
version: "1.0.0"
|
|
fecha: "2026-01-10"
|
|
|
|
- archivo: "directivas/simco/SIMCO-SINCRONIZACION-BD.md"
|
|
alias: "@SYNC_BD"
|
|
obligatoria: true
|
|
descripcion: "Sincronización BD ↔ Código ↔ Docs"
|
|
version: "1.0.0"
|
|
fecha: "2026-01-10"
|
|
|
|
# Agregar a checklists:
|
|
|
|
- archivo: "checklists/CHECKLIST-MANTENIMIENTO-DOCS.md"
|
|
alias: "@CHK_MANTENIMIENTO"
|
|
items: 80
|
|
|
|
- archivo: "checklists/CHECKLIST-SINCRONIZACION-BD.md"
|
|
alias: "@CHK_SYNC_BD"
|
|
items: 70
|
|
|
|
# Agregar a templates:
|
|
|
|
- archivo: "templates/TEMPLATE-DEPRECACION.md"
|
|
alias: "@TPL_DEPRECACION"
|
|
|
|
# Agregar a perfiles:
|
|
|
|
- archivo: "agents/perfiles/PERFIL-DOCUMENTATION-MAINTAINER.md"
|
|
alias: "@PERFIL_DOC_MAINT"
|
|
|
|
# Actualizar metadata:
|
|
metadata:
|
|
total_directivas_simco: 51 # +2
|
|
total_checklists: 10 # +2
|
|
total_templates: 28 # +1
|
|
total_perfiles: 29 # +1
|
|
|
|
# Agregar aliases:
|
|
aliases:
|
|
"@MANTENIMIENTO_DOCS": "orchestration/directivas/simco/SIMCO-MANTENIMIENTO-DOCUMENTACION.md"
|
|
"@SYNC_BD": "orchestration/directivas/simco/SIMCO-SINCRONIZACION-BD.md"
|
|
"@CHK_MANTENIMIENTO": "orchestration/checklists/CHECKLIST-MANTENIMIENTO-DOCS.md"
|
|
"@CHK_SYNC_BD": "orchestration/checklists/CHECKLIST-SINCRONIZACION-BD.md"
|
|
"@TPL_DEPRECACION": "orchestration/templates/TEMPLATE-DEPRECACION.md"
|
|
"@PERFIL_DOC_MAINT": "orchestration/agents/perfiles/PERFIL-DOCUMENTATION-MAINTAINER.md"
|
|
```
|
|
|
|
### 3.2 Extensión de SIMCO-ESTRUCTURA-DOCS.md
|
|
|
|
Agregar después de sección de frontmatter:
|
|
|
|
```markdown
|
|
### Campos de Mantenimiento (Recomendados)
|
|
|
|
Para documentos de larga vida, agregar al frontmatter:
|
|
|
|
| Campo | Tipo | Descripción |
|
|
|-------|------|-------------|
|
|
| maintenance_frequency | string | "monthly" \| "quarterly" \| "annual" \| "on_change" |
|
|
| maintenance_owner | string | Rol o equipo responsable |
|
|
| last_maintenance | date | Fecha última revisión (YYYY-MM-DD) |
|
|
| next_maintenance | date | Fecha próxima revisión (YYYY-MM-DD) |
|
|
| deprecation_date | date | Si está deprecado (YYYY-MM-DD) |
|
|
|
|
Ejemplo:
|
|
```yaml
|
|
---
|
|
title: "Especificación de API de Autenticación"
|
|
type: "specification"
|
|
status: "active"
|
|
version: "2.1.0"
|
|
created_date: "2025-11-01"
|
|
updated_date: "2026-01-10"
|
|
maintenance_frequency: "monthly"
|
|
maintenance_owner: "backend-team"
|
|
last_maintenance: "2026-01-10"
|
|
next_maintenance: "2026-02-10"
|
|
---
|
|
```
|
|
|
|
---
|
|
|
|
## 4. SECUENCIA DE EJECUCIÓN
|
|
|
|
### Sprint 1: Directivas Core (Día 1)
|
|
|
|
| Orden | Tarea | Dependencias |
|
|
|-------|-------|--------------|
|
|
| 1.1 | Crear SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Ninguna |
|
|
| 1.2 | Crear SIMCO-SINCRONIZACION-BD.md | Ninguna |
|
|
|
|
### Sprint 2: Checklists (Día 1)
|
|
|
|
| Orden | Tarea | Dependencias |
|
|
|-------|-------|--------------|
|
|
| 2.1 | Crear CHECKLIST-MANTENIMIENTO-DOCS.md | 1.1 |
|
|
| 2.2 | Crear CHECKLIST-SINCRONIZACION-BD.md | 1.2 |
|
|
|
|
### Sprint 3: Templates y Perfiles (Día 1)
|
|
|
|
| Orden | Tarea | Dependencias |
|
|
|-------|-------|--------------|
|
|
| 3.1 | Crear TEMPLATE-DEPRECACION.md | 1.1 |
|
|
| 3.2 | Crear PERFIL-DOCUMENTATION-MAINTAINER.md | 1.1, 1.2 |
|
|
|
|
### Sprint 4: Integración (Día 1)
|
|
|
|
| Orden | Tarea | Dependencias |
|
|
|-------|-------|--------------|
|
|
| 4.1 | Actualizar INDICE-DIRECTIVAS-WORKSPACE.yml | 1.1, 1.2, 2.1, 2.2, 3.1, 3.2 |
|
|
| 4.2 | Actualizar SIMCO-ESTRUCTURA-DOCS.md | 1.1 |
|
|
| 4.3 | Actualizar checklists/_MAP.md | 2.1, 2.2 |
|
|
|
|
### Sprint 5: Validación (Día 1)
|
|
|
|
| Orden | Tarea | Dependencias |
|
|
|-------|-------|--------------|
|
|
| 5.1 | Validar sintaxis de todos los archivos | 4.* |
|
|
| 5.2 | Validar referencias cruzadas | 4.* |
|
|
| 5.3 | Ejecutar checklist en proyecto piloto | 5.1, 5.2 |
|
|
| 5.4 | Documentar resultado | 5.3 |
|
|
|
|
---
|
|
|
|
## 5. MÉTRICAS DE ÉXITO DEL PLAN
|
|
|
|
| Métrica | Objetivo | Validación |
|
|
|---------|----------|------------|
|
|
| Directivas creadas | 2 | Archivos existen |
|
|
| Checklists creados | 2 | Archivos existen |
|
|
| Templates creados | 1 | Archivo existe |
|
|
| Perfiles creados | 1 | Archivo existe |
|
|
| Índice actualizado | SI | Versión incrementada |
|
|
| Referencias cruzadas válidas | 100% | Grep de aliases |
|
|
| Cobertura de requisitos RF | 100% | Tabla de trazabilidad |
|
|
|
|
---
|
|
|
|
## 6. TRAZABILIDAD DE REQUISITOS
|
|
|
|
| Requisito | Artefacto | Sección |
|
|
|-----------|-----------|---------|
|
|
| RF-01: Purga gradual | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 8 |
|
|
| RF-02: Deprecación sistemática | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 7 |
|
|
| RF-03: Actualización obligatoria | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 3, 4 |
|
|
| RF-04: Validación dependencias | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 5 |
|
|
| RF-05: Scripts BD sincronizados | SIMCO-SINCRONIZACION-BD.md | Sección 4 |
|
|
| RF-06: Análisis de dependencias | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 5 |
|
|
| RF-07: Agentes consulten directivas | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 10, 11 |
|
|
| RF-08: Fases completas | SIMCO-MANTENIMIENTO-DOCUMENTACION.md | Sección 4, 9 |
|
|
|
|
---
|
|
|
|
## 7. RIESGOS Y MITIGACIÓN
|
|
|
|
| Riesgo | Impacto | Mitigación |
|
|
|--------|---------|------------|
|
|
| Directiva muy extensa | Baja adopción | Checklist resumido + perfil especializado |
|
|
| Sobrecarga de proceso | Resistencia | Triggers claros de cuándo aplicar |
|
|
| Inconsistencia con existentes | Confusión | Revisión de integración |
|
|
| Pérdida de información valiosa | Alto | Protocolo de deprecación con período de gracia |
|
|
|
|
---
|
|
|
|
## 8. SIGUIENTE PASO
|
|
|
|
**Proceder a Fase 4: Validación del Plan**
|
|
|
|
Validar:
|
|
1. Cobertura de todos los requisitos
|
|
2. Integración con directivas existentes
|
|
3. Cobertura de prompts de referencia
|
|
4. Viabilidad de ejecución
|
|
|
|
---
|
|
|
|
**Estado:** FASE 3 COMPLETADA
|
|
**Siguiente:** Fase 4 - Validación del Plan
|
|
**Fecha:** 2026-01-10
|