You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: principles/fp-008-documented.md
+16-4Lines changed: 16 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -18,23 +18,35 @@ The owners of the ontology should strive to provide as much documentation as pos
18
18
19
19
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.
20
20
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:
Namely any specific metadata available from the ontology artefact itself providing information about the resource in its entirety or parts of it.
25
37
global ontology description (about the ontology as a whole):
26
38
- creator(s)
27
39
- maintainer(s)
28
40
- license
29
41
- version
30
42
31
-
-_local ontology documentation (about each term):_
43
+
_local ontology documentation (about each term):_
32
44
documentation for individual representational unit annotation
33
45
- justify the different elements of class metadata
34
46
- justify class axiomatization
35
47
documentation about the textual definition: is it manually created or generated with software assistance by relying on patterns and class axioms.
36
48
37
-
-_User documentation:_
49
+
_User documentation:_
38
50
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
39
51
documentation about how to access the resource
40
52
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
43
55
- availability of presentations (e.g. on slideshare)
44
56
- availability of web seminars (e.g. on a youtube channel)
45
57
46
-
-_Developer documentation:_
58
+
_Developer documentation:_
47
59
48
60
- 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).
0 commit comments