linked-statistics / xkos

A SKOS extension for statistical classifications
35 stars 8 forks source link

Documentation homogeneity #67

Open laurentlefort opened 7 years ago

laurentlefort commented 7 years ago

The current documentation combines a structural description of XKOS (Fig. 1, Section 4, Fig. 5, , Fig. 3.1-3.2, Section 9, Fig. 9) and illustrative examples (Fig. 2, Fig. 4, Section 10 (text and figures)) which together covers all aspects of XKOS and partially describes how XKOS is used in conjunction with other vocabularies. But when comparing the document to documentation automatically generated out of the .ttl file, I have noticed that Fig. 1 (and Table 1) only covers XKOS-defined concepts and that there is not a 1-1 relationships between graphical representations of the ontology (aiming at describing the concepts introduced by XKOS) and of the examples (providing a more complete view of how XKOS and other vocabularies can be used together). For example, it would be good to add a new figure to section 5.2 (Version – managing information over time) which would be a subset of Fig. 1, and also cover information omitted from Fig. 1 e.g. how dcterms:valid should be used in this context. And another one focusing on classification levels for the text in section 6.

tfrancart commented 6 years ago

Fig. 1 and Table 1 are intended to list only XKOS-defined concepts (similar to SKOS Section 2). Fig. 1 will be fixed, see #51 and #53 More examples, in particular the usage of dcterms:valid can be included in a best practices document

tfrancart commented 6 years ago

We leave these potential enhancements for V2, in conjunction for a restructuring of the document as suggested in #68