This paper describes the context, motivation, and requirements behind the design and development of the first version of the Data Documentation Initiative 2 (DDI) metadata community specification, with an emphasis upon the process of creating the initial element set for the "study level" of DDI version 1. We also offer a framework for understanding the infrastructural changes that contributed to the establishment of the DDI. By taking a close look at the confluence of influences on the earliest efforts to design and build the DDI, we can better understand what essential elements of metadata are necessary to support independent use of social science data over time.
Intended audience:This document is for software designers who are developing DDI applications. The designers may be familiar or unfamiliar with the DDI specification.
Abstract:This best practices document looks at a possible way to design components that can be combined to create DDI applications. Given that object-oriented design is the most common programming paradigm, and that systems are often based around service-oriented principles, and given the modular design of DDI 3.0 itself, this document provides an architectural model that can be a reference point for implementers. The document also takes into consideration issues of maintenance and management of DDI applications, and discusses best practices for application documentation and configuration. The focus is on interoperability of DDI applications.
Status:This document is updated periodically on no particular schedule.
IntroductionThis best practices document looks at a possible way to design components that can be combined to create DDI applications. The paper is targeted at developers, but it does not assume a high level of DDI knowledge. It is intended to serve as a starting point for developers new to the DDI.
Problem statement
50Software developers who are new to the DDI 3.0 standard may find the standard daunting. This best practices document provides an overview of how an application may be structured so that developers have a starting point for the design of their application.
Terminology
Definitions59 DDI: When used without a version, DDI refers to the latest DDI specification, currently version 3.0. When older versions are referenced, the version number will be explicitly specified.DDI community: Any person or organization working with the DDI specification.DDI application: A software application that reads and/or writes DDI XML.Specification: The DDI specification.Component: A piece of software with a specific purpose with a well-defined input and welldefined output.Middleware: In the context of this best practices paper, middleware refers to utilities that manage the interface between the DDI metadata model and application services or high-level end-user tools.Task: An activity that a person undertakes in order to create, edit, or view documentation about data.End user: Person performing work in the data life cycle for whom DDI metadata is required. The end user will likely not even be aware of the DDI metadata in the application he or she is using.
scite is a Brooklyn-based organization that helps researchers better discover and understand research articles through Smart Citations–citations that display the context of the citation and describe whether the article provides supporting or contrasting evidence. scite is used by students and researchers from around the world and is funded in part by the National Science Foundation and the National Institute on Drug Abuse of the National Institutes of Health.