次の方法で共有

エラー メッセージのガイドライン

  • [アーティクル]

エラー メッセージは、ユーザーまたはシステムがタスクを完了できないようにするために発生した問題を説明するために表示されるテキストです。 この問題により、データの破損や損失が発生する可能性があります。 その他のメッセージの種類には、確認、警告、通知があります。 このトピックのガイドラインは、ローカライズが容易で顧客にとって役立つ明確なエラー メッセージを作成できるようにすることを目的としています。

エラー メッセージが適切に書かれていないと、ユーザーのフラストレーションの原因となり、テクニカル サポートのコストが増加する可能性があります。 適切に記述されたエラー メッセージは、次の情報をユーザーに提供します。

  • 何が起こったのか、そしてその理由は?
  • ユーザーにとって最終的な結果は何でしょうか?
  • 再発を防ぐためにユーザーは何ができるでしょうか?

開発者がバッファ サイズを正しく処理している限り、テキストの長さは問題になりません。 ユーザーが問題を解決するために必要なすべての情報を持っていることが重要です。 メッセージに複数の対象者がいる場合は、管理者、エンド ユーザー、開発者向けに個別のテキストを提供する必要がある場合があります。

ベスト プラクティス

エラー メッセージを改善する方法を次に示します。

  • エラー状態は避けてください。 ユーザーが特定のアクションを実行したときにエラーが発生することが予測できる場合は、ユーザーがエラーを引き起こさないようにコードを書き換えます。
  • エラーの既知の原因ごとに個別のエラー メッセージを記述します。 エラーの原因を特定できない場合を除き、エラーの考えられるすべての理由を説明するために、単一の汎用メッセージを使用しないでください。
  • 問題を明確に述べ、ユーザーに役立つ場合は、問題の原因を説明します。 可能な限り、システム メッセージ テーブル リソースの一般的なメッセージを、問題に固有の詳細なメッセージに置き換えてください。
  • 問題の解決策をユーザーに提供します。 ソリューションに複数のステップがある場合は、タスクの詳細を説明するヘルプ トピックを参照してください。
  • メッセージのタイトル バーに、製品、コンポーネント、またはウィザード名のみを表示します。 これにより、ユーザーは問題の場所を特定できます。 タイトル バーの問題を要約したり、「error」という単語を含めたりしないでください。
  • 技術的な専門用語は使用しないでください。対象ユーザーが理解している用語を使用してください。 スラングや省略形は使用しないでください。
  • [OK]、[キャンセル]、[はい]、[いいえ]、[再試行] などの適切なコマンド ボタンを使用します。 これらのボタンの組み合わせを使用できます。 [はい] ボタンと [いいえ] ボタンは常に組み合わせて使用する必要があり、必ずその前に質問を付ける必要があります。
    • 操作を停止してメッセージ ボックスを閉じるには、[キャンセル] ボタンを使用します。
    • メッセージ ボックスを閉じるには、[閉じる] ボタンを使用します。
    • エラーの原因の詳細を指定するには、[詳細] ボタンを使用します。
    • 問題の解決策の詳細を提供するには、[ヘルプ] ボタンを使用します。
    • メッセージにユーザー アクションが含まれている場合は、[OK] ボタンを使用してメッセージ ボックスを閉じます。
    • [はい] ボタンと [いいえ] ボタンは常に組み合わせて使用する必要があり、必ずその前に質問を付ける必要があります。
  • エラーが重大なエラーである場合は、イベント ログに書き込みます。

スタイルに関する考慮事項

  • 完全で単純な文を使用します。
  • 問題の原因となった状況、またはまだ存在する状態を説明するには、現在時制を使用します。 過去時制を使用して、過去に発生した個別のイベントを説明できます。
  • 可能な限り能動態を使用します。 受動態を使用してエラー状態を説明できます。
  • 大文字のテキストと感嘆符は使用しないでください。
  • 問題がユーザーのミスの結果であっても、ユーザーに過失感を感じさせないでください。
  • 擬人化しないでください。 プログラムやハードウェアが思考したり感じたりできることを示唆しないでください。
  • 口語や語句は使用しないでください。 特定の文化圏で不快になる可能性のある用語を使用しないでください。
  • 意味を明確にするために前置詞や副節を追加せずに、複数の名詞を複合させないでください。 たとえば、「サイト サーバー LDAP サービス ディレクトリ サーバー」は、「サイト サーバーの LDAP サービス用のディレクトリ サーバー」に変更する必要があります。
  • 文の意味を明確にするために用語の前に記述子を挿入します。 たとえば、「検出がいいえに設定されている場合は、InfID を指定します。」「検出オプションがいいえに設定されている場合は、InfID パラメータを指定する」に変更する必要があります。
  • 「悪い」という言葉は避けてください。 何が問題なのかをユーザーに伝えるには、よりわかりやすい用語を使用してください。 たとえば、「サイズが正しくありません」などのメッセージは避けてください。 代わりに、サイズを指定するときに使用する基準をユーザーに伝えます。
  • 「お願いします」という言葉は避けてください。 これは、必須のアクションが省略可能であることを意味すると解釈されます。
  • インデックス内にあり、中心的な意味に関連する単語をメッセージ文字列の先頭に配置します。