6692eca99e
- Ejecutar checklist piloto @CHK_MANTENIMIENTO en workspace - Crear guia de uso SIMCO v3.8.0 en shared/knowledge-base/ Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
217 lines
5.3 KiB
Markdown
217 lines
5.3 KiB
Markdown
# Guia de Uso: Sistema SIMCO v3.8.0 - Documentacion y Mantenimiento
|
|
|
|
**Version:** 1.0.0
|
|
**Fecha:** 2026-01-10
|
|
**Sistema:** SIMCO v3.8.0
|
|
|
|
---
|
|
|
|
## Resumen
|
|
|
|
Esta guia explica como usar las nuevas directivas SIMCO v3.7 (Estandarizacion de Documentacion) y v3.8 (Mantenimiento de Documentacion) para mantener la documentacion de proyectos sincronizada, consistente y libre de redundancias.
|
|
|
|
---
|
|
|
|
## 1. Cuando Usar Estas Directivas
|
|
|
|
### 1.1 Directivas de Estandarizacion (v3.7)
|
|
|
|
| Directiva | Cuando Usar | Alias |
|
|
|-----------|-------------|-------|
|
|
| `SIMCO-DOCUMENTACION-PROYECTO.md` | Al crear estructura inicial de docs de un proyecto | @DOC_PROYECTO |
|
|
| `SIMCO-NOMENCLATURA.md` | Al crear archivos, carpetas o nombrar recursos | @NOMENCLATURA |
|
|
| `SIMCO-ESTRUCTURA-DOCS.md` | Al organizar contenido dentro de documentos | @ESTRUCTURA_DOCS |
|
|
| `SIMCO-INVENTARIOS.md` | Al crear o actualizar inventarios YAML | @INVENTARIOS |
|
|
| `SIMCO-TESTING.md` | Al definir cobertura y estandares de tests | @TESTING |
|
|
| `SIMCO-MIGRACIONES-BD.md` | Al crear scripts de migracion o DDL | @MIGRACIONES |
|
|
| `SIMCO-INTEGRACIONES-EXTERNAS.md` | Al documentar APIs o servicios externos | @INTEGRACIONES |
|
|
|
|
### 1.2 Directivas de Mantenimiento (v3.8)
|
|
|
|
| Directiva | Cuando Usar | Alias |
|
|
|-----------|-------------|-------|
|
|
| `SIMCO-MANTENIMIENTO-DOCUMENTACION.md` | Al finalizar tareas significativas para purgar/sincronizar docs | @MANTENIMIENTO_DOCS |
|
|
| `SIMCO-SINCRONIZACION-BD.md` | Cuando hay cambios en DDL que afectan docs y codigo | @SYNC_BD |
|
|
|
|
---
|
|
|
|
## 2. Flujo de Trabajo Tipico
|
|
|
|
### 2.1 Al Iniciar un Proyecto Nuevo
|
|
|
|
```
|
|
1. Cargar @DOC_PROYECTO
|
|
2. Crear estructura base de docs/
|
|
3. Aplicar @NOMENCLATURA para nombres
|
|
4. Crear inventarios con @INVENTARIOS
|
|
```
|
|
|
|
### 2.2 Al Desarrollar Features
|
|
|
|
```
|
|
1. Documentar specs con @ESTRUCTURA_DOCS
|
|
2. Si hay cambios DDL: @MIGRACIONES + @SYNC_BD
|
|
3. Si hay integraciones: @INTEGRACIONES
|
|
4. Crear/actualizar tests: @TESTING
|
|
```
|
|
|
|
### 2.3 Al Finalizar Tareas
|
|
|
|
```
|
|
1. Cargar @MANTENIMIENTO_DOCS
|
|
2. Ejecutar @CHK_MANTENIMIENTO (checklist)
|
|
3. Purgar documentacion obsoleta
|
|
4. Sincronizar inventarios
|
|
```
|
|
|
|
---
|
|
|
|
## 3. Checklists Disponibles
|
|
|
|
| Checklist | Items | Cuando Usar |
|
|
|-----------|-------|-------------|
|
|
| @CHK_DOCUMENTACION | 44 | Validar estructura de documentacion |
|
|
| @CHK_INVENTARIOS | 63 | Validar inventarios YAML |
|
|
| @CHK_NOMENCLATURA | 40 | Validar convenciones de nombres |
|
|
| @CHK_MANTENIMIENTO | 80 | Mantenimiento post-tarea |
|
|
| @CHK_SYNC_BD | 70 | Sincronizacion BD-Codigo-Docs |
|
|
|
|
---
|
|
|
|
## 4. Templates Disponibles
|
|
|
|
| Template | Alias | Uso |
|
|
|----------|-------|-----|
|
|
| TEMPLATE-INVENTARIO-PROYECTO.md | @TPL_INVENTARIO | Crear inventarios YAML |
|
|
| TEMPLATE-INTEGRACION-EXTERNA.md | @TPL_INTEGRACION | Documentar APIs externas |
|
|
| TEMPLATE-MODULO-ESTANDAR.md | @TPL_MODULO_ESTANDAR | Documentar modulos |
|
|
| TEMPLATE-DEPRECACION.md | @TPL_DEPRECACION | Marcar docs como deprecados |
|
|
|
|
---
|
|
|
|
## 5. Ciclo de Mantenimiento (CAPVED + M)
|
|
|
|
```
|
|
C - Contexto → Identificar documentos afectados
|
|
A - Analisis → Detectar inconsistencias y obsolescencia
|
|
P - Planeacion → Definir que sincronizar/purgar
|
|
V - Validacion → Verificar dependencias antes de ejecutar
|
|
E - Ejecucion → Aplicar cambios
|
|
D - Documentar → Registrar cambios realizados
|
|
M - Mantenimiento → Ejecutar @CHK_MANTENIMIENTO
|
|
```
|
|
|
|
---
|
|
|
|
## 6. Estructura de Archivos HERENCIA-SIMCO.md
|
|
|
|
Cada proyecto debe tener su archivo `orchestration/00-guidelines/HERENCIA-SIMCO.md` con:
|
|
|
|
```markdown
|
|
## Directivas de Documentacion (SIMCO v3.7)
|
|
[Tabla de directivas aplicables al proyecto]
|
|
|
|
## Directivas de Mantenimiento (SIMCO v3.8)
|
|
[Tabla de directivas de mantenimiento]
|
|
```
|
|
|
|
---
|
|
|
|
## 7. Ejemplos de Uso
|
|
|
|
### 7.1 Documentar Nueva Integracion
|
|
|
|
```bash
|
|
# 1. Cargar directiva
|
|
"Cargando @INTEGRACIONES para documentar integracion con Stripe"
|
|
|
|
# 2. Usar template
|
|
"Usando @TPL_INTEGRACION como base"
|
|
|
|
# 3. Crear archivo
|
|
docs/02-integraciones/INT-XXX-stripe.md
|
|
```
|
|
|
|
### 7.2 Actualizar Despues de Cambio DDL
|
|
|
|
```bash
|
|
# 1. Cargar directiva
|
|
"Cargando @SYNC_BD para sincronizar cambios DDL"
|
|
|
|
# 2. Ejecutar checklist
|
|
"Ejecutando @CHK_SYNC_BD"
|
|
|
|
# 3. Actualizar
|
|
- database/scripts/
|
|
- backend/entities/
|
|
- backend/DTOs/
|
|
- inventarios/DATABASE_INVENTORY.yml
|
|
```
|
|
|
|
### 7.3 Marcar Documento como Deprecado
|
|
|
|
```bash
|
|
# 1. Cargar template
|
|
"Usando @TPL_DEPRECACION"
|
|
|
|
# 2. Agregar bloque
|
|
[DEPRECATED]
|
|
- Fecha: 2026-01-10
|
|
- Razon: Reemplazado por docs/specs/ET-XXX.md
|
|
- Eliminacion: 2026-02-10
|
|
[/DEPRECATED]
|
|
```
|
|
|
|
---
|
|
|
|
## 8. Perfil Especializado
|
|
|
|
Para tareas de mantenimiento extenso, usar el perfil:
|
|
|
|
```
|
|
@PERFIL_DOC_MAINT → PERFIL-DOCUMENTATION-MAINTAINER.md
|
|
```
|
|
|
|
Este perfil esta optimizado para:
|
|
- Identificacion de documentos obsoletos
|
|
- Sincronizacion entre capas
|
|
- Purga gradual de redundancia
|
|
- Deprecacion sistematica
|
|
|
|
---
|
|
|
|
## 9. Referencias Rapidas
|
|
|
|
### Ubicacion de Directivas
|
|
```
|
|
orchestration/directivas/simco/SIMCO-*.md
|
|
```
|
|
|
|
### Ubicacion de Templates
|
|
```
|
|
orchestration/templates/TEMPLATE-*.md
|
|
```
|
|
|
|
### Ubicacion de Checklists
|
|
```
|
|
orchestration/checklists/CHECKLIST-*.md
|
|
```
|
|
|
|
### Indice Principal
|
|
```
|
|
orchestration/INDICE-DIRECTIVAS-WORKSPACE.yml
|
|
```
|
|
|
|
---
|
|
|
|
## 10. Soporte
|
|
|
|
Para dudas sobre el uso de estas directivas:
|
|
1. Consultar `directivas/simco/_INDEX.md`
|
|
2. Revisar `INDICE-DIRECTIVAS-WORKSPACE.yml`
|
|
3. Ver ejemplos en proyectos actualizados (gamilit, erp-core, template-saas)
|
|
|
|
---
|
|
|
|
**Sistema:** SIMCO v3.8.0 | **Mantenido por:** Tech Lead
|