Templates examples
Templates for assets documentation in Catalog allow administrators to establish standardized formats for documentation, ensuring consistency and clarity across all materials. By defining templates, admins can guide contributors in structuring their documentation, thereby improving its quality and usability.
Below you'll find template examples created by the Catalog team to help you document your assets. These templates can be filled out manually but more importantly can also be used as prompt for AI-powered description.
We here provide template examples for:
Copy and paste them in your Templates section to help you get started with your documentation initiative!
Table template example
🎯 Purpose
Replace this line with the answer (and repeat below for all the questions): Why the table exists / main use cases?
🙋♀️ Audience
Who should use it?
📄 Content
Key Fields
Mention the fields related to key metrics and concept (this would help in teh dicovery process in particular if the metric has a different name to the technical field)
⚠️ Good to know
Any calculations, filters, exceptions that are worth mentioning?
🛢 Source
Where is the data sourced from?
📆 Data Update Frequency
How often should the data be updated?
Dashboard template example
🎯 Purpose
Replace this line with the answer (and repeat below for all the questions): Describe why the dashboard exists / main use cases
🙋♀️ Audience
Who is the target audience?
⚠️ Good to know
Any calculations filters, exceptions that are worth mentioning?
📄 Content
Metrics
What are the key metrics included in this dashboard - provide links to their definitions (don't forget to pin all the relevant dashbaords to the metric definition)
Dimensions
What are the key dimensions included in this dashboard - provide links to their definitions (don't forget to pin all the relevant dashbaords to the definition)
🛢 Source
Where is the data sourced from (Salesforce, Jira etc)
📆 Data Update:
How often is the data updated
Metric/Term template example
🎯 Purpose
Replace this line with the answer (and repeat below for all the questions): Why the metric / business term (dimension) exists / main use cases?
🙋♀️ Audience
Who should use it?
📄 Calculation
Key Fields
How is the metric / business term (dimension) calculated?
⚠️ Good to know
Any filters, exceptions that are worth mentioning?
🛢 Source
Where is the data sourced from
📆 Data Update Frequency
How often is the metric be updated?
Domain template example
🎯 Mission
What is the objective & scope of the domain?
👥 Key People
Who are the key people and their roles?
🗺️ Organisation
How is it organised? Which departments does it serve (you can use tags)
📏 Key Performance Metrics
Key KPIs
📓 Key Business Concepts
Key concepts & glossary terms
📈 Key assets / Dashboards
What are the main go to dashboards &. source tables
⚠️ Anything else I should know?
Useful presentations / links