ReadMe ファイル

デジタルワーカーを提出する際は、デジタルワーカーをインストールして使用する方法をエンドユーザーに伝える ReadMe.txt または .pdf ファイルを添付します。

タスク Bot (.atmx ファイル) ごとに別個の ReadMe が必要です。すべての Bot の全体的な機能で、マスター ReadMe を作成します。マスター ReadMe ファイルに「<Digital Worker Name> MasterReadMe.pdf」という名前を付けます。

各 ReadMe ファイルには、次のコンテンツを含める必要があります。

  • 概要: デジタルワーカー または各 タスク Bot の説明
  • 前提条件
  • インストール手順
  • デジタルワーカーについて説明するマスター ReadMe には、以下を含めます。
    • スキル マッピング テーブル: 各スキル、タスク Bot ファイル、各スキルに関連する MetaBot ファイル、および タスク Bot ごとの ReadMe へのリンクを示すテーブル
    • デジタルワーカーが各スキル (スキル間ではなく) を実行する際に行うステップを説明するビジュアル ワークフロー
    • デジタルワーカー の実際の使い方に関する説明
    • デジタルワーカーの設定に必要なその他の情報 (Credential Vault のパラメーターなど)
  • 個別の タスク Bot の ReadMe には、次の項目を含めます。
    • パラメーター テーブル: Bot のユーザーが設定する必要がある各パラメーターを一覧表示するテーブル。このテーブルは、パラメーターの名前、型 (文字列など)、方向 (特に、入力変数や出力変数) など、パラメーターを説明するすべての情報をカバーしている必要があります。

    • サンプル パラメーターは以下のとおりです。

      パラメーター名 タイプ 方向 追加情報
      $vUserName$ 文字列 入力 アプリケーションのユーザー名
      $vExcelPath$ 文字列 出力 入力 Excel ファイル パス
      $vURL$ 文字列 入力 アプリケーションの URL
      $vPassword$ 文字列 入力 アプリケーションにログインするためのパスワード
      $vFileName$ 文字列 入力 アップロードするファイル名
注: MetaBot の入力と出力用のパラメーター テーブルが必要です。

デジタルワーカー について何の予備知識もない状態で、これをすぐに立ち上げて実行する必要があると仮定した場合、ReadMe には必要と思われるすべての情報を含めます。

「アセット」では、デジタルワーカー の送信時に含めるファイルについて説明します。