Metadata: Required content for a README

[jessicashanshanhuang]

Overview

Following DCP README template and Pluto README to understand what fields should be required and how to phrase information in an a format that reflects DCP branding and easily readable.

Goals

• Finalizing a list of fields as required and optional
• Formatting fields respective to what they represent in a clear and consistent way
• MVP: Dictating content for Pluto Data Dict README

Approach

• Design will look into resources relate Pluto Data Dict and outline a draft on what the README would look like

After reviewing USGS Metadata Guidelines, we should include the following components:

• [ ] originator
• [ ] point of contact
• [ ] abstract
• [ ] geospatial pres. form
• [ ] native data set enviornment
• [ ] access use constraints
• [ ] purpose
• [ ] optional: larger work citation
• [ ] time period
• [ ] optional: status
• [ ] keywords
• [ ] optional: taxonomy

[jessicashanshanhuang]

Looking into USGS guide to metadata: https://www.usgs.gov/data-management/metadata-creation

Metadata Creation Questionnaire

Metadata in Plain Language

NASA MODIS Product Data Dict

FGDC Metadata Guidelines

[jessicashanshanhuang]

Found this metadata schema, @damonmcc is this what nyc open data is based off of?

[damonmcc]

noting that (historically) there's a distinction between a Data Dictionary and a README

although the work so far has generated PDFs with Data Dictionary text, the same process can probably work for README text. and that is probably ideal since we'd like to standardize the branding and formatting of our metadata

[damonmcc]

Found this metadata schema, @damonmcc is this what nyc open data is based off of?

we do like that schema but unfortunately no, NYC Open Data's dataset pages and Data Dictionary format seem to be custom

(unrelated but) MTA's recent announcement of a new dataset here is an interesting example of describing data

[damonmcc]

below is an outline of the current content of the PLUTO README and an idea for a generalized outline of future standardized READMEs

• I think a goal of our first pass should be to put the existing PLUTO text through the new generation process (yaml or something -> pdf) rather than to rework the PLUTO text to align with a generalized outline
• eventually, I think it'll be ideal to have a single pdf with both the README and the Data Dictionary in it

outline of PLUTO README content

1. What is PLUTO?
   • Summary of dataset
   • Significant dataset details
2. Dates of Data
   • Names of source datasets and dates use in current PLUTO version
3. Disclaimer and contact email
4. Appendix: Change History
   • Data and/or methodology
5. Header
   • Document title and dataset version

generalized outline for README content

Summary

Abstract, purpose, release frequency

About the data

The data model, significant details, methodology

Disclaimer and contact info

Disclaimer, DCP Open Data email

Source Data Versions

Names of source datasets and dates use in current PLUTO version

Change Log

Data and/or methodology

[jessicashanshanhuang]

@damonmcc looking through FGDC metadata guidelines, are we following ISO metadata standards? might be something to to include in the readme in case we follow different standards for different datasets?

[jessicashanshanhuang]

Wireframes derived from damon's outline:

[damonmcc]

@jessicashanshanhuang

are we following ISO metadata standards?

nope but it's a good idea to! I think that PDF is from 2011, the FGDC metadata site seems more up-to-date

[jessicashanshanhuang]

metadata summary documentation up on design!