Data Set Documentation ("Readme") Guidelines


The documentation (i.e., the "Readme" file) that accompanies each project data set is as important as the data itself. This information permits collaborators and other analysts to understand any limitations or special characteristics of the data that may impact its use. Data set documentation should accompany all data set submissions, including both preliminary and final. The following outline and content is recommended and should be adhered to as closely as possible to make the documentation consistent across all data sets.

Data set Documentation/Readme Outline:

Title: This should match the data set name

Author(s):

1.0 Data Set Overview:

2.0 Instrument Description:

3.0 Data Collection and Processing:

4.0 Data Format:

5.0 Data Remarks:

6.0 References: