search

NIEM / NIEM-NDR

The NIEM Naming and Design Rules
https://niem.github.io/NIEM-NDR/
6 stars 6 forks source link

Question about Rule 10-53 - Local terminology - Exclusive to component names? #40

Closed cdmgtri closed 4 years ago

cdmgtri commented 7 years ago

Section 10.8.2.1. Use of Acronyms, Initialisms, Abbreviations, and Jargon

The definition of "local term" indicates that it must be used in the name of a schema component.

  1. It is used in the local name of a schema component within the schema document.

Rule 10-53. Local terminology interpretation

The use of "may" in the rule text makes it sound like it is optional for a local term to appear in a component name - definition use might also be valid, as well as no other appearance of the local term in the schema at all (which can occur if the relevant component is removed from a future release and the corresponding term is overlooked and remains behind).

  1. The value of the attribute term is the local term; it may occur as a term within the name of a schema component within the schema document.

Is local terminology exclusive to type and property names? Should the "may" in Rule 10-53 part 1 change to a "MUST"? This would be something an automated QA test could check.

webb commented 6 years ago

There's not a rule that any local term must be used. Maybe a schema includes a local term just to clarify something that's in documentation.