Naming conventions
Purpose: Consistent variable naming across organization.
Who this page is for
| Audience | Why it matters to you |
|---|---|
| Architects | Define naming |
| Everyone | Follow the rules |
Naming Conventions
Consistency prevents confusion and bugs.
Common pattern: [Domain]-[Detail]-[Type]
Examples:
- form-type (what form?)
- form-step (which step?)
- search-term (what was searched?)
- campaign-name (which campaign?)
- member-segment (what segment?)
Rules
- Lowercase
- form-type (good) - Form_Type (bad)
- Hyphens not underscores
- form-type (good) - form_type (bad)
- No abbreviations
- form-type (good) - fm-typ (bad)
- Consistent across teams
- All teams use "form-type", not some use "formtype"
Document and enforce
- Create naming convention doc
- Include examples
- Use in all SDRs
- Code review checks names
---
Next: QA and validation