OBOAcademy / obook

OBO Organized Knowledge: Training materials for becoming an OBO engineer
https://oboacademy.github.io/obook/
Creative Commons Zero v1.0 Universal
93 stars 38 forks source link

Suggested edits to ontology-curator-go-style.md #110

Closed dosumis closed 2 years ago

dosumis commented 2 years ago

The new editor pathway material is a good start but is quite jumbled. The first doc on the pathway is a a pretty big involved tutorial and should be marked as such. It's not a great document for reference, but could be mined for material that is.

I suggest explicitly structuring the doc as an editor's manual suggest and separating out ontology editing from pipeline/workflow and GitHub issues. Ontology editing reference should be linked to lessons that given some background/theory.

Here's my attempt at a quick sketch of structure

Protege basics (we can also link to content here - https://protegewiki.stanford.edu/wiki/Protege4UserDocs#Editor_features - only partly out of date)

OBO-stye term annotation

Term merging and obsoletion:

Efficient addition of new terms using duplication:

shawntanzk commented 2 years ago

A few questions: 1) should relations get taught above editing? I remember @dosumis going through that with me very early on 2) should curators handle import management and templates?

Here's my strategy for getting to the above: I'll create a draft PR with the above headers in the pathway, and we can start creating documents and merging them into main (without linking for now). On each PR I'll add the links (updating with main) on the draft PR to keep track of it. Once everything is together, we can push through that PR with the links all in place.