How to maintain this guide¶
Terminology¶
We talk about ‘sharing data’ to accommodate cases where data is published as open data, or exchanged between non-open systems. This should generally be preferred in this guide to the term ‘data publication’.
Content types¶
THIS IS DRAFT.
Pages may contain the following elements:
Narrative text
Checklists
Examples - such as example Contributor Agreement text
Related articles
Patterns
‘Consider’ - a set of boxes that should be filled in for each particular standard.
Pages should be tagged as one of:
Policy
Technical process
Non-technical process
Guidance
Components¶
Throughout the documentation we describe a range of components involved in developing and maintain a standard. These should all have a title, short description, and then a longer description where appropriate.
A component consists of the following elements:
Title
Summary
Description
Examples
Prioritisation Factors
Deprioritisation Factors
Related Patterns & Components
These should be written using a Level 3 heading for the component, and level four headings for each element (from Summary onwards) using the template below.
Title¶
Summary¶
Description¶
Examples¶
Prioritisation Factors¶
Deprioritisation Factors¶
Patterns¶
Throughout the documentation we include common patterns for standards.
A pattern consists of the following elements:
Title
Problem
Solution - what’s the solution to this problem
Method - how to do this
Example
Related Patterns & Components
These should be written using a Level 3 heading for the pattern, and level four headings for each element (from problem onwards) using the template below.
Title¶
Problem¶
Solution¶
Method¶
Example¶
Related patterns¶
Link
Related components¶
Link