共通デスクトップ環境 スタイル・ガイド

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

アプリケーションのエラー・メッセージの表示には、Motif エラー・ダイアログ・ボックスを使用します。図 8-1 に、典型的なエラー・ダイアログ・ボックスを示します。エラー・メッセージの基本的な 3 部構成を念頭に置いてください。各メッセージは、可能な限り、次の情報をユーザに伝えなければなりません。

図 8-1 エラー・ダイアログ・ボックス

Graphic

上記のテキストは、エラーの内容と、それが生じた理由を説明し、操作の再実行を勧めています。右下にある [ヘルプ] ボタンは、適切なオンライン・ドキュメントを表示します。

推奨 

gd: 

アプリケーションが表示するエラー・メッセージは、エラーの考えうる原因を示し、ユーザがそれに応じて取ることができるアクションを示す。 

エラー・ダイアログの情報は、明確で簡潔なものにしてください。目的は、問題についてユーザに警告を発し、ユーザが問題を迅速に理解し、そこからの回復方法を認識できるようにすることです。大量のテキストがあると、ユーザは重要な情報に注意を集中しづらくなります。 

推奨 

gc: 

アプリケーションが表示するメッセージは、ユーザがコンピュータ・システム一般や、UNIX システムに関する専門的な知識を持っていることを想定したものであってはならない。 

ユーザが、ファイルやプログラムなど、デスクトップ内で使用する標準的な用語に関する知識を持っていることは想定してもかまいません。ユーザは、このような知識を、チュートリアル、オンライン・ヘルプ、およびユーザ・マニュアルから得ていると考えられます。しかし、専門家や上級者のコンピュータ・ユーザしか理解できないような用語は、コンピュータの専門家をターゲットとしているアプリケーション以外では避けるべきです。同じように、基本のオペレーティング・システムによってアプリケーションに返されるメッセージは、そのままユーザに渡すのではなく、初心者のユーザでも理解できるような言葉に「翻訳」しなければなりません。

エラー・メッセージは、その場の状況に即した、できるだけ有用な内容にするようにします。たとえば、ユーザが無効な名前を入力した場合、エラー・メッセージは、単に無効な名前が入力されたということを述べるだけでは不十分です。その代わりに、どの文字が無効だったのかをユーザに知らせます。有効な名前かどうかを決める規則が単純な場合は、エラー・メッセージの中で説明してください。単純ではない場合は、規則をオンライン・ヘルプに記述し、[ヘルプ] ボタンからアクセスできるようにします。

多くの場合、エラー・ダイアログ・ボックスに対するユーザの反応は、[了解] ボタンをクリックして、ダイアログ・ボックスを消去するというものだけになります。ただし、ユーザのために問題を解決してあげることが可能な場合もあります。ユーザ・アクションのためのボタンを作成する場合は、[取消し] ボタンも用意することを忘れてはなりません。

オプション 

ge: 

アプリケーションは、エラーの条件やイベントを通知するために、表示されるメッセージに加えて、音声でのフィードバックも使用するべきである。 

オプション 

gh: 

ユーザがどのアプリケーションやデスクトップ・サービスにアクセスしていても、ユーザがただちに知らなければならない緊急事態が発生した場合は、聴覚的かつ視覚的な通知を使用してユーザの注意を引く。アプリケーションがどのワークスペースにあるかにかかわらず、警報は現在のワークスペースで通知されなければならない。 

ネットワーク・モニタや株式監視プログラムなど、一部のアプリケーションは、何らかのイベントに対して、ユーザの注意をただちに引き付けなければなりません。ユーザへの通知には、視覚的かつ聴覚的な警報を使用するべきです。ユーザはその警報を確認し、終了させることができなければなりません。 

ユーザが複数のアプリケーションを同時に実行しており、アプリケーションをバックグラウンドで動作させていて、別のアプリケーションに注意を払っている間にエラーが発生する可能性があることに注意しなければなりません。ユーザがエラー・メッセージの発生源を識別できるように、タイトル・バーにはアプリケーション名を入れておくべきです。

エラー・メッセージを読んだユーザは、問題を解決するために、システムの他の部分にアクセスしなければならないことがあります。エラー・ダイアログ・ボックスを表示することによって、アプリケーションとの対話が妨げられるようなことがあってはなりません。また、可能な限り、他のアプリケーションとの対話を妨げてもなりません。

オプション 

gq: 

アプリケーションは、エラー・メッセージがメッセージ・ダイアログ・ボックスに表示するのには適さないが、問題の診断に役立つ可能性がある場合には、共通デスクトップ環境のエラー・ログにエラー・メッセージを書き込む。 

また、ユーザや管理者にとって、メッセージを後から確認できると便利な場合は、ユーザに表示されたエラー・メッセージをエラー・ログに書き込むこともできます。エラー・ログに書き込まれたメッセージは、エラーに関する詳細な情報を提供し、エラーが発生したコンテキストを明示するべきです。