emmo-repo / EMMO

Elementary Multiperspective Material Ontology (EMMO)
Other
61 stars 16 forks source link

Improve EMMO entity documentation #259

Open SimonStier opened 7 months ago

SimonStier commented 7 months ago

Based on out discussions in the EMMC taskforce on ontology documentation and demonstration we have defined some suggestion to improve the general procedure and guidelines how to document EMMO entities. The goal is to define recommended annotation properties and when to use them as well as consolidating the current set of annotation properties to be more in line with the expectations of many tool developers (in general they expect reuse of existing terms in favor of custom properties, see also here). For the latter it is also suggested to process release files in that way that more specific annotations are duplicated using the base property (e. g. _:a emmo:elucidation “…” => _:a rdfs:comment “…”)

Property EMMO elucidation Suggestion
rdfs:label > skos:prefLabel: mandatory for all EMMO entities
rdfs:label > skos:altLabel keep it optional, any other label goes here
rdfs:comment > emmo:elucidation Short enlightening explanation aimed to facilitate the user in drawing the connection (interpretation) between a OWL entity and the real world object(s) for which it stands. make it mandatory, make it a subproperty of skos:definition
rdfs:comment > emmo:comment A text that add some information about the entity. replace with skos:note; keep it optional, any other comments
rdfs:comment > emmo:example Illustrative example of how the entity is used. replace it with skos:example
rdfs:comment > emmo:definition Precise and univocal description of an ontological entity in the framework of an axiomatic system. rename to formalDefinition to make it more distinct to skos:definition
rdfs:comment > emmo:figure A link to a graphical representation aimed to facilitate understanding of the concept, or of an annotation. make it a subproperty of rdfs:seeAlso
rdfs:comment > emmo:conceptualization The conceptualisation annotation is a comment that helps the reader to understand how the world has been conceptualised by the ontology authors. None
rdfs:comment > emmo:etymology The etymology annotation explains the origin of a word and the historical development of its meaning. None
rdfs:comment > emmo:contact A person or organisation acting as a contact point for enquiries about the ontology resource None