## 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>
4.5 KiB
4.5 KiB
CHECKLIST: Documentacion de Proyecto
Version: 1.0.0 Proposito: Validar que un proyecto cumple con los estandares de documentacion Referencia: SIMCO-DOCUMENTACION-PROYECTO.md Creado: 2026-01-10
Instrucciones de Uso
- Ejecutar este checklist al inicio de cada proyecto nuevo
- Re-validar trimestralmente para proyectos activos
- Marcar cada item como [x] cuando se cumpla
- Documentar excepciones y razones en seccion de notas
1. Estructura de /docs
1.1 Archivos Obligatorios
- Existe
/docs/_MAP.mdcomo indice principal - Existe
/docs/README.mdcon introduccion al proyecto _MAP.mdtiene tabla de contenido actualizada_MAP.mdtiene metricas de progreso
1.2 Directorios Obligatorios
- Existe
/docs/00-vision-general/ 00-vision-general/contiene VISION-*.md o README.md- Existen directorios de fases numerados (01-, 02-, etc.)
- Cada fase tiene su propio
_MAP.md
1.3 Directorios Opcionales (marcar N/A si no aplica)
- Existe
/docs/90-transversal/(si hay contenido compartido) - Existe
/docs/95-guias-desarrollo/(si hay guias) - Existe
/docs/96-quick-reference/(si hay referencias rapidas) - Existe
/docs/97-adr/(si hay decisiones arquitectonicas) - Existe
/docs/99-finiquito/(si proyecto cerrado)
2. Estructura de /orchestration
2.1 Directorio Guidelines
- Existe
/orchestration/00-guidelines/ - Existe
/orchestration/00-guidelines/CONTEXTO-PROYECTO.md - Existe
/orchestration/00-guidelines/HERENCIA-SIMCO.md CONTEXTO-PROYECTO.mdtiene variables definidasHERENCIA-SIMCO.mdlista directivas aplicables
2.2 Inventarios
- Existe
/orchestration/inventarios/ - Existe
MASTER_INVENTORY.yml MASTER_INVENTORY.ymltiene metadata completaMASTER_INVENTORY.ymltiene resumen de progreso- Existe
DATABASE_INVENTORY.yml(si aplica) - Existe
BACKEND_INVENTORY.yml(si aplica) - Existe
FRONTEND_INVENTORY.yml(si aplica)
2.3 Archivos de Contexto
- Existe
/orchestration/CONTEXT-MAP.yml - Existe
/orchestration/PROJECT-STATUS.md - Existe
/orchestration/README.md PROJECT-STATUS.mdesta actualizado (< 7 dias)
3. Nomenclatura
3.1 Archivos
- Requerimientos siguen patron
RF-{MODULO}-{NUM}.md - Especificaciones siguen patron
ET-{TIPO}-{MODULO}.md - User Stories siguen patron
US-{EPICA}-{NUM}-{desc}.md - ADRs siguen patron
ADR-{NNNN}-{descripcion}.md - Planes siguen patron
PLAN-{DESC}-{FECHA}.md - Todos los indices son
_MAP.md
3.2 Directorios
- Directorios de fase usan formato
{NN}-{nombre-kebab}/ - Numeracion es secuencial sin saltos
- Nombres usan kebab-case (minusculas con guiones)
3.3 Fechas
- Fechas en nombres usan formato
YYYY-MM-DD - Fechas en metadata usan formato
YYYY-MM-DD
4. Contenido de Documentos
4.1 Frontmatter/Metadata
- Documentos tienen frontmatter YAML o tabla de metadata
- Campo
ides unico en el proyecto - Campo
statususa valores estandar - Campo
priorityusa valores P0-P3 - Campos
created_dateyupdated_dateestan presentes
4.2 Estructura de Contenido
- Documentos tienen titulo principal (# Titulo)
- Secciones estan organizadas logicamente
- Existe seccion de Referencias o Dependencias
- Footer incluye fecha de actualizacion
4.3 Referencias Cruzadas
- Links internos funcionan (no rotos)
- Referencias a directivas usan formato @DIRECTIVA
- No existen referencias huerfanas
5. Consistencia de Estados
- Estados de documentos son consistentes
- Documentos "Published" estan completos
- Documentos "Deprecated" indican reemplazo
- Progress en inventarios coincide con realidad
6. Multi-tenancy (si aplica)
- Documentacion menciona consideraciones multi-tenant
- RLS esta documentado en especificaciones de BD
- Variables de tenant estan definidas
Resultado de Validacion
Resumen
| Seccion | Items | Cumplidos | Porcentaje |
|---|---|---|---|
| Estructura /docs | 9 | % | |
| Estructura /orchestration | 12 | % | |
| Nomenclatura | 9 | % | |
| Contenido | 10 | % | |
| Consistencia | 4 | % | |
| TOTAL | 44 | % |
Notas y Excepciones
{Documentar aqui cualquier excepcion justificada}
Fecha de Validacion
- Validado por: {nombre/rol}
- Fecha: {YYYY-MM-DD}
- Proxima revision: {YYYY-MM-DD}
Referencia: SIMCO-DOCUMENTACION-PROYECTO.md