Adding context for data content
Providing context is essential for publishing data on Mass.gov, including information about its origin and collection, to facilitate effective use.
What to include in descriptions of data content
It is important to include certain details in data descriptions. Specifically, the name of the publishing organization or owner of the data, the reason why the data was collected, and the general frequency of updates should be provided. Additionally, the data description can highlight key takeaways, describe data collection methods, and acknowledge any gaps or limitations in the data. By including these details, data users can better understand and trust the data’s credibility.
Data dictionaries
It is important to have a data dictionary for all data content. The data dictionary should provide a list of key terms and data types along with their meanings in each field. A good data dictionary should also include simple and easy-to-understand definitions of each term or metric, as well as the date ranges covered by the data.
Context for data content featuring dashboards, tables, and visuals
When publishing data dashboards, tables, and visuals, it's necessary to provide a downloadable version of the data along with a brief description of what is being downloaded. This helps users to determine if the data is relevant to them and also provides users who use screen readers with more context. You can learn more about providing context to data dashboards by viewing our content model on publishing data featuring dashboards, tables, and visuals.
Context for data content with an external data source
At times, the information that is being shared is hosted on an external platform. Unfortunately, the external platform might not offer enough information about the data, which can make it difficult for users to understand its purpose or navigate through it. This can cause problems for users who may not be able to access the data properly or comprehend it fully. Even though the data is not hosted on Mass.gov, it still needs to be accompanied by a comprehensive data description that includes a data dictionary, and any relevant downloads or additional content.
Some CMS authors may not have access to the callout link feature. However, this shouldn't stop you from creating external page links. You can still use a rich text field to provide users with external links to relevant data. You can learn more about publishing data on an external platform by checking our content model for providing context to hosted data.
Context for data content in a file or files
When sharing data content in a file format, it is crucial to provide a brief description of the file that accompanies the download. If you have multiple files to publish, such as a dataset, a summary report, and tools used to collect the data, it is advisable to create a descriptive sentence or a bulleted list that includes supporting descriptions. This will assist your audience in comprehending the content of each file quickly and easily, reducing confusion. You can learn more about publishing data files by referring to our content model for publishing data files on Mass.gov.
When publishing data, choose file types that are user-friendly. Tabular data should be in CSV or XLSX format instead of PDF or DOCX.
Last updated
