Skip to content

Commit

Permalink
Update rules/when-to-use-technical-terms/rule.md
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Mackay [SSW] <[email protected]>
  • Loading branch information
matt-goldman-ssw and danielmackay authored Nov 5, 2024
1 parent b23dcdd commit 6027685
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion rules/when-to-use-technical-terms/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Naming is most effective when it aligns with the audience’s understanding. In

## Choosing the Right Term
### Use Domain Terms for Business Logic
When naming classes, methods, or variables that represent core business concepts, use terms that reflect the language of the domain. This approach, often called ubiquitous language, helps ensure that the code is understandable to developers and domain experts alike, reducing the risk of misinterpretation. For example, in a retail application, classes like `Order`, `ProductCatalog`, and `CustomerAccount` use domain terms that match stakeholders' understanding.
When naming classes, methods, or variables that represent core business concepts, use terms that reflect the language of the domain. This approach, often called *ubiquitous language*, helps ensure that the code is understandable to developers and domain experts alike, reducing the risk of misinterpretation. For example, in a retail application, classes like `Order`, `ProductCatalog`, and `CustomerAccount` use domain terms that match stakeholders' understanding.

### Use Technical Terms for Implementation Details
Conversely, use technical terms for internal or lower-level code that doesn't directly involve business logic. These terms should clearly describe the technical functionality, helping developers quickly understand the purpose without needing domain context. For instance, classes or methods named `CacheIntercepter`, `AnalyticsLogger`, or `CustomerRepository` make sense to developers without domain knowledge, focusing instead on their technical purpose.
Expand Down

0 comments on commit 6027685

Please sign in to comment.