VS Codeのエージェントモードを拡張するには、を試してください!

通知

通知は、VS Code の右下から表示される簡単な情報です。

Example of a notification

3 種類の通知を送信できます

ユーザーの注意を尊重するため、送信する通知の数を制限することが重要です。通知を表示すべきかどうかの決定を支援するため、当社の通知決定ツリーに従ってください

Show a multi-step quick pick if multi step user input is immediately needed. If user input is immediately needed but it is not multi-step show a modal dialog. If you need to show progress that is low priority show the progress in the status bar. If the interaction is triggered by the user find the right moment to show the notification and only then show it. If you need to show multiple notifications try to combine them into one. If the user does not really need to be notified consider to not show anything and relax.

通知の例

Information notification

この通知は、ユーザーがバージョンを更新コマンドを実行した後に表示されます。追加のアクションはなく、純粋に情報提供のみです。

Warning notification

この例は、ユーザー入力を必要とする機能の問題を強調し、問題を解決するためのアクションを示します。

Error notification

この例は、問題を解決するためのアクションを伴う失敗通知を示します。

✔️ すべきこと

  • 本当に必要な場合にのみ通知を送信することで、ユーザーの注意を尊重します
  • すべての通知に今後表示しないオプションを追加します
  • 一度に1つの通知を表示します

❌ すべきでないこと

  • 繰り返し通知を送信する
  • プロモーションに使用する
  • 初回インストール時にフィードバックを求める
  • アクションがない場合はアクションを表示する

進行状況通知

不定の期間(環境のセットアップなど)の進行状況を表示する必要がある場合は、進行状況通知を使用できます。このタイプのグローバルな進行状況通知は、進行状況がコンテキスト内(ビューまたはエディター内)に保たれるのが最適であるため、最後の手段として使用する必要があります。

✔️ すべきこと

  • 詳細(ログなど)を見るためのリンクを表示する
  • セットアップの進行状況に応じて情報を表示する(初期化中、ビルド中など)
  • 操作をキャンセルするアクションを提供する(該当する場合)
  • タイムアウトシナリオのタイマーを追加する

❌ すべきでないこと

  • 進行中の通知を残す

Progress notification

この例では、進行状況通知を使用してリモート接続のセットアップを示し、出力ログへのリンク(詳細)も提供しています。

アクションに即座のユーザー入力が必要な場合は、モーダルダイアログを表示することを選択できます。この UI 要素は、モーダルダイアログが閉じられるまで、ダイアログ外のユーザーインタラクションをブロックするため、注意して使用する必要があります。

Modal dialog

このダイアログは、JavaScript/TypeScript ファイルを移動した後、他のファイル内のインポートステートメントを更新するように求めます。

✔️ すべきこと

  • 即座のユーザーインタラクションが必要な場合にのみモーダルダイアログを使用します
  • 必要に応じて、繰り返しのユーザー確認を避けるためのアクションを提供する(常に/しないアクション)
  • ユーザーの選択を記憶するためにチェックボックスの使用を検討する

❌ すべきでないこと

  • 複数のステップを確認するためにモーダルダイアログを使用する
  • ユーザーからのアクションを必要としないメッセージを表示するためにモーダルダイアログを使用する
  • ユーザーによって明示的に開始されていないアクションに対してモーダルダイアログを表示する