Skip to main content

Documentation index: llms.txt. This page is also available as markdown: append .md to this URL or send Accept: text/markdown.

Template Examples

Templates for asset 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 will 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 prompts for AI-powered descriptions.

We provide template examples for:

Copy and paste them in your Templates section to help you get started with your documentation initiative.

Table Template Example​

Table Purpose​

Replace this line with the answer (and repeat below for all the questions): Why the table exists or main use cases?

Table Audience​

Who should use it?

Table Content​

Table Key Fields​

Mention the fields related to key metrics and concepts (this helps in the discovery process in particular if the metric has a different name than the technical field).

Table Good to Know​

Any calculations, filters, or exceptions that are worth mentioning?

Table Source​

Where is the data sourced from?

Table Data Update Frequency​

How often should the data be updated?

Dashboard Template Example​

Dashboard Purpose​

Replace this line with the answer (and repeat below for all the questions): Describe why the dashboard exists or main use cases.

Dashboard Audience​

Who is the target audience?

Dashboard Good to Know​

Any calculations, filters, or exceptions that are worth mentioning?

Dashboard Content​

Dashboard Metrics​

What are the key metrics included in this dashboard? Provide links to their definitions (do not forget to pin all the relevant dashboards to the metric definition).

Dashboard Dimensions​

What are the key dimensions included in this dashboard? Provide links to their definitions (do not forget to pin all the relevant dashboards to the definition).

Dashboard Source​

Where is the data sourced from (Salesforce, Jira, etc.)?

Dashboard Data Update​

How often is the data updated?

Metric or Term Template Example​

Metric Purpose​

Replace this line with the answer (and repeat below for all the questions): Why the metric or business term (dimension) exists or main use cases?

Metric Audience​

Who should use it?

Metric Calculation​

Metric Key Fields​

How is the metric or business term (dimension) calculated?

Metric Good to Know​

Any filters or exceptions that are worth mentioning?

Metric Source​

Where is the data sourced from?

Metric Data Update Frequency​

How often is the metric updated?

Domain Template Example​

Mission​

What is the objective and scope of the domain?

Key People​

Who are the key people and their roles?

Domain Organization​

How is it organized? Which departments does it serve (you can use tags)?

Key Performance Metrics​

Key KPIs.

Key Business Concepts​

Key concepts and glossary terms.

Key Assets and Dashboards​

What are the main go-to dashboards and source tables?

Anything Else You Should Know​

Useful presentations or links.