Skip to content

Commit

Permalink
Add best practice for using metric units (#278)
Browse files Browse the repository at this point in the history
* Add best practice for using metric units

* Incorporate PR suggestions
  • Loading branch information
atextor authored Jan 19, 2024
1 parent b8e735a commit 5c77e72
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions documentation/modules/appendix/pages/best-practices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,16 @@ range, while a Property such as `numberOfProducedItems` is not logically limited
[[choosing-a-unit]]
== Choosing a Unit

When trying to refer to a physical unit, please see the
xref:appendix:unitcatalog.adoc[Unit Catalog]. When searching for the unit,
remember that the unit catalog uses British English.
When trying to refer to a physical unit, please see the xref:appendix:unitcatalog.adoc[Unit
Catalog]. When searching for the unit, remember that the unit catalog uses British English, e.g.,
_metre_ instead of _meter_.

TIP: If you're modeling quantities for which both the metric system and the imperial system provide
units, such as meter vs feet, it is always recommended to use the metric system (preferably SI units
like meter or others like kilometer if more common in the domain) – unless there are specific
reasons to create the model differently. In any case it is strongly discouraged to add multiple
Properties in the same scope representing the same value only using different units due to the
inherent complexity.

[[choosing-a-characteristic]]
== Choosing a Characteristic
Expand Down

0 comments on commit 5c77e72

Please sign in to comment.