eclipse-esmf / esmf-semantic-aspect-meta-model

Formal and textual specification of the Semantic Aspect Meta Model (SAMM)
https://eclipse-esmf.github.io/samm-specification/snapshot/index.html
Mozilla Public License 2.0
47 stars 9 forks source link

[Task] Review terms for mandatory/optional actions ("should"/"must") for RBS docs & SAMM spec #249

Closed KobOp closed 1 year ago

KobOp commented 1 year ago

Is your task related to a problem? Please describe. In its current form, e.g. the https://docs.bosch-semantic-stack.com/introduction.html (incl. BAMM spec) is not always as precise as it should be when referring to mandatory/optional concepts. For example, the model guidelines and naming conventions are not always making it clear which requirements are mandatory and which are advises.

Describe the solution you'd like Terms "must", "must not", "should" and "should not" are used consistently throughout the entire documentation. https://docs.bosch-semantic-stack.com/introduction.html and https://eclipse-esmf.github.io/esmf-documentation/index.html are reviewed for consistent usage. (Remark: Only specification parts (e.g. SAMM) have to follow this pattern very rigidly)