workspace-v1/orchestration/checklists/CHECKLIST-NOMENCLATURA.md
rckrdmrd 3a8a459d91 [SIMCO-V38] feat: Implementar sistema SIMCO v3.8.0 completo
## 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>
2026-01-10 08:55:15 -06:00

4.6 KiB

CHECKLIST: Nomenclatura

Version: 1.0.0 Proposito: Validar que archivos y directorios siguen el estandar de nomenclatura Referencia: SIMCO-NOMENCLATURA.md Creado: 2026-01-10


Instrucciones de Uso

  1. Ejecutar al crear nuevos archivos/directorios
  2. Usar como parte del code review
  3. Automatizar con scripts de validacion

1. Archivos de Documentacion

1.1 Requerimientos (RF-*)

  • Formato: RF-{MODULO}-{NUM}.md
  • MODULO en UPPERCASE
  • NUM con padding de 3 digitos (001, 002, etc.)
  • Ejemplo valido: RF-AUTH-001.md

1.2 Especificaciones Tecnicas (ET-*)

  • Formato: ET-{TIPO}-{MODULO}.md o ET-{TIPO}-{MODULO}-{NUM}.md
  • TIPO en (BACKEND|FRONTEND|DATABASE)
  • Ejemplo valido: ET-BACKEND-AUTH.md

1.3 User Stories (US-*)

  • Formato: US-{EPICA}-{NUM}-{descripcion-corta}.md
  • descripcion en kebab-case
  • Ejemplo valido: US-AUTH-001-login-basico.md

1.4 ADRs

  • Formato: ADR-{NNNN}-{descripcion-kebab}.md
  • Numeracion de 4 digitos
  • Ejemplo valido: ADR-0001-monorepo-structure.md

1.5 Documentos Temporales

  • Planes: PLAN-{DESC}-{YYYY-MM-DD}.md
  • Analisis: ANALISIS-{DESC}-{YYYY-MM-DD}.md
  • Validacion: VALIDACION-{DESC}-{YYYY-MM-DD}.md
  • Reportes: REPORTE-{DESC}-{YYYY-MM-DD}.md
  • Fecha siempre al final

1.6 Trazas

  • Formato: TRAZA-{TIPO}-{DESCRIPCION}.md
  • TIPO en (TAREAS|DEPENDENCIAS|PROGRESO)
  • Ejemplo valido: TRAZA-TAREAS-DATABASE.md

1.7 Inventarios

  • Formato: {TIPO}_INVENTORY.yml
  • TIPO en UPPERCASE con underscore
  • Tipos validos: MASTER, DATABASE, BACKEND, FRONTEND
  • Extension siempre .yml (no .yaml)

1.8 Indices

  • Nombre fijo: _MAP.md
  • Underscore al inicio
  • Uno por directorio principal

2. Directorios

2.1 Numeracion de Fases

Rango Uso Ejemplo
00-09 Vision/Estrategia 00-vision-general/
01-89 Fases del proyecto 01-fase-alcance/
90-94 Transversal 90-transversal/
95 Guias 95-guias-desarrollo/
96 Quick reference 96-quick-reference/
97 ADRs 97-adr/
99 Finiquito 99-finiquito/

2.2 Formato de Nombre

  • Formato: {NN}-{nombre-en-kebab-case}/
  • NN es numero de 2 digitos
  • nombre usa guiones, no underscores
  • Todo en minusculas
  • Ejemplo valido: 01-fase-alcance/

2.3 Anti-patrones

  • NO usar espacios en nombres
  • NO usar caracteres especiales
  • NO usar CamelCase en directorios
  • NO omitir la numeracion

3. IDs de Documentos

3.1 Epicas por Proyecto

Proyecto Prefijo Ejemplo
gamilit interno EAI- EAI-001
gamilit extension EXT- EXT-005
erp-core MGN- MGN-010
michangarrito MCH- MCH-001
template-saas SAAS- SAAS-014
  • Prefijo correcto para el proyecto
  • Numeracion secuencial
  • IDs unicos (no repetidos)

3.2 Integraciones

  • Formato: INT-{NNN}
  • Numeracion de 3 digitos
  • Ejemplo valido: INT-001

4. Fechas

4.1 En Nombres de Archivo

  • Formato ISO 8601: YYYY-MM-DD
  • Ejemplo: 2026-01-10
  • Fecha al final del nombre

4.2 En Metadata

  • Mismo formato: YYYY-MM-DD
  • Campos: created_date, updated_date
  • Entre comillas en YAML

4.3 Anti-patrones

  • NO usar DD/MM/YYYY
  • NO usar MM-DD-YYYY
  • NO usar formatos sin separador (20260110)

5. Casos Especiales

5.1 Archivos de Configuracion

  • .env archivos no se comitean
  • .env.example si se comitea
  • Nombres en minusculas con punto inicial

5.2 Archivos Raiz

  • README.md en raiz de cada proyecto
  • CHANGELOG.md si existe
  • LICENSE sin extension

Comandos de Validacion

# Buscar archivos con espacios (anti-patron)
find docs -name "* *"

# Verificar formato de directorios
ls -d docs/[0-9][0-9]-*/

# Verificar indices _MAP.md existen
find docs -type d -exec test -f "{}/_MAP.md" \; -print

# Verificar nomenclatura de inventarios
ls orchestration/inventarios/*.yml

# Buscar fechas mal formateadas
grep -rn "[0-9][0-9]/[0-9][0-9]/[0-9][0-9][0-9][0-9]" docs/

Resultado de Validacion

Resumen

Categoria Items Cumplidos Porcentaje
Archivos 17 %
Directorios 8 %
IDs 5 %
Fechas 6 %
Especiales 4 %
TOTAL 40 %

Archivos con Problemas

{Listar archivos que no cumplen nomenclatura}

Fecha de Validacion

  • Validado por: {nombre/rol}
  • Fecha: {YYYY-MM-DD}

Referencia: SIMCO-NOMENCLATURA.md