# 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 1. Ejecutar este checklist al inicio de cada proyecto nuevo 2. Re-validar trimestralmente para proyectos activos 3. Marcar cada item como [x] cuando se cumpla 4. Documentar excepciones y razones en seccion de notas --- ## 1. Estructura de /docs ### 1.1 Archivos Obligatorios - [ ] Existe `/docs/_MAP.md` como indice principal - [ ] Existe `/docs/README.md` con introduccion al proyecto - [ ] `_MAP.md` tiene tabla de contenido actualizada - [ ] `_MAP.md` tiene 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.md` tiene variables definidas - [ ] `HERENCIA-SIMCO.md` lista directivas aplicables ### 2.2 Inventarios - [ ] Existe `/orchestration/inventarios/` - [ ] Existe `MASTER_INVENTORY.yml` - [ ] `MASTER_INVENTORY.yml` tiene metadata completa - [ ] `MASTER_INVENTORY.yml` tiene 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.md` esta 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 `id` es unico en el proyecto - [ ] Campo `status` usa valores estandar - [ ] Campo `priority` usa valores P0-P3 - [ ] Campos `created_date` y `updated_date` estan 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