Parts of an ONS webpage Warnings
Warnings highlight limitations that affect how users interpret the data, analysis or methods in a release. They prevent the misuse of data, with minimal interruption to the content.
You can use warnings to provide a short summary of any quality caveats that are essential for understanding the data, and that directly affect accuracy, reliability or comparability. This includes:
- limitations with the method or data source
- significant changes in response rates
- corrections to historical data outside of the revisions process
Warnings are displayed in bold text and are preceded by an exclamation mark symbol. Using too many warnings, or including too much detail, distracts users.
View an example of a warning in a statistical article (opens in a new tab)
The content design team can help you to write short, effective warnings. Email content.design@ons.gov.uk (opens in a new tab)
How to use a warning
Do:
- use warnings to highlight quality caveats that directly affect how users interpret and compare our data
- keep warnings short and clear to help users retain the information – use around 30 to 40 words and plain language (opens in a new tab)
- give users explicit instructions or advice; not just “treat with caution”
- include one warning in the Overview section, if the information is essential for all users to use the data or statistics correctly
- include further warnings in the Detailed analysis sections but only when they have a direct effect on how users interpret the content around them
Do not:
- use warnings too often or place warnings next to each other, as they overwhelm users
- use a warning immediately before or after a table, chart or diagram
- provide definitions in warnings; include these in the definitions section of your page
- include hyperlinked text, except for a single link to more detailed information in the supporting quality and methods guide
- use warnings to tell users about general quality information that does not affect reliability or comparability; include this in the relevant methodology publication
Include an optional How to use these statistics section if users need to understand multiple quality caveats or limitations quickly before getting to the data and analysis. This is easier for them to find and understand than several warnings throughout the page.