Skip to main content

Naming Standards

Consistent naming is one of the highest-leverage investments a development team can make. It reduces cognitive load, makes systems self-documenting, and enables automation to work reliably across the platform.

These standards apply to all new work and should be retrofitted to existing resources as opportunities arise.

Quick Reference​

Do Avoid
getUserById() — describes purpose clearlygubid() — ambiguous, no context
transaction_outbox_table — snake_case for DB tablestable1 — generic, uninformative
is_active — boolean with clear meaningtemp — vague, no context
order-service — lowercase kebab-case for k8s resourcesOrderService — uppercase invalid in Kubernetes
orderQueue — camelCase with contextgeneric — no purpose, no protocol

Sections​