Example Data

Summary

Auto-generated and manually created examples used in tutorials, and for testing the standard.

Description

Adopters of the standard and users of the data are often helped by seeing examples of what the data could look like. Example data can often give hints that might be missed by reading documentation, and can be used to set expectations of what data should look like.

Prioritisation Factors

  • If the standard is large or complicated

  • If adopters or users are often misunderstanding the requirements of the standard or strugging to ‘get it’

Deprioritisation Factors

  • If the standard is intentionally loose

  • If the standard is rapidly changing

  • If the standard does not have schema or a field model