Metadata content guidance/ templates

[teeceeas]

As a technical author,
I want to provide comprehensive guidance and templates for Data Custodians when uploading data,
So that metadata quality is improved and users can better understand and trust the datasets in the catalogue.

Acceptance Criteria:
Develop a guide for Data Custodians to follow when adding or updating metadata.
Include best practices for writing clear, concise, and meaningful metadata descriptions.
Create metadata entry templates tailored to different dataset types (e.g., dashboards, tables etc).
Ensure templates are easy to use and include examples for clarity.
Existing metadata descriptions are assessed, and recommendations for improvement are documented.
Identify specific areas where descriptions or details can be improved.

From Service assessment recommendations
3. Provide a joined-up experience across all channels
Major points
The descriptions shown in the service are hard to understand so the team should investigate ways of improving the quality and readability of what is being pulled in. This could be by setting clear expectations/templating of what descriptions should include (based on the needs of people using the catalogue). This could actually reduce rather than increase the burden on people uploading the data. It may also be necessary to look retrospectively at the descriptions of the current data and how these could be improved.

5. Make sure everyone can use the service
Less major points
The team would benefit from a clear picture of how well the potential breadth of users will understand the terminology used in the service - this can inform the terminology chosen, whether to use abbreviations etc and also indicate what would be an effective way of supporting users who don’t understand all the terms.