Nomenclaturas y Convenciones

Nomenclatura de identificación del proyecto

Cada proyecto se identifica mediante un ID interno con la siguiente estructura:

Año-Consecutivo-Tipo-NombreCorto

Donde:

• Año: año de creación del proyecto (generalmente coincide con el año de solicitud).
• Consecutivo: número incremental que se reinicia cada año (ejemplo: `0001`).
• Tipo: categoría del proyecto. Especialmente cuando son servicios o apis.
• NombreCorto: identificador del proyecto en formato PascalCase.

Ejemplos por tipo:

• Aplicaciones:
  • 2026-0001-SeguimientoBecarios
• APIs/Servicios:
  • 2026-0001-Srv-NominaVehicular
  • 2026-0002-Srv-PagosCentral

Convención sobre el NombreCorto

El campo NombreCorto debe cumplir:

• Formato PascalCase
• Representar el nombre lógico del sistema
• Evitar acentos, espacios y caracteres especiales
• Mantener consistencia respecto al dominio funcional del sistema

Ejemplo de conversión:

• Nombre funcional: Sistema de Seguimiento de Becarios
• NombreCorto: SeguimientoBecarios

Convención para nombres de repositorios y contenedores

Para mantener la trazabilidad entre el registro administrativo y los artefactos técnicos, se establece la siguiente convención:

• El nombre del repositorio Git en GitHub debe ser exactamente igual al ID del proyecto.
• El nombre del contenedor Docker también debe ser exactamente igual al ID del proyecto.

Es decir, se reutiliza el mismo identificador en los tres niveles:

1. Registro administrativo (hoja de control)
2. Repositorio de código fuente
3. Contenedor en la plataforma de ejecución

- Ejemplos

Aplicación

• ID: `2026-0001-AplicacionSeguimientoBecarios`
• Repositorio GitHub: `2026-0001-AplicacionSeguimientoBecarios`
• Nombre de contenedor Docker: `2026-0001-AplicacionSeguimientoBecarios`

API/Servicio

• ID: `2026-0002-Srv-PagosCentral`
• Repositorio GitHub: `2026-0002-Srv-PagosCentral`
• Nombre de contenedor Docker: `2026-0002-Srv-PagosCentral`

- Consideraciones

• El ID no debe alterarse ni abreviarse al crear el repositorio o el contenedor.
• Si un desarrollador decide clonar el repositorio en una carpeta local con otro nombre, esto no afecta la convención oficial, pero se recomienda mantener el mismo nombre para evitar confusiones.
• Cualquier automatización futura (scripts internos, n8n, herramientas de generación de proyectos, etc.) debe asumir que el ID es la fuente de verdad para nombrar repositorios y contenedores.