How to Review the 2016 Q2 Development Draft

Owned by Wendy Thomas
Last updated: Oct 05, 2016 by Jon Johnson

General Instructions:

The intent of this review is to check in with DDI users on our progress to date. DDI-Views involves a new model driven perspective, a more production focused development structure (i.e. bindings and documentation are produced from the model), a focused set of products, and greater ease of use. As such we need feed-back on what we are doing (the model, documentation, and bindings) as well as how we are doing it (production process).


This second release is limited and not intended to be used as a basis for implementation. It is a Development Draft of a core portion of our work to date. Therefore it does not cover more than the subset of classes found in the first release plus a data capture structure using a Process Pattern, Data Description (logical and format), and Customized Metadata. There are four Functional Views using only classes found in the Q2 release show what a DDI user would see if selecting a Functional View to meet a specific need. Functional Views include information on their purpose, intended audience, applicable use cases, and information on the use of the included classes. These should be evaluated in terms of the ability of the included classes to meet the intended use of the Functional View.

Note that Design Principles have been modified since the Q1 2015 review.

Reviewing the Modeling Guidelines for Business Modelers will be useful for questions arising about standardized content, cardinality, and the creation of Functional Views. This page includes a link to the revised Design Principles.


We have not published the RDF/OWL Vocabularies in this release. These will be released at a later date and we will ask for comment on them at that point.

Below are some specific issues you may wish to comment on using the form provided. We are interested in all of your thought on whatever aspects of DDI-Views you wish comment on.

Binding - XML binding is available for each Functional View as well as the complete class library:

  • Please review the usability of a Functional View in terms of its application to the stated use case

  • Documentation of the restriction or use of specific classes in the Functional View is found in the View level documentation of the XSD as well as in the accompanying documentation (later releases will move class specific documentation to the element description within the XSD)

  • When filing issues please clarify if it relates to a class in general or to the use of that class in a specific Functional View

Documentation:

  • General high level documentation has been revised and requires additional review 

Patterns - Collection Pattern and Process Pattern:

  • Review explanatory documentation on patterns and their use
  • Note that classes in a Pattern will not be directly found in the bindings as the classes are abstract - review patterns using documentation and UML model 
  • Agency Registry Functional View uses Collections Pattern
  • Instrument Functional View uses Process Pattern

Functional Views:

  • Review for coverage based on indicated Purpose, Audience, and Use Cases
  • Review documentation for adequacy and clarity