Convenciones de Nombrado — ZeroQ Knowledge Base
Reglas Generales de Archivos
| Elemento | Convención | Ejemplo |
|---|---|---|
| Servicio | SVC-<NombreServicio>.md | SVC-Queue-Engine.md |
| Feature | FEAT-<NombreFeature>.md | FEAT-Virtual-Queue.md |
| Integración | INT-<NombreIntegracion>.md | INT-SSO-SAML.md |
| Infraestructura | INFRA-<Componente>.md | INFRA-Kubernetes-Cluster.md |
| Política | POL-<NombrePolitica>.md | POL-Access-Control.md |
| Procedimiento | PROC-<NombreProcedimiento>.md | PROC-Incident-Response.md |
| Módulo | MOD-<NombreModulo>.md | MOD-Appointments.md |
| RFP | RFP-<Categoria>-<Tema>.md | RFP-Security-Encryption.md |
| Data Flow | DF-<NombreFlujo>.md | DF-Ticket-Lifecycle.md |
| DRP | DRP-<Componente>.md | DRP-Database-Failover.md |
| Template | TEMPLATE-<Tipo>.md | TEMPLATE-Service.md |
Reglas de Carpetas
- Las carpetas usan
PascalCaseokebab-casecon 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.
Reglas de Wikilinks
# Correcto
related_services:
- "[[SVC-Queue-Engine]]"
- "[[SVC-Notification-Service]]"
# Incorrecto
related_services:
- Queue Engine
- "ver archivo de notificaciones"
Reglas de Revisión
| Ciclo | Aplica a |
|---|---|
quarterly | Servicios, features, integraciones |
annual | Políticas, compliance, DRP |