[dxwg] So, how do you link a CSV file to its documentation... (#1593)

hoehrmann has just created a new issue for https://github.com/w3c/dxwg:

== So, how do you link a CSV file to its documentation... ==
I think https://www.w3.org/TR/2024/CR-vocab-dcat-3-20240118/ should be returned to the Working Group for further work.

While I can read in the document that I can use `dcterms:conformsTo` to reference the JSON Schema documentation for a JSON file, and I can use `dcat:endpointDescription` to reference the documentation of an API, my purpose in reading through the document was to learn how to link a CSV file to a human-readable description of the structure of the file, or a JSON, XML, ... file in a custom format to a human-readable documentation of the structure, elements, attributes, properties, ... of the format. And I am coming up empty.

If I ever had trouble finding the documentation for an API that I know exists, then `dcat:endpointDescription` might be useful to have. But I never really had such trouble. I do, however, very much have trouble working with proprietary CSV, XML, JSON, ... structures that are published without any documentation. And I feel very strongly that it must be obvious from this specification how to link data distributions to their documentation.

Please view or discuss this issue at https://github.com/w3c/dxwg/issues/1593 using your GitHub account


-- 
Sent via github-notify-ml as configured in https://github.com/w3c/github-notify-ml-config

Received on Friday, 22 March 2024 19:52:14 UTC