次の方法で共有

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

  • [アーティクル]

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

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

  • 何が起こったのか、その理由は何ですか?
  • ユーザーの最終的な結果は何ですか?
  • ユーザーは、再び発生しないようにするために何ができますか?

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

ベスト プラクティス

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

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

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

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