Project Management


Prototype - Deliverables

Last revised: February 16, 2018

Functional Views

Library Packages

Use Cases

Deliverables

  • Agent Registry
  • Conceptual Content
  • Controlled Vocabulary
  • Custom Metadata
  • Data Capture Instrument
  • Data Description 
  • Data Management
  • Descriptive Codebook  
  • Sampling 
  • Statistical Classification 
  • Structured Geography 
  • Agents
  • Business Workflow
  • Collections Pattern
  • Conceptual
  • Custom Metadata
  • Data Capture
  • Discovery
  • Enumerations
  • Format Description
  • Geographic Classification
  • Identification
  • Logical Data Description
  • Methodologies
  • Methodology Pattern
  • Primitives
  • Process Pattern
  • Regular Expressions
  • Representations
  • Sampling Methodology
  • Signification Pattern
  • Simple Codebook
  • Simple Methodology Overview
  • Structured Data types
  • Study Related
  • Utility
  • Workflows
  • Codebook
  • Data capture - simple questionnaire content and flow, non-question based data (register data, simple protocols, internet, etc.)
  • Data description - various formats
  • Data processing
  • Data transformations
  • Archive a study (repository)
  • Simple study description (catalog)
  • Statistical classifications 
  • Geographic classifications
  • The Model: although this is at the heart of the documentation, we would also like to have a processable version of the model in XMI (an XML format for describing models). This will be in canonical XMI, a flavor of that format supported across many UML tools. There will only be an XML file for the entire model being published – there is no sub-set for each View, etc. as for some other deliverables.

  • XML Schemas: Descriptions of both the full class library and subset XML Schemas for each identified Functional View (groupings of objects to support specific functions).

  • RDF-S/OWL Vocabulary for RDF: There will be a vocabulary for the entire library, and a set of Functional View-level vocabularies. These would be expressed using OWL.

  • Documentation:  (additional details in this linked document from Dagstuhl sprint)
    • High-level overview document describing the model and how it functions. This will include the definition and description of the views (however they are formed)
    • Class-level descriptions in Drupal that include language about examples
    • Individual document for each use case to include description and method/rationale along with an example in xml:
      • Codebook
      • Simple questionnaire and flow
      • Non-question based data
      • Data description - should we include the various formats in one document or separate them?
      • Data processing/transformation - separate or together?
      • Statistical classification
      • Geographic classification
      • Archived study/study description
    • Mapping to DDI v2.5
    • Mapping to DDI v3.2 (or v3.3?)
    • Mapping to GSIM v1.1
    • RDF-S/OWL Vocabulary
 Release Schedule 2015-2017
The Release Coverage column provides an estimation of the content covered in each release. This may alter based on unexpected progress in some areas or unexpected delays in others. The Target Dates are entered in black as preparation for a release begins. As steps are completed the type font changes from black to red.
Release CoverageTarget Dates (assume the last day of the month is the completion date)
Library Packages:
  • Agent
  • Complex Data Types
  • Conceptual
  • Core Process
  • Discovery
  • Identification
  • Primitives
  • Representations
  • Utility
Functional Views:
  • Agent
  • Discovery


Development Review Number: Q1 2015

Released April 2015

  • 2014-12 Content modeling completed
  • 2015-02 Data modeling completed
  • 2015-03 Production/Documentation completed
  • 2015-04 Technical Committee Review completed
  • 2015-04 Release for public comment
  • 2015-06 End of public review
  • 2015-12 Processing of comments by Technical Committee

Planned additions:

Library Packages:
  • Complex Process
  • Custom Metadata
  • Data Capture
  • Format Description
  • Logical Data Description
  • Methodologies
  • Methodology Pattern
  • Workflows
Functional Views:
  • Agent Registry
  • Data Dictionary
  • Instrument
  • Statistical Classification

Development Review Number: Q2 2016

Released October 2016

  • 2016-07 Content Modeling complete
  • 2016-09 Data Modeling complete
  • 2016-09 Production/Documentation complete
  • 2016-09 Technical Committee Review
  • 2016-10 Release for public comment
  • 2016-12 End of public review - extended to 2017-01-15
  • 2017-03 Processing of comments by Technical Committee

 Focused Release:

Library Packages:
  • Any package required
Functional Views:
  • Codebook

 Development Review Number: Q3 2017

This would be a focused release on the structure of functional views and the coverage of a basic codebook

The codebook would contain only those features currently modeled and would continue to expand with future releases

  • 2017-08-01 Content modeling complete
  • 2017-09-01 Documentation complete
  • 2017-09-15 TC Review
  • 2017-10-01 Development Review release
  • 2018-01-15 End of review period
  • 2018-03-01 Preliminary report on review comments from TC


Future Suggested additions:

  • Data Management Plan
  • Study Inception
  • Collection Management
  • Data Processing


 These will be scoped at Sprints as possible.