Documentation Set Organization and Issues

1. Documentation SetOrganization and Issues PDS4 Operational Readiness Review and Acceptance Review 30 November 2011

2. Current Organization INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES ALL DOCUMENTS WRITTEN IN PARALLEL; BUT STABILITY IS ESTABLISHED IN SEQUENCE SCHEMATA

3. Core Functions INFORMATION MODEL DD DATA BASE INFO MODEL – ESTABLISHES STRUCTURE DD DATA BASE – DEFINES ELEMENTS STANDARDS REF – ADDS CONSTRAINTS SCHEMATA – IMPLEMENTATION VEHICLE EXAMPLES – SAMPLE OUTPUT DPH – RECIPES, HOW-TO, BEST PRACTICES STANDARDS REFERENCE DATA PROVIDERS’ HANDBOOK EXAMPLES SCHEMATA

4. Information Model(entry for Table_Character) FAMILY TREE CLICK ON TERMS TO MOVE AROUND IN THE MODEL ATTRIBUTES ASSOCIATIONS FUNCTIONAL ROLE

5. Informational Model(entry for record_length)

6. Document Status INFORMATION MODEL DD DATA BASE INFO MODEL – Current by definition DD DATA BASE – Almost current SCHEMATA and EXAMPLES – Various, but a lot of manual updating for EXAMPLES STANDARDS REFERENCE and DATA PROVIDERS’ HANDBOOK – Out of date, incomplete, and inconsistent. Not yet working well together or with IM and DDDB. STANDARDS REFERENCE DATA PROVIDERS’ HANDBOOK EXAMPLES SCHEMATA

7. Recommendation 1 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES The Information Model is already the fundamental reference on structure; within its own limitations, it is unambiguous and relatively easy to use. There is no latency when it is updated. Complete the ‘clean-up’ within 1 month. Make it available to the Community and promote its use. SCHEMATA

8. Recommendation 2 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES The DD Data Base is already the fundamental reference for definitions (classes and attributes). There is no latency when it is updated. Develop an improved interface that makes all (and parts) of its information available (Data Dictionary). Upgrade and integrate DD Tutorial. Promote use. SCHEMATA

9. Recommendation 3 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES Collect all policies, rules, constraints, etc. not obviously included in the IM and DDDB into the Standards Reference. It is no longer a text version of the IM; it is a necessary supplement. SCHEMATA

10. Recommendation 4 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES After the IM and DDDB are stable, generate SCHEMATA (or the master schema) and a representative set of Examples suitable for illustration and training. SCHEMATA

11. Recommendation 5 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES Integrate the Glossary with the Concepts Document; then flesh out the incomplete sections in the latter so that it is the Introduction to and Overview of PDS4. Post the Glossary on-line for quick reference. SCHEMATA

12. Recommendation 6 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES A separate Introduction is no longer needed. People needing such a document should pick up the Concepts Document. SCHEMATA

13. Recommendation 7 INTRODUCTION JUMPSTART INFORMATION MODEL DD DATA BASE CONCEPTS DOCUMENT DD TUTORIAL DATA DICTIONARY STANDARDS REFERENCE GLOSSARY DATA PROVIDERS’ HANDBOOK EXAMPLES Data Providers’ Handbook and Jumpstart will be postponed SCHEMATA

14. Result INFORMATION MODEL DATA DICTIONARY CONCEPTS DOCUMENT 1 2 5a STANDARDS REFERENCE GLOSSARY 3 5b EXAMPLES 4 STABILITY IS ESTABLISHED IN SEQUENCE DOCUMENTS, WHICH ARE MORE FOCUSED, FOLLOW IN SEQUENCE SCHEMATA

15. BACKUP

16. Overlap • Terminology specified in Glossary, but then repeated in SR and DPH; nothing in Concepts • SR 2: Data Objects and Products (4 p.) • DPH 2: Building Blocks (1 p.) • Glossary: Building Blocks, Definitions (8 p.) • Concepts: 0 p.

17. Gaps • Best coverage of documentation is in Concepts • SR 10 (Context): short paragraphs on Investigations, Nodes, and what used to be CATALOG files (<3 p.) • SR 11 (Documentation): content criteria for useful documentation; ASCII, HTML, TeX readable formats (< 3 p.) • DPH 5.3 (Determining Documentation Needed): criteria for selecting documents (1 p.) • DPH 7 (Document Product Labels): never written (0 p.) • Concepts 11 (Documents): required documents; PDF/A, UTF-8, additional formats (2 p.)

18. Lack of Focus • DPH 10 is how-to on Collections • 10.4.1 Data Standards Area (6 lines; refs SR 4.n) • 10.4.2 Identification Area (24 lines; refs SR 4.2) • 10.4.3 Cross Reference Area (3 lines; refs SR 4.3) • 10.4.4 Observation Area (3 lines, refs SR 4.4) • 10.4.5 File Area (106 lines, but misses LID; refs SR 4.5) • SR 4 is chapter on Labels • 4.n Data Standards Area (not found) • 4.2 Identification Area (20 lines text) • 4.3 Cross Reference Area (1 line text) • 4.4 Observation Area (3 XML fragments, attribute table, text) • 4.5 File Area (XML fragment, 7 lines text)