Link Search Menu Expand Document

Ontology and knowledge graph development and documentation guidelines

Ontology development and documentation guidelines

Ontology development guidelines

  • The namespace of the ontology (published within the Polifonia Ontology network) must follow this rule:
    • Rule: https://w3id.org/polifonia/ontology/[name-of-the-ontology
    • Example: https://w3id.org/polifonia/ontology/musical-composition
    • This rule is in line with the recommendations for URIs that can be found in the literature, specifically those by ISA project, since it uses a dedicated service (w3id.org), and mentions the type of the resource in the URI, i.e. ontology, along with the specific ontology module
    • A preferred prefix should be indicated for each namespace
  • The ontology should be annotated with labels (rdfs:label) and comments (rdfs:comment).
  • The ontology should contain alignments to possible ODPs reused:
    • Such alignments make it explicit which patterns have been reused, supporting a pattern-based exploration of the ontology, and guaranteeing interoperability between ontologies at the level of patterns.
    • Such alignments should be expressed through OPLaX ontology, which reuses and extends state-of-the-art patterns annotation languages.
    • See an example of an ontology annotated with the reused patterns here: https://github.com/ICCD-MiBACT/ArCo/blob/master/ArCo-release/ontologie/catalogue/1.2/catalogue.owl
  • The ontology should contain alignments to possible ontologies produced by partners of Polifonia and reused within the project.

Ontology documentation guidelines

  • Each ontology (published within the Polifonia Ontology network) should be stored as an RDF/OWL file in a GitHub repository.
    • The name of the repository should follow this rule:
      • Rule: [name-of-ontology]-ontology
      • Example: https://github.com/polifonia-project/musical-performance-ontology
  • The documentation of the ontology in the README.md file:
    • The README.md file must contain a brief description of the scope of the ontology.
    • The README.md file should contain useful statistics about the ontology in order to give an overview (number of classes, number of properties, …)
    • The README.md file must contain examples of relevant Competency Questions with respective SPARQL queries
    • The README.md file must contain a graphical representation of classes and predicates.
    • The README.md file should contain the licence for the reuse (hence responsible people).
  • The repository must include a separate folder containing ontology tests following eXtreme Design methodology (it is recommended to use the XDTesting tool).
  • For each ontology produced by partners of Polifonia and reused within the project, but published outside the Polifonia Ontology Network, it should exist a repository linking to the ontology.
  • Information about the ontology must be added/updated in the Network Ontology GitHub repository.

Knowledge graph development and documentation guidelines

Knowledge graph development guidelines

  • The namespace of the knowledge graph (published within Polifonia) needs to follow the rule:
    • Rule: https://w3id.org/polifonia/resource/[class-local-name]/[SHA-1 hash function of the unique attribute(s) of the individual]
    • Example: https://w3id.org/polifonia/resource/Score/ec68f1e4727ecdd5272d247f3e3176743e38b469 for an entity of type Score, with the hash generated from the concatenation of the title and the composer of the composition of the score
    • This rule is in line with the recommendations for URIs reported by the ISA project, that is http://{domain}/{type}/{concept}/{reference}, where the domain is a combination of the host and the relevant sector (w3id.org/polifonia/), the type is the type of resource that is being identified (resource/), the concept is the type of real world object identified ([class-local-name]), and the reference is a specific item [SHA-1 hash function of the unique attribute(s) of the individual]. See here for more information.
  • The knowledge graph should contains links (owl:sameAs) to the Wikidata knowledge graph.
  • The knowledge graph needs to be deployed on the web through a SPARQL endpoint containing all relevant prefixes.

Knowledge graph documentation guidelines

  • The knowledge graph must be documented in a GitHub repository, that follows the rules already defined in the Polifonia rulebook valid for all GitHub repositories.
  • The documentation of the ontology in the README.md file:
    • The README.md file must contain a brief description of the scope of the knowledge graph.
    • The README.md file must contain the link to the SPARQL endpoint.
    • The README.md file should contain useful statistics about the KG (number of triples, most populated classes, …)
    • The README.md file should mention the data sources of the KG
    • The README.md file should contain examples of relevant Competency Questions with respective SPARQL queries
    • The README.md file should contain the licence for data reuse (hence responsible people).
  • A copy of data (Linked Open Data) should be linked in a dedicated folder in the repository. If the data volume exceeds 500MB, split data into different files. If data are difficult to split, use ntriples / quads serialisation. Otherwise, any other standard serialisation available.
  • A story created with Melody, containing relevant queries that can be run on the knowledge graph, should be present in the documentation. At least one query should showcase the entity linking with Wikidata.