Skip to content

Uberon Documentation System

Shahim Essaid edited this page Feb 2, 2015 · 1 revision

Uberon documentation system (advanced)

Introduction

Maintaining documentation for an ontology can be difficult - it is easy for the ontology contents and documentation to diverge over time.

A solution borrowed from software engineering is inline documentation. Here the documentation is a living part of the ontology.

Details

Uberon documentation system

See

Note the root of the documentation is an OWL individual, with a PURL

Applying to other ontologies

Currently the pipeline is hardwired to uberon and uses some difficult to install perl. This will be migrated to a more robust framework in Oort.

For now follow these recommendations

  • create a separate OWL individual for every piece of documentation. Each item should be reasonably small and granular
  • use markdown for formatting
  • use standard vocabulary tags
  • dc:title
  • rdfs:seeAlso (with anyURL types)
  • dc:author
  • dc:contributor