Templates

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.

Accessing Templates

Follow this link, or:

  1. Log in to Catalog with your admin credentials.

  2. Navigate to the governance page.

  3. Select the "Template" tab.

Creating Templates

When creating or editing a template don't forget to define the type of assets it should be usable on: tables, dashboards or knowledge pages

  1. Click on the "Create New Template" button.

  2. Name the template to reflect its purpose or content.

  3. Choose the type of assets the templates should be usable on

  4. Define the structure of the template by adding sections, subsections, and any necessary formatting guidelines.

Create and fill the template

Applying templates

Contributors (and admins) can apply templates when editing documentation for tables, dashboards, or knowledge articles:

  1. Access the relevant documentation section for editing.

  2. Click the template icon in the edition bar

  3. Select the desired template from the dropdown menu.

  4. The template's structure and formatting guidelines will be applied to the document.

  5. Then you just have to inout your documentation

Remember to apply the template before writing your documentation

Last updated

Was this helpful?