What problem does it solve?
Naming identifiers across codebases is inconsistent, ambiguous, and often hard to maintain; this guide provides a compact, language-agnostic approach to make variable and function names clear, memorable, and accurate about intent.
Core Features & Use Cases
- Defines the S-I-D principles (short, intuitive, descriptive) to evaluate and improve names.
- Presents the A/HC/LC pattern to structure actions, high context, and low context for function names and shows recommended verb/prefix usage and boundary naming.
- Use cases include naming new variables and functions, performing code reviews focused on naming consistency, and guiding refactors or team style guides.
- Example: when refactoring a component, apply the pattern to rename ambiguous identifiers into concise names that reveal action and context.
Quick Start
Apply the A/HC/LC pattern to rename ambiguous identifiers so they are short, intuitive, and descriptive in one file or across a code review.