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 clearly | gubid() — ambiguous, no context |
transaction_outbox_table — snake_case for DB tables | table1 — generic, uninformative |
is_active — boolean with clear meaning | temp — vague, no context |
order-service — lowercase kebab-case for k8s resources | OrderService — uppercase invalid in Kubernetes |
orderQueue — camelCase with context | generic — no purpose, no protocol |
Sections
📄️ Principles
Guiding principles for evaluating and designing naming standards.
🗃️ Code & Files
5 items
🗃️ APIs & Services
3 items
📄️ Databases
Naming conventions for database tables, columns, and indexes.
📄️ Infrastructure
Naming conventions for Kubernetes resources (RFC 1123), environment variables, and cache keys.