Document the Standard Results

[perolavsvendsen]

Note

Bigger discussion: Where should FMU results be documented? fmu-dataio, Sumo, elsewhere?

Current documentation of standard results is focused on the export. Information for consumers will also be necessary.

Representative user story:
As a data consumer, I would like to know what standard results exists, how I identify them and how I should consume them, so that I can use these data in my context.

• Document the standard result identifier, e.g. "structure_depth_surface" so that consumers can know how to identify this standard result.
• Document what it takes to make a standard result unique #1572 so that consumers can know how to filter down to this standard result.
• Document default information classification.
• ...

We currently document how to use the functions that create the standard results, but I am here referring to documentation of the standard results definition which is slightly different - although obviously related.

Could be an option to structure the documentation a bit differently, but a quick fix could be to add this information as an info box or something to the existing docs 🤷‍♂️

[perolavsvendsen]

Linked: https://github.com/equinor/sumo-doc/pull/197

[perolavsvendsen]

A suggested requirement:

• For each standard result document which metadata fields are required to obtain uniqueness. I.e. which fields must consumers include in their queries to confidently identify something specific.

[perolavsvendsen]

Related:

• Split documentation to "user" and "consumer" paths #1068
• Document what it takes to make a standard result unique #1572