ドキュメントの検索
karat

+

K

APIリファレンス ↗

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

8 - Notepad を使ったパイプラインのドキュメンテーション化

📖 タスクの概要

Data Lineage グラフは、ユーザーのチームのためのパイプラインセグメントを視覚的に描写しますが、パイプラインの範囲についてドキュメンテーション化したい追加の詳細があります:

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

このタスクでは、Notepad — Foundry の多機能リッチテキストエディター — を使用して、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