データ製品の文書化

データ製品ごとに 2 種類のドキュメントがあります。

• データセット、データの鮮度、データ品質など、データ製品を要約した一般的なドキュメント。
• データ製品マネージャーがデータ製品について共有したいすべての情報を含む「お読みください」セクション。

データ製品に主要な連絡先を追加したり、ビジネス用語集を添付して、標準化されたビジネス定義をコンシューマーに提供したりすることもできます。

データ製品の一般ドキュメント生成

データ製品のドキュメントを生成、表示、ダウンロードして、データの品質、データセットの数、各データセットの品質、各データセットの項目など、データ製品に関するすべての情報を 1 つのファイルに収集できます。

ドキュメントはマークダウン形式 (.md) でダウンロードできます。

データ製品内のデータセットがアクセスできないスペースにある場合でも、ドキュメントを生成してダウンロードできますが、データセットとそのデータはドキュメントに含まれません。

1. [カタログ] または [データ製品] メニューからデータ製品を開きます。
2. 右側で、 > [ドキュメントを取得] をクリックします。[ドキュメント] ウィンドウが開きます。
3. MD 形式でダウンロードするには、 [ダウンロード] をクリックします。

   ブラウザから PDF 形式でダウンロードすることもできます。右クリックで [ドキュメント] > [印刷...] をクリックします。

「お読みください」セクションの編集

データ製品マネージャーは、「お読みください」セクションを必要なだけ編集できます。リッチ テキスト形式を使用すると、セクションをできるだけ明確に構造化できます。

1. 次のロールまたは権限を持っていることを確認します:
   • データ製品マネージャー ロール、またはデータ製品の管理権限。
   • スペースを編集する権限。
2. [カタログ] または [データ製品] メニューからデータ製品を開きます。
3. [ドキュメント] タブを選択します。
4. 「お読みください」セクションで [編集] をクリックします。
5. 情報を入力し、[保存] をクリックします。

右側の > [ドキュメント] をクリックして、「お読みください」セクションを編集することもできます。

主要な連絡先の追加

主要な連絡先を追加して、データ製品に関する質問や問題について消費者が誰に連絡できるかを指定します。

1. 次のロールまたは権限を持っていることを確認します:
   • データ製品マネージャー ロール、またはデータ製品の管理権限。
   • スペースを編集する権限。
2. [カタログ] または [データ製品] メニューからデータ製品を開きます。
3. [ドキュメント] タブを選択します。
4. 「連絡先」セクションで [編集] をクリックします。
5. 主要な連絡先を入力し、[保存] をクリックします。

右側の > [ドキュメント] > [主要な連絡先] をクリックして、主要な連絡先を編集することもできます。

添付されたビジネス用語集の表示

データ製品には、データ製品の内容に関する標準化されたビジネス定義を提供するビジネス用語集が添付される場合があります。用語集は、[Documentation (ドキュメンテーション)]タブに、[Read me]セクションおよび主要な連絡先とともに表示されます。

データ製品マネージャーの場合

添付された用語集を表示および管理できます。

1. [カタログ] または [データ製品] メニューからデータ製品を開きます。
2. [ドキュメント] タブを選択します。
3. 添付された用語集を表示するには、[Glossaries (用語集)]セクションまでスクロールします。
4. グロッサリーを追加、置換、または削除するには、[Edit (編集)]をクリックします。詳細な手順については、「データ製品にビジネス用語集を追加する」を参照してください。

データ製品コンシューマーの場合

アクセス権があるデータ製品に添付されているビジネス用語集を表示できます。

1. [カタログ]メニューからデータ製品を開きます。
2. [ドキュメント] タブを選択します。
3. データ製品に関連するビジネス定義を確認するには、[Glossaries(用語集)]セクションを表示します。

読み取りアクセス権がある用語集のみが表示されます。[Documentation(ドキュメンテーション)タブに用語集が表示されない場合は、管理者またはデータ製品マネージャーに連絡してアクセスをリクエストしてください。