Grafo Salir
📋 policy approved high 👤 Engineering Lead 📅 Mon Feb 16 2026 21:00:00 GMT-0300 (Chile Summer Time)

Convenciones de Nombrado — ZeroQ Knowledge Base

Reglas Generales de Archivos

ElementoConvenciónEjemplo
ServicioSVC-<NombreServicio>.mdSVC-Queue-Engine.md
FeatureFEAT-<NombreFeature>.mdFEAT-Virtual-Queue.md
IntegraciónINT-<NombreIntegracion>.mdINT-SSO-SAML.md
InfraestructuraINFRA-<Componente>.mdINFRA-Kubernetes-Cluster.md
PolíticaPOL-<NombrePolitica>.mdPOL-Access-Control.md
ProcedimientoPROC-<NombreProcedimiento>.mdPROC-Incident-Response.md
MóduloMOD-<NombreModulo>.mdMOD-Appointments.md
RFPRFP-<Categoria>-<Tema>.mdRFP-Security-Encryption.md
Data FlowDF-<NombreFlujo>.mdDF-Ticket-Lifecycle.md
DRPDRP-<Componente>.mdDRP-Database-Failover.md
TemplateTEMPLATE-<Tipo>.mdTEMPLATE-Service.md

Reglas de Carpetas

  • Las carpetas usan PascalCase o kebab-case con guiones.
  • Los prefijos numéricos (00-, 01-, etc.) definen el orden de lectura.
  • Subcarpetas de clientes usan el nombre formal del cliente: 05-Clients/ClienteABC/.

Reglas de Tags en Frontmatter

  • type: siempre en minúsculas, singular.
  • status: solo valores permitidos → draft, approved, deprecated.
  • criticality: solo valores permitidos → low, medium, high, mission-critical.
  • environment: solo valores permitidos → prod, staging, shared, dedicated.
  • related_services: lista de [[wikilinks]] a otros servicios.
  • depends_on: lista de [[wikilinks]] a dependencias técnicas.

Reglas de Contenido

  • Un servicio = un archivo. Nunca se documenta un servicio en múltiples archivos.
  • No se duplica información. Se referencia con [[wikilinks]].
  • Las relaciones se declaran en metadatos, no copiando texto.
  • Toda integración tiene su propio archivo en 01-Architecture/Integrations/.
  • Todo cliente con entorno dedicado tiene su subcarpeta en 05-Clients/.
  • Feature no documentada = feature no terminada.
  • Cambio sin actualización de documentación = cambio no aprobado.
# Correcto
related_services:
  - "[[SVC-Queue-Engine]]"
  - "[[SVC-Notification-Service]]"

# Incorrecto
related_services:
  - Queue Engine
  - "ver archivo de notificaciones"

Reglas de Revisión

CicloAplica a
quarterlyServicios, features, integraciones
annualPolíticas, compliance, DRP