biocaddie / WG3-MetadataSpecifications

WG3 Metadata Specification
28 stars 13 forks source link

Resource descriptions should describe what the resource is about #16

Closed hsolbrig closed 8 years ago

hsolbrig commented 8 years ago

The current resource descriptions start with: "JSON-schema representing ..." (e.g. activity_schema.json -- description: JSON-schema representing an activity/process in the DDI model....). This looks odd when the schema is translated into other representations -- OWL, XML Schema, UML Models, etc. We would recommend that the names be changed to identify what an instance of the schema represents, not a description of what we are looking at. As an example, the activity description might read ""description": "An activity/process in the DDI model. A type of process scheduled in a study". Similarly, the "title" attribute would make more sense described as: "description": "The title/name of the process" instead of "description": "a property to specify the title/name of the process",

agbeltran commented 8 years ago

Totally agree! We will change the descriptions. Thanks

agbeltran commented 8 years ago

The descriptions have been changed for all the entities/properties.