Code development platform for open source projects from the European Union institutions 🔵 EU Login authentication by SMS has been phased out. To see alternatives please check here

Skip to content

Separate information on usage of a concept from the definition to a usage note

Why? Separating usage information from core definitions creates clearer documentation, where definitions remain concise and focused on the concept's meaning, while usage notes provide practical implementation details and examples. This separation makes documentation easier to maintain and understand.

In the original model, for example in the definition of the changes attribute on a Request, the SEMIC team can find information that is related to examples or usage of the concept. The information after the first sentence is recommended to be moved to a usage note: “Indicates that this work or expression legally changes another. This encompasses the notions of amendment, replacement, repeal, or other types of change. This may be a direct change (textual or non-textual amendment) or a consequential or indirect change."