Skip to content

contribution guidelines update - terminologies instance libraries #71

@lzehl

Description

@lzehl

There are general rules across all terminologies and some specific rules for selected terminologies.

Guidelines across all terminologies instance libraries:

  • Minimum instance contribution: name and definition.
  • atid label is based on name
  • Definition guidelines:
    • One sentence formula: [Term] is a [class] [relative adverb] [characteristic/function].
    • Aim for 20 words or less where possible.
    • Avoid circular definitions.
    • Ensure the characteristics/functions are specific enough to differentiate terms within the same class.
    • Provide examples only where absolute necessary.
  • Description guidelines:
    • Provide a standalone summary complementing the definition.
    • Do not repeat the definition.
    • Aim for less than 300 words.
    • Possible to include: external definition (with citation).
  • Name guidelines:
    • Avoid abbreviations as names.
  • otherCrossReference guidelines:
    • Provide links to all other relevant cross references (excluding the preferred one).
  • otherOntologyIdentifier guidelines:
    • Provide links to all other relevant ontology identifiers (excluding the preferred one).
    • Include InterLex ID if not used as preferred.
  • preferredCrossReference guidelines:
    • Provide the link to the preferred cross reference.
    • Provide KS link here if available.
    • Alternatively: WikiData, PubChem (depending on the instance type)
  • preferredOntologyIdentifier guidelines:
    • Provide the link to the preferred ontological identifier.
    • If not specifically otherwise defined for instance type use the preferred ontology ID specified in InterLex (if term exists in InterLex).
  • synonym guidelines:
    • Provide exact synonyms (including their common abbreviations).

Note: preferred ontologies and cross references need to be specified for all instance types.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions