Add context with a document description

Add a description to a workbook, report, or data model to provide context about the document's contents, status, quality, and reliability. For example, if you have a data app to manage project tasks for a website redesign, add a description like "Track project status, assignees, and deliverables for the website redesign initiative".

You can also set a badge on a document to reflect its status and reliability. For information about setting badges, see View and manage document badges.

Ask Sigma and other AI functionality in Sigma use descriptions and badges as contextual metadata when selecting data sources from the highlighted sources. For details about adding contextual metadata to data sources:

To add descriptions to data models, see Create and manage data models.
To add descriptions and badges to tables from your data platform, see Review and manage your data catalog.

If you want to manage the contents of a document according to stages of development, use version tagging instead. See Add version tags to workbooks, data models, and reports.

User requirements

To add or delete a document description, you must have Can edit access to the document.
Descriptions are visible to any user with access to the document.

Add a description to a document

Open a document.
Select the document name to open the document menu, then select About this workbook for a workbook, or About this report for a report.
In the text box below the document name, type a description. The description saves automatically.
Click Close (X) or click outside the modal to return to your document.

View a document description

The document description is visible when viewing the document, or when previewing details about the document by hovering over the document in a workspace or folder.

To view a document description from the document:

Open a workbook or report.
Hover over the title to view the description. If the document has a badge set, the badge details are also visible.

Delete a document description

Select the workbook name to open the document menu, then select About this workbook, or About this report for a report.
In the text box below the document name, remove the description. The change saves automatically.
Click the X or click outside the modal to return to your document.