This section provides information regarding CDR documentation requirements for CDR Contributors. Please explore this tab for an overview of the CDR Data Catalog, minimum requested documentation from Data Contributors, an example of an approved data dictionary documentation, as well as expectations for data contributors. Overview of CDR Data CatalogThe CDR Data Catalog provides a location for data contributors to make documentation available to CDR users. The DAMOD team provides a general layout document of each schema that includes table names, column names, and datatypes for every source in Hive. This document (located under the CDR Table Layouts column) is produced when the data is made available in the CDR or if data definitions are updated. Data contributors to the CDR are responsible for providing supplemental documentation necessary to support end-users of their data. Such examples of documentation may include: Data Dictionaries Data Models User Guides Training Documents
Minimum Requested Documentation from Data Contributors Available documentation on the CDR Data Catalog will vary from source to source. Some mature data sources will have excellent existing documentation/artifacts while newer sources may provide less. At a minimum, the DAMOD team recommends data contributors to provide the following documents:
Document Name | Description | Necessary Information | Other Information |
|---|
Data Dictionary | Data dictionaries can be various formats including Excel, PDF, and Word. We recommend all documents provided to be 508 compliant for users. We strongly recommend that data for columns that contain discrete, non-inferable or computed values have clear and detailed documentation. | | | Data Model | Data Models provide the keys for each table. This provides users a mechanism for understanding how to join data across tables and identifying unique records (if applicable to your source). | Surrogate Keys Foreign Keys Primary Keys
| |
Example Approved Data DictionaryThe example below meets all criteria including: 
Expectations - Data Contributors provide updated documentation when source data changes
- Data Contributors provide consistent versioning on documents
- Data Contributors provide accurate documentation for users
- Data Contributors support questions about the data and documentation
| 
ISG Playbook
APIs
