1. Creating Good Documentation Ted.Habermann@noaa.gov NOAA National Geophysical Data Center https://www.nosc.noaa.gov/dmc/swg/wiki

2. Designated Communities - Users Data preservation is communicating with the future

3. “Create a time capsule with your class to remember the year. Often we forget about our experiences unless they are recorded. It will be interesting to have documentation of the past.”

4. The Community Understanding Foundation A Security exception is required to view this page because we have a self-signed certificate. It is safe!

5. Use Cases and Spirals

6. Spiral 1: Initial Content Spiral 1: Initial Content Metadata Content Independent of standard Metadata Content Independent of standard Standard Guidance / Implementation Standard Guidance / Implementation Check Back With Users Check Back With Users Spiral 2-N: Scientific Questions New Requirements New Use Cases Check Back With Data Collectors/ Providers Check Back With Data Collectors/ Providers Data Providers / ScientistsStandards Experts Data Stewards

7. Identification Id Title Abstract Resource Date Topic Category Theme Keyword Metadata Contact Science Contact Identification Id Title Abstract Resource Date Topic Category Theme Keyword Metadata Contact Science Contact Extent Geospatial Bounding Box Temporal Start/End Vertical Min/Max Place Keywords Extent Geospatial Bounding Box Temporal Start/End Vertical Min/Max Place Keywords Distribution Distributor Contact Online Resource Distribution Format Data Center Keywords Browse Graphic Distribution Distributor Contact Online Resource Distribution Format Data Center Keywords Browse Graphic Text Searches Purpose Extent Description Lineage Statement Project Keywords Text Searches Purpose Extent Description Lineage Statement Project Keywords Quality/Lineage Sources Process Steps Quality Reports / Coverages Quality/Lineage Sources Process Steps Quality Reports / Coverages Acquisition Information Instrument Platform Instrument Keywords Platform Keywords Acquisition Information Instrument Platform Instrument Keywords Platform Keywords Potential Spirals Content Information Attribute Type Attribute Names Attribute Definitions Attribute Units Content Information Attribute Type Attribute Names Attribute Definitions Attribute Units

8. Documenting Spirals

9. Web Accessible Folders

10. Metadata Repository ISO 19115, 19115-2, 19119 and extensions Metadata Repository ISO 19115, 19115-2, 19119 and extensions THREDDS netCDF DIF, FGDC SensorML WCS, WMS, WFS, SOS ISO KML Documentation Without Borders

11. DS_Aggregates: Directory Structures MI_Metadata (from Metadata entity set information) > DS_Aggregate DS_DataSetDS_SeriesDS_OtherAggregateDS_InitiativeDS_StereoMateDS_PlatformDS_ProductionServiceDS_Sensor + describes 0..* +has 1..* + seriesMetadata 1..* + part of 0..* + composedOf 1..* MultipleAggregation + superset 0..* + subset 0..* + series 0..* There are many kinds of DS_Aggregates A DS_Aggregate has one or more seriesMetadata A DS_Aggregate is composed of one or more DS_Datasets

12. Platform Documentation DS_Platform seriesMetadata MI – Platform subset DS_Sensor DS_DataSet MI – Deployment 1 MI – Deployment 2 MI – Deployment 3 seriesMetadata MI - Sensor Platform Documentation DS_Platform seriesMetadata MI – Platform subset DS_Sensor DS_DataSet MI – Deployment 1 MI – Deployment 2 MI – Deployment 3 seriesMetadata MI - Sensor Project Documentation Program Documentation Office of Climate Observations Program Documentation Office of Climate Observations THREDDS Data Server netCDF files Other formats THREDDS Data Server netCDF files Other formats NcML XSLT ISO Network Documentation MI – Network Extent Distribution Network Documentation MI – Network Extent Distribution Deployment Documentation MI – Deployment Deployment Documentation MI – Deployment AggInfo LWCit Other Platforms Other Deployments AggInfo CRef AggInfo CRef AggInfo LWCit AggInfo LWCit Other Networks AggInfo CRef Other Projects AggInfo CRef > MX_ScopeCode + attribute + feature + attributeType + featureType + collectionHardware + propertyType + collectionSession + fieldSession + dataset + software + series + service + nonGeographicDataset + model + dimensionGroup + tile + productionSeries+ initiative + sensorSeries+ sensor + platformSeries+ otherAggregate + transferAggregate+ stereoMate Documentation Architecture

13. OceanSites is a complex collection of information at many levels. The documentation architecture provides an overview of those levels and the relationships between them. One model includes five levels: Platform Project Program Network Deployment file.nc THREDDS Catalogs THREDDS Catalogs Current granule documentation feeds into this system to create discovery metadata that can feed existing portals Principle: Scientists do science and write scientific data Documentation experts write documentation

14. Documentation Extraction file.nc THREDDS Catalogs THREDDS Catalogs Documentation Repository Documentation Repository ISO XML Spiral Tracker HTML NcML

15. Documentation in Three Dialects Documentation Repository Documentation Repository Spiral Tracker NcML

16. Documentation Repository / Portal

17. Other ISO 19115 Information: https://www.nosc.noaa.gov/dmc/swg/wiki/index.php?title=Category:ISO_19115 Creating Good Documentation: https://www.nosc.noaa.gov/dmc/swg/wiki/index.php?title=Creating_Good_Documentation Web Accessible Folder: http://www.ngdc.noaa.gov/metadata/published/19115/isoMetadataHome.html Questions: ted.habermann@noaa.gov Links