撰寫資料產品文件

上次更新：2026/11/3

您可以為您的每個資料產品找到兩種類型的說明文件。

• 概述您的資料產品的一般說明文件，例如資料集、資料時效性、資料品質等。
• 包含資料產品經理想要分享之所有資料產品相關資訊的 讀我 區段。

您也可以為您的資料產品新增主要聯絡人，並附加商業詞彙表，讓取用者能夠取得標準化的商業定義。

產生資料產品的一般說明文件

您可以產生、檢視及下載資料產品的文件，以將其所有資訊彙整於單一檔案中，例如資料品質、資料集數量、各資料集的品質、各資料集的欄位等。

產生資料產品的一般說明文件也可以透過對應的 Qlik 公用 API 來執行。

您可以下載 Markdown 格式的說明文件 (.md)。

當資料產品中的資料集位於您沒有存取權限的空間時，您仍然可以產生並下載文件，但該資料集及其資料將不會包含在文件中。

1. 從 目錄 或 資料產品 選單開啟資料產品。
2. 在右側按一下 > 取得說明文件。隨即開啟 說明文件 視窗。
3. 若要以 MD 格式下載，請按一下 下載。

   您也可以從瀏覽器以 PDF 格式下載。以滑鼠右鍵按一下說明文件 > 列印...。

編輯讀我區段

身為資料產品經理，您可以視需要多次編輯 讀我 區段。豐富文字格式可讓您組織區段，使其盡可能清除。

1. 請確認您具備下列角色或權限：
   • 資料產品經理角色或 管理資料產品權限。
   • 編輯空間的權限。
2. 從 目錄 或 資料產品 選單開啟資料產品。
3. 選取 說明文件 索引標籤。
4. 在 讀我 區段中按一下 編輯。
5. 輸入資訊並按一下 儲存。

您也可以按一下右側的 > 說明文件 來編輯 讀我檔案 區段。

新增主要聯絡人

新增主要聯絡人，以指定取用者對資料產品有任何疑問或問題時可聯絡的對象。

1. 請確認您具備下列角色或權限：
   • 資料產品經理角色或 管理資料產品權限。
   • 編輯空間的權限。
2. 從 目錄 或 資料產品 選單開啟資料產品。
3. 選取 說明文件 索引標籤。
4. 在 聯絡人 區段中，按一下 編輯。
5. 輸入主要聯絡人，然後按一下 儲存。

您也可以按一下右側的 > 文件 > 主要聯絡人 來編輯主要聯絡人。

檢視附加的業務術語表

資料產品可包含附加的商業詞彙表，為資料產品內容提供標準化的商業定義。詞彙表會顯示在 說明文件 分頁中，與 讀我 區段及主要聯絡人並列。

身為資料產品經理

您可以檢視並管理已附加的詞彙表：

1. 從 目錄 或 資料產品 選單開啟資料產品。
2. 選取 說明文件 索引標籤。
3. 捲動至 詞彙庫 區段以查看附加的詞彙庫。
4. 按一下 編輯 以新增、取代或移除詞彙表。如需詳細說明，請參閱 將商業詞彙表新增至資料產品。

身為資料產品消費者

您可以檢視附加至您有權存取的資料產品之商業詞彙表：

1. 從 目錄 開啟資料產品。
2. 選取 說明文件 索引標籤。
3. 檢視 詞彙表 區段以查看與資料產品相關的業務定義。

僅顯示您具有讀取權限的詞彙表。如果您在 文件 分頁中看不到詞彙表，請聯絡您的管理員或資料產品經理以申請存取權限。