Guidance Documentation

Summary

Non-normative guidance on how to share data using the standard.

Description

Standards typically comprise a detailed, technical definition of how to publish data. They are often the product of extensive work and research, and are designed to be reference documentation. However, adoption requires adopters to be guided through the process of adoption - helped to understand how to start, where to focus effort, and how to understand concepts. Guidance documentation takes adopters through the process of using the standard, building on real-world experience.

Prioritisation Factors

  • If the standard is large

  • If the standard uses a representation of concepts that may be unfamiliar to adopters

  • If early adopters encountered issues or misunderstandings

Deprioritisation Factors

  • If the standard is small, and implementation guidance can be included in the standard