Software Design/Use a single term to point to a concept
Appearance
Checklist questions:
- A single term is used for a concept in variable, function, class names and API documentation?
Why
[edit | edit source]- Easiness of change (easier to find all places related to the concept that may need to be changed)
- Discoverability (easier to find all places related to the concept in the codebase)
- Apparency of semantics, structuredness, and steepness of learning curve: readers identify the concept quicker
Categories:
- Software Design/Naming
- Software Design/Documentation
- Software Design/Practices applying to statements, expressions, and variables
- Software Design/Practices applying to functions
- Software Design/Practices applying to classes
- Software Design/Practices applying to configuration
- Software Design/Practices applying to documentation and comments