Readme ファイルを作成
- 最終更新日2020/05/12
Readme ファイルを作成
Bot Store に送信する Bot ごとに別個の Readme PDF ファイルを作成することが重要です。これらの Readme ファイルを通じて、エンドユーザーは Bot をインストールして使用する方法を理解できます。
各 タスク Bot (.atmx
ファイル) または MetaBot (.mbot
ファイル) ごとに別個の Readme ファイルが必要です。各 Readme ファイルには、次の点を含める必要があります。
- 概要: タスク Bot の説明
- 前提条件:
- インストール ステップ: Bot が機能するために必要な設定ファイルやその他の入力ファイル (資格情報を除く) に関する詳細を含めます。
- パラメーター テーブル: エンド ユーザーが Bot を構成するために必要なパラメーターを一覧表示するテーブルを含めます。テーブルには次の項目を含める必要があります。
- パラメーター名
- タイプ (文字列または整数など)
- 変数の方向 (入力や出力など)
パラメーターの説明に関するその他の情報です。
重要:
- タスク Bot: タスク Bot の設定に必要な入力パラメーターのみを含めます。設定に不要な内部変数は含めません。
- MetaBot: MetaBot の入力変数と出力変数のパラメーター テーブルを用意することが重要です。