## 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>
7.4 KiB
7.4 KiB
CHECKLIST: Mantenimiento de Documentación
Versión: 1.0.0 Alias: @CHK_MANTENIMIENTO Referencia: SIMCO-MANTENIMIENTO-DOCUMENTACION.md Items Totales: 80 Fecha: 2026-01-10
Instrucciones de Uso
- Ejecutar al completar tarea o fase significativa
- Marcar cada item conforme se valida
[x] - Documentar excepciones con justificación
- Si un item no aplica, marcar
[N/A]con razón - Guardar checklist completado como evidencia
1. IDENTIFICACIÓN (10 items)
Objetivo: Determinar alcance del mantenimiento
- 1.1 Listar todos los documentos modificados en la tarea
- 1.2 Listar documentos con dependencia directa (que referencian a los modificados)
- 1.3 Listar documentos dependientes (que son referenciados por los modificados)
- 1.4 Identificar documentos con >3 meses sin actualizar en el área afectada
- 1.5 Verificar frontmatter YAML de cada documento modificado
- 1.6 Identificar secciones potencialmente obsoletas
- 1.7 Revisar referencias cruzadas en documentos afectados
- 1.8 Listar inventarios que deben actualizarse
- 1.9 Identificar scripts de BD afectados (si aplica)
- 1.10 Documentar alcance total del mantenimiento
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
2. SINCRONIZACIÓN (15 items)
Objetivo: Alinear documentación con realidad actual
Specs vs Código
- 2.1 Specs técnicos (ET-*) actualizados vs código implementado
- 2.2 Requerimientos (RF-*) reflejan estado actual
- 2.3 User Stories (US-*) tienen estado correcto
- 2.4 Ejemplos de código en docs son válidos y ejecutables
Backend
- 2.5 Entities sincronizadas con DDL actual
- 2.6 DTOs sincronizados con entities
- 2.7 API specs/Swagger actualizado vs controllers
Frontend
- 2.8 Types/interfaces sincronizados con API responses
- 2.9 Documentación de componentes actualizada
Inventarios
- 2.10 DATABASE_INVENTORY.yml refleja BD actual
- 2.11 BACKEND_INVENTORY.yml refleja código actual
- 2.12 FRONTEND_INVENTORY.yml refleja componentes actuales
- 2.13 MASTER_INVENTORY.yml tiene resumen correcto
Índices
- 2.14 Todos los _MAP.md actualizados en directorios afectados
- 2.15 Fechas
updated_dateen frontmatter actualizadas
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
3. VALIDACIÓN DE DEPENDENCIAS (15 items)
Objetivo: Verificar coherencia y dependencias
Dependencias Verticales
- 3.1 Cambios en specs reflejados en épicas/roadmap si afectan alcance
- 3.2 Cambios en HUs reflejados en specs técnicos
- 3.3 Jerarquía de documentos consistente
Dependencias Horizontales
- 3.4 DDL ↔ Entities sincronizados
- 3.5 Entities ↔ DTOs sincronizados
- 3.6 API ↔ Frontend types sincronizados
- 3.7 Docs ↔ Código consistentes
Referencias
- 3.8 Links internos entre documentos funcionan
- 3.9 Referencias a archivos de código son válidas
- 3.10 No hay referencias a documentos eliminados
- 3.11 No hay referencias a código eliminado
Validaciones Técnicas
- 3.12 Build exitoso después de cambios
- 3.13 Lint exitoso después de cambios
- 3.14 Tests unitarios pasan
- 3.15 Recreación de BD exitosa (si aplica cambios DDL)
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
4. DEPRECACIÓN (10 items)
Objetivo: Marcar documentos obsoletos correctamente
Identificación
- 4.1 Documentos obsoletos identificados
- 4.2 Razón de obsolescencia documentada
Marcado
- 4.3 Bloque [DEPRECATED] agregado al inicio de docs obsoletos
- 4.4 Fecha de deprecación especificada
- 4.5 Documento o recurso de reemplazo indicado
- 4.6 Fecha de eliminación planificada (mínimo 30 días)
Actualización de Índices
- 4.7 _MAP.md actualizado con estado DEPRECATED
- 4.8 Changelog actualizado con deprecaciones
Notificación
- 4.9 Equipos afectados notificados de deprecaciones
- 4.10 No se deprecó información valiosa sin respaldo
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
5. PURGA GRADUAL (10 items)
Objetivo: Eliminar redundancia manteniendo esencia
Identificación
- 5.1 Secciones redundantes entre documentos identificadas
- 5.2 Información duplicada identificada para consolidar
- 5.3 Verbosidad innecesaria identificada
Ejecución
- 5.4 Secciones duplicadas eliminadas/consolidadas
- 5.5 Ejemplos de código obsoletos eliminados
- 5.6 TODOs antiguos resueltos o eliminados
- 5.7 Referencias a versiones muy antiguas eliminadas
- 5.8 Warnings/notas temporales cumplidas eliminadas
Validación
- 5.9 Purga no excede 20% del contenido original
- 5.10 Contexto histórico valioso preservado (ADRs, decisiones)
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
6. VERIFICACIÓN FINAL (15 items)
Objetivo: Confirmar mantenimiento exitoso
Frontmatter
- 6.1 Todos los docs tienen frontmatter YAML válido
- 6.2 Todas las fechas
updated_dateactualizadas - 6.3 Todas las versiones incrementadas donde aplica
- 6.4 Estados (
status) actualizados
Índices e Inventarios
- 6.5 Todos los _MAP.md actualizados
- 6.6 DATABASE_INVENTORY actualizado
- 6.7 BACKEND_INVENTORY actualizado
- 6.8 FRONTEND_INVENTORY actualizado
- 6.9 MASTER_INVENTORY actualizado
Validaciones Técnicas
- 6.10 Scripts de BD ejecutables sin errores
- 6.11 Build final exitoso
- 6.12 Tests finales exitosos
Documentación
- 6.13 Traza de mantenimiento creada/actualizada
- 6.14 PROXIMA-ACCION.md actualizado si hay trabajo pendiente
- 6.15 Commit realizado con mensaje descriptivo
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
7. CARGA DE CONTEXTO PARA SUBAGENTES (5 items)
Objetivo: Asegurar contexto para futuras delegaciones
- 7.1 Directivas relevantes para el área están documentadas en HERENCIA-SIMCO.md
- 7.2 Contexto heredable actualizado si cambió estructura del proyecto
- 7.3 Instrucciones para subagentes claras en docs afectados
- 7.4 Perfiles compactos actualizados si se agregaron nuevas capacidades
- 7.5 SESSION-TRACKING actualizado si hubo trabajo paralelo
Notas de esta sección:
[Anotar aquí observaciones o excepciones]
RESUMEN DE EJECUCIÓN
| Sección | Items | Completados | N/A | Pendientes |
|---|---|---|---|---|
| 1. Identificación | 10 | |||
| 2. Sincronización | 15 | |||
| 3. Validación Dependencias | 15 | |||
| 4. Deprecación | 10 | |||
| 5. Purga Gradual | 10 | |||
| 6. Verificación Final | 15 | |||
| 7. Carga de Contexto | 5 | |||
| TOTAL | 80 |
RESULTADO
| Campo | Valor |
|---|---|
| Fecha de ejecución | {YYYY-MM-DD} |
| Ejecutado por | {nombre/agente} |
| Proyecto | {nombre del proyecto} |
| Tarea/Fase | {referencia a tarea o fase} |
| Resultado | {APROBADO / CON OBSERVACIONES / REQUIERE REVISIÓN} |
Observaciones Generales
[Anotar observaciones generales del mantenimiento]
Issues Encontrados
[Listar issues que requieren atención posterior]
Acciones Pendientes
[Listar acciones que quedaron pendientes con responsable]
Referencia: @MANTENIMIENTO_DOCS