Creating Good Documentation Ted. Habermann@noaa. gov NOAA National Geophysical Data Center https: //www. nosc. noaa. gov/dmc/swg/wiki
Designated Communities - Users Data preservation is communicating with the future
“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. ”
The Community Understanding Foundation A Security exception is required to view this page because we have a self-signed certificate. It is safe!
Use Cases and Spirals
Data Providers / Scientists Data Stewards Standards Experts Check Back With Data Collectors/ Providers Check Back With Users Spiral 2 -N: Scientific Questions New Requirements New Use Cases Standard Guidance / Implementation Metadata Content Independent of standard Spiral 1: Initial Content
Potential Spirals Extent Geospatial Bounding Box Temporal Start/End Vertical Min/Max Place Keywords Identification Id Title Abstract Resource Date Topic Category Theme Keyword Metadata Contact Science Contact Acquisition Information Instrument Platform Instrument Keywords Platform Keywords Distribution Distributor Contact Online Resource Distribution Format Data Center Keywords Browse Graphic Content Information Attribute Type Attribute Names Attribute Definitions Attribute Units Text Searches Purpose Extent Description Lineage Statement Project Keywords Quality/Lineage Sources Process Steps Quality Reports / Coverages
Documenting Spirals
Web Accessible Folders
Documentation Without Borders ISO net. CDF DIF, FGDC Metadata Repository ISO 19115, 19115 -2, 19119 and extensions Sensor. ML WCS, WMS, WFS, SOS THREDDS KML
DS_Aggregates: Directory Structures There are many kinds of DS_Aggregates A DS_Aggregate has one or more series. Metadata A DS_Aggregate is composed of one or more DS_Datasets MI_Metadata (from Metadata entity set information) + series. Metadata 1. . * +has 1. . * + series 0. . * + superset 0. . * Multiple. Aggregation <<Abstract>> DS_Aggregate + subset 0. . * DS_Other. Aggregate DS_Stereo. Mate + describes 0. . * + part of 0. . * + composed. Of 1. . * DS_Series DS_Platform DS_Sensor DS_Data. Set DS_Initiative DS_Production. Service
Documentation Architecture Program Documentation Office of Climate Observations Other Projects Agg. Info LWCit Agg. Info CRef Project Documentation Agg. Info LWCit THREDDS Data Server net. CDF files Other formats + feature. Type + property. Type + field. Session + software + service + model + tile + initiative + sensor + other. Aggregate + stereo. Mate Nc. ML XSLT Agg. Info CRef Network Documentation MI – Network Extent Distribution <<Code. List>> MX_Scope. Code + attribute. Type + collection. Hardware + collection. Session + dataset + series + non. Geographic. Dataset + dimension. Group + production. Series + sensor. Series + platform. Series + transfer. Aggregate Other Networks Other Deployments Agg. Info CRef ISO Deployment Documentation MI – Deployment Agg. Info LWCit Platform Documentation DS_Platform series. Metadata MI – Platform subset DS_Sensor DS_Data. Set MI – Deployment 1 MI – Deployment 2 MI – Deployment 3 series. Metadata MI - Sensor Agg. Info CRef Other Platforms
Documentation Architecture Ocean. Sites 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: Program Project Network Platform Deployment 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 THREDDS Catalogs file. nc
Documentation Extraction Nc. ML HTML ISO XML THREDDS Catalogs file. nc Spiral Tracker Documentation Repository
Documentation in Three Dialects Nc. ML Spiral Tracker Documentation Repository
Documentation Repository / Portal
Links 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/iso. Metadata. Home. html Questions: ted. habermann@noaa. gov
Скачать презентацию Creating Good Documentation Ted Habermann noaa gov NOAA National
2baed6871c27f98681d4c7fa1dbe378a.ppt