Skip to content

Commit 62d79ae

Browse files
nataledmatentzn
andauthored
Update fp-008-documented.md to include Term adoption (#2395)
* Update fp-008-documented.md to include Term adoption Also formatted Examples section. NOTE: more work needed for this principle in terms of text and arrangement. * Update principles/fp-008-documented.md Co-authored-by: Nico Matentzoglu <[email protected]> * Update principles/fp-008-documented.md Co-authored-by: Nico Matentzoglu <[email protected]> --------- Co-authored-by: Nico Matentzoglu <[email protected]>
1 parent f45095c commit 62d79ae

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

principles/fp-008-documented.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,35 @@ The owners of the ontology should strive to provide as much documentation as pos
1818

1919
Central to the issue of ontology documentation is ensuring transparency and traceability of artefact development. For each of the development steps, clear procedures should be made available. Documentation availability will be used to assess the quality of the resource. The following itemized list provides a core checklist, distinguishing general ontology documentation (general information about the resource) and local ontology documentation (documentation at artefact level itself and representational unit level (class and relations)). Documentation assessment with the purpose of assessing Ontology soundness, will cover updates and revision to the documentation. As ontology evolve, so should the documentation, for example by including a release documentation file.
2020

21+
## Recommendations and Requirements
22+
23+
## Implementation
24+
### Term adoption
25+
If a term that was previously defined in an identifier space belonging to ontology A (e.g. http://purl.obolibrary.org/obo/A_123) is adopted by ontology B (with a different identifier scheme, e.g. http://purl.obolibrary.org/obo/B_123) the following annotation assertion MUST be added to that term:
26+
27+
OWL format (Turtle serialisation):
28+
`<http://purl.obolibrary.org/obo/A_123> rdfs:isDefinedBy <http://purl.obolibrary.org/obo/b.owl>`
29+
30+
OBO format:
31+
`property_value: isDefinedBy http://purl.obolibrary.org/obo/b.owl`
32+
2133
## Examples
2234

23-
- _Embedded or 'in-situ' documentation_:
35+
_Embedded or 'in-situ' documentation_:
2436
Namely any specific metadata available from the ontology artefact itself providing information about the resource in its entirety or parts of it.
2537
global ontology description (about the ontology as a whole):
2638
- creator(s)
2739
- maintainer(s)
2840
- license
2941
- version
3042

31-
- _local ontology documentation (about each term):_
43+
_local ontology documentation (about each term):_
3244
documentation for individual representational unit annotation
3345
- justify the different elements of class metadata
3446
- justify class axiomatization
3547
documentation about the textual definition: is it manually created or generated with software assistance by relying on patterns and class axioms.
3648

37-
- _User documentation:_
49+
_User documentation:_
3850
A documentation detailing the ontology's raison d'etre, its coverage, the use cases and query cases (including translation into SPARQL queries) it is intended to support
3951
documentation about how to access the resource
4052
documentation about how to produce semantic web document compatible with the representation intended by the developers (OWL examples, OWL coding patterns)
@@ -43,7 +55,7 @@ Central to the issue of ontology documentation is ensuring transparency and trac
4355
- availability of presentations (e.g. on slideshare)
4456
- availability of web seminars (e.g. on a youtube channel)
4557

46-
- _Developer documentation:_
58+
_Developer documentation:_
4759

4860
- documentation about collaborating and submitting issues by creating a [CONTRIBUTING.md file](http://mozillascience.github.io/working-open-workshop/contributing/) as described [here](http://obofoundry.org/principles/fp-020-responsiveness.html#implementation).
4961
- documentation about authors contributions

0 commit comments

Comments
 (0)