注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

8 - Notepad を使ったパイプラインのドキュメント化

learn.palantir.com ↗ でも以下の内容をご覧いただけますが、アクセシビリティの観点から、ここに掲載しています。

📖 タスクの概要

データフローグラフはチームのパイプラインセグメントを視覚的に表現しますが、パイプラインの範囲に関する次のような追加の詳細を記録する必要があります:

  • サービスレベル契約
  • 連絡先
  • データの期待値
  • 使用パラメーター
  • トラブルシューティング手順
  • 非標準機能

このタスクでは、Foundry の多用途なリッチテキストエディタである Notepad を使用して、Datasource プロジェクトの /documentation フォルダーにユーザーのパイプラインに関するさらに多くの情報を追加します。

🔨 タスクの説明

  1. ユーザーの Datasource プロジェクトの /documentation フォルダーを開きます。

  2. 画面の右上にある緑色の ➕ New ▾ ボタンをクリックし、Document を選択します。

  3. 左上の汎用ファイル名をクリックし、Flight Alerts Datasource Project Pipeline Documentation に名前を変更します。

  4. 次のテキストをドキュメントに追加し、アプリケーション画面の左上のオプションを使用して、見出しとサブ見出しのサイズを調整し、箇条書きや番号付けを追加し、その他の任意のスタイリングを行います:

    **Flight Alerts Pipeline**
    **Ownership**
    
    * Project team: Aviation Data Development
    * Project owner: [yourName@yourOrganization.com](mailto:yourName@yourOrganization.com)
    
    **Overview**
    This pipeline takes raw data ingested from the Flight Alerts datasource and:
    
    1. Normalizes column names and data types across all raw datasets
    2. Maps status codes from numbers to strings that represent their human meanings
    3. Adds two null string columns (one for assignee, and one for comment) to be used in operational downstream workflows