Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A profile should have human-readable documentation that expresses for humans the main components of a profile, which can also be available as machine-readable resources (ontology or schema files, SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations on how to use them, constraints that determine what data is valid according to the profile, etc. [ID37] (5.37) #272

Open
nicholascar opened this issue Jun 27, 2018 · 4 comments
Labels
plenary-approved profile-guidance requirement requires discussion Issue to be discussed in a telecon (group or plenary)

Comments

@nicholascar
Copy link
Contributor

Entered from Google Doc.

From the documents accessible from references in this use case, it should be possible to infer more specific requirements in terms of profile documentation, but I lack time. It could be captured by other cases. It should maybe be addressed at a later stage of DXWG work.

@nicholascar nicholascar added requirement profile-guidance requires discussion Issue to be discussed in a telecon (group or plenary) labels Jun 27, 2018
@nicholascar nicholascar changed the title Requirement: a profile should have human-readable documentation that expresses for humans the main components of a profile, which can also be available as machine-readable resources (ontology or schema files, SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations on how to use them, constraints that determine what data is valid according to the profile, etc. A profile should have human-readable documentation that expresses for humans the main components of a profile, which can also be available as machine-readable resources (ontology or schema files, SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations on how to use them, constraints that determine what data is valid according to the profile, etc. Sep 1, 2018
@aisaac
Copy link
Contributor

aisaac commented Nov 7, 2018

NB: this requirement was APPROVED with agreement that it may need to be re-worded or shortened

@kcoyle
Copy link
Contributor

kcoyle commented Nov 8, 2018

Yes, it was assumed that the UCR group would propose better wording. You should feel free to do so.

@aisaac
Copy link
Contributor

aisaac commented Nov 8, 2018

I will probably have to pass for now...

@nicholascar
Copy link
Contributor Author

In PROF terms a Profile, http://example.org/resource/profile-x, SHOULD have this:

<http://example.org/resource/profile-x> a prof:Profile ;
  prof:hasResource [  # a Resource Descriptor
    rdfs:label "Guidance document" ;
    dct:format "http://w3id.org/mediatype/application/pdf" ;
    prof:hasRole <http://www.w3.org/ns/prof/roles/Guidance> ;  # just using a possible namespace
    prof:hasArtifact <http://example.org/resource/docs/profile-x.pdf>  # the actual PDF Guidance doc
] ;
#... other Resource Descriptors for things such as SHACL files

@aisaac aisaac changed the title A profile should have human-readable documentation that expresses for humans the main components of a profile, which can also be available as machine-readable resources (ontology or schema files, SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations on how to use them, constraints that determine what data is valid according to the profile, etc. A profile should have human-readable documentation that expresses for humans the main components of a profile, which can also be available as machine-readable resources (ontology or schema files, SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations on how to use them, constraints that determine what data is valid according to the profile, etc. [ID37] (5.37) Nov 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plenary-approved profile-guidance requirement requires discussion Issue to be discussed in a telecon (group or plenary)
Projects
None yet
Development

No branches or pull requests

4 participants