ceos-org / ceos-ard

Repository for CEOS Analysis Ready Data (CEOS-ARD), including Product Family Specifications (PFSs)
9 stars 1 forks source link

PFS documents: Use chapters instead of tables #49

Open m-mohr opened 1 week ago

m-mohr commented 1 week ago

Discussed during LSI-VC: It could ease document generation, if we use normal text flow with chapters instead of tables.

OLD (example)

# Item Threshold (Minimum) Requirements Target (Desired) Requirements Threshold Self-Assessment Target Self-Assessment Self-Assessment Explanation/ Justification Recommended Requirement Modification
1.1 Traceability Not required. Data must be traceable to SI reference standard. Note 1: Relationship to 3.2. Traceability requires an estimate of measurement uncertainty. Note 2: Information on traceability should be available in the metadata as a single DOI landing page.
1.2 Metadata Machine Readability Metadata is provided in a structure that enables a computer algorithm to be used consistently and to automatically identify and extract each component part for further use. As threshold, but metadata should be provided in a community endorsed standard that facilitates machine-readability, such as ISO 19115-2.
1.3 Data Collection Time The data collection time is identified in the metadata, expressed in date/time, to the second, with the time offset from UTC unambiguously identified. Acquisition time for each pixel is identified (or can be reliably determined) in the metadata, expressed in date/time at UTC, to the second.

NEW (example)

1.1 Traceability

Threshold requirements

Not required.

Target requirements

Data must be traceable to SI reference standard.

Note 1: Relationship to 3.2. Traceability requires an estimate of measurement uncertainty.

Note 2: Information on traceability should be available in the metadata as a single DOI landing page.

Assessment

1.2 Metadata Machine Readability

Threshold requirements

Metadata is provided in a structure that enables a computer algorithm to be used consistently and to automatically identify and extract each component part for further use.

Target requirements

As threshold, but metadata should be provided in a community endorsed standard that facilitates machine-readability, such as ISO 19115-2.

Assessment

1.3 Data Collection Time

Threshold requirements

The data collection time is identified in the metadata, expressed in date/time, to the second, with the time offset from UTC unambiguously identified. | Acquisition time for each pixel is identified (or can be reliably determined) in the metadata, expressed in date/time at UTC, to the second.

Target requirements

As threshold.

Assessment

mattsymbios commented 1 week ago

Would be good to include a description section as well. We currently just go by a combination of the parameter name and the text in the Threshold/Goal requirement to discern meaning. This could be made much clearer.

m-mohr commented 1 week ago

@mattsymbios Could you give an example?

mattsymbios commented 6 days ago

I don't have a specific example. This was to capture what I thought @strobpr suggestion was.

But I do think it would be helpful to have a field (non-mandatory) in the building block where people could add some extra descriptive text about the parameter, to avoid the (quite frequent, actually!) case where people ask: "what exactly is this referring to??"

strobpr commented 6 days ago

What I have in mind is a description of content and purpose of a requirement and then a list of metadata fields at each level which have to be populated to fulfill it.