実用的なエラー メッセージを作成する

このページでは、ユーザーが目標を達成できるように、問題の解決方法をユーザーに伝えるための、実用的なエラー メッセージを作成するためのベスト プラクティスについて説明します。

ユーザーが Google Chat 用アプリを操作しているときに、エラー メッセージが表示されると、そのエラーが解決できない場合はストレスを感じることがあります。たとえば、エラー メッセージ An error occurred は、何が問題だったのか、ユーザーが問題を解決するにはどうすればよいのか、ユーザーがサポートを受けるにはどうすればよいのかが説明されていないため、役に立ちません。このページでは、ユーザーにとって役立つエラー メッセージを構成する方法について、実行可能な例と実行不可能な例を示しながら説明します。

エラー メッセージの構造

対応可能なエラー メッセージの構造は次のとおりです。

• 何が問題だったか。Chat アプリがリクエストを完了できない理由を説明すると、ユーザーが問題を解決するのに役立ちます。エラーが発生した理由を説明することで、信頼を築くことができます。
• ユーザーが目標を達成するための手順。何が間違っていたかを言うだけでは十分ではありません。エラーを回避して目標を達成する方法をユーザーに伝えます。
• サポートの利用方法。それでも問題が解決しない場合は、サポートを受ける方法をお客様に伝えます。/help コマンドや、Chat 用アプリのドキュメントへのリンクを指定できます。

エラー メッセージの例: 日付の形式が正しくありません

この例では、ユーザーが Chat 用アプリが想定していない形式で日付を入力しています。November 19, 2021 と記述しましたが、Chat アプリでは 2021-11-19 が想定されています。

Chat 用アプリが返すエラー メッセージの、対応可能なバージョンと対応不可能なバージョンを以下に示します。

対処可能なエラー

ユーザーが Chat 用アプリに別のユーザーとの会議のスケジュール設定を依頼します。Chat 用アプリから、適切なエラー メッセージが返されます。

I don't recognize the date format you entered. Write dates as `yyyy-mm-dd`; for example, `2000-01-31`. For help, type `/help`.

このエラー メッセージは、次の理由で対応可能です。

• 何が問題だったかを表示します。Chat 用アプリが日付形式を認識しない。
• ユーザーに想定される日付形式を伝え、入力する内容を理解するのに役立つ日付の例を示すことで、エラーを修正する方法を説明します。
• /help スラッシュ コマンドで詳細なヘルプを提供します。それでも解決しない場合は、詳細を確認する方法がわかります。

対応できないエラー

ユーザーが Chat 用アプリに別のユーザーとの会議のスケジュール設定を依頼します。Chat 用アプリから、役に立たない、対応できないエラー メッセージが返されます。

Enter the correct date format.

このエラー メッセージは、次の理由で対応できません。

• 会議のスケジュールを設定したかどうかは表示されません。ユーザーは会議のスケジュール変更をためらったり、会議がスケジュールされていると思い込んだりする可能性があります。
• 日付の形式を指定する方法がユーザーに伝わっていない。ユーザーが日付の形式を理解していることを前提とするのではなく、日付の形式 yyyy-mm-dd が必要であることを明記する必要があります。
• 他にサポートが必要かどうかを尋ねなかった。ユーザーが先に進めなくなって、どうすればよいかわからなくなると、Chat 用アプリへのメッセージ送信を停止する可能性があります。

試してみる

対処可能なエラーの書き方を理解したところで、次のシナリオで対処可能なエラーを特定してください。

ユーザーがキーワード schedule を使用して Chat 用アプリにメッセージを送信すると、Chat 用アプリがカレンダーの予定を作成します。カレンダーの予定を作成するには、Chat 用アプリでユーザー認証が必要です。ユーザーが認証されていない場合、Chat 用アプリはエラー メッセージを返します。