エラーメッセージ
アプリケーション内に表示するエラーメッセージの作成に関するガイドラインです。
エラーメッセージのライティングは、基本的にライティングスタイル、用字用語に準拠します。 そのほか、エラーメッセージ特有の気をつけるべきポイントを記載しています。
適用範囲
アプリケーションを操作してエラーが発生したときに表示するメッセージすべてです。
ここでは、以下の場合について説明します。
- バックグラウンド処理画面
- FlashMessage
エラーメッセージの基本的な考え方
エラーメッセージを表示する目的は、ユーザーがメッセージを見て問題を解決でき、次の操作に進める状態にすることです。
この状態を実現できないエラーメッセージだった場合、ユーザーの戸惑いや不安につながります。 ユーザーが問題を解決できる対処方法を明示した内容にすることを考えます。
エラーメッセージの基本的な要素
どのエラーメッセージであっても、含める情報の要素は事象・原因・対処です。
ただし、画面のスペースやUIによっては、すべての要素を表示できないことがあるため、コンテキストにあわせて、都度検討が必要になります。
事象
- 「ユーザーにとって何が起きたか」を説明した内容。
- プロダクトを操作しているユーザー目線の内容になっていることが大切です。
原因
- 「なぜ、エラーが発生したか」を説明した内容。
- ユーザーがエラーを解消しやすくなるように、どこに問題があったかを簡潔明瞭に具体的に伝える内容になっていることが大切です。
対処
- 「エラーをどう解消すればよいか」を説明した内容。
- ユーザーが具体的に何をすればよいのかを理解でき、次の操作に進める内容になっていることが大切です。
スペースが足りないときなど、すべての要素を表示できない場合は、原因＞対処＞事象の順で優先しましょう。
ユーザーの目的は「無事に操作を完了させること」であり、そのためにユーザーが知りたいことは「どうしたらエラーを解消できるか」です。 そのため、エラーを解消するための原因とその対処の表示を優先します。
エラーメッセージのライティングパターン
バックグラウンド処理
- バックグラウンド処理のエラーメッセージに含める要素は、事象・原因・対処です。
- フラッシュメッセージと異なり、メッセージを表示するスペースがあるため、すべての要素を記載しましょう。
- 結果概要に事象、エラー詳細に原因と対処を記載します。
OK例
結果概要
「CSVファイルの取り込みに失敗しました。」
エラー詳細
「CSVファイルの文字コードの形式が正しくありません。UTF-8形式で保存したCSVファイルを再度取り込んでください。」
- 結果概要で、ユーザーがやろうとしていた操作の結果を端的に伝えます。ここでは、ユーザーがやろうとしていた操作は「CSVファイルの取り込み」です。
- エラー詳細で、操作が失敗した理由、その解決方法を具体的に伝えます。
NG例
結果概要
「CSVファイルの文字コードが不正な形式です。」
エラー詳細
「CSVファイルの文字コードが不正な形式です。」
- 結果概要とエラー詳細に同じ内容が記載されており、詳細を確認しようとしたユーザーが詳しい情報得られない内容になっています。
- 結果概要に操作が失敗した原因が記載され、ユーザーの操作「CSVファイルの取り込み」の結果が記載されていません。
- 具体的な対処が記載されておらず、エラーをどう解消すればいいのかがわからない内容になっています。
ライティングパターン
2つのケースに分けて、2種類のライティングパターンを用意しています。
CSVを取り込むことで、目的の操作をする場合
例：CSVを取り込んで、従業員を一括招待する
ユーザーが実行する操作と目的の操作が一致している場合
例：PDFを一括でアップロードする
1. CSVを取り込むことで、目的の操作をする場合
2. 目的となる操作とユーザーが実行する操作が一致している場合
FlashMessage
- FlashMessageで伝える要素は、原因または原因・対処です。
- FlashMessageは数秒で消えてしまい、かつメッセージの表示スペースが少ないため、ユーザーがひと目で把握できる情報量にする必要があります。
OK例
「対象のカスタムマスター項目は、すでに削除済みです。」
- ユーザーの操作「カスタムマスター項目の削除」ができなかった原因を端的に、なるべく一文で伝えます。
- 人がひと目で認識できる情報のかたまり（チャンク）を意識して、句読点を使いましょう。
NG例
「対象のカスタムマスター項目の削除に失敗しました。対象のカスタムマスター項目は、存在しません。対象のカスタムマスター項目を確認してください。」
- 事象・原因・対処のすべてに言及し、親切そうではありますが、情報量が多く、数秒で消えてしまうFlashMessageには適しません。
- 原因の「対象のカスタムマスター項目は、存在しません。」は事実ではありますが、「なぜ存在しないのか（＝すでに削除されているから）」が説明されていません。