このマニュアルでのメッセージの記述形式を次に示します。
XXXXnnnnn-Y
メッセージテキスト
- 可変値に関する説明
- 説明
- メッセージテキストに対する補足説明
- 対処
- ユーザが実施する対処
なお,「可変値に関する説明」,「説明」および「対処」はメッセージによって記述しないものもあります。
- XXXX
- メッセージを出力した構成ソフトウェアを示すID(プリフィックス)を表します。プリフィックスは英字4文字で示します。
- nnnnn
- メッセージを出力したプログラムで管理するメッセージ番号を表します。それぞれのメッセージには,5けたの固有の番号が付いています。
- Y
- メッセージのレベルを表します。メッセージのレベルは英字1文字で示します。
- メッセージのレベルを示す文字とその意味を次に示します。
- E(Error)
- エラーレベルのトラブルが発生したことを通知するメッセージです。
- このメッセージが出力されたときは,処理を中断します。
- W(Warning)
- 警告レベルのトラブルが発生したことを通知するメッセージです。
- メッセージが出力されたあとも処理を続行します。
- I(Information)
- システムの動作を通知するメッセージです。
- メッセージが出力されたあとも処理を続行します。
- Q(Question)
- 出力したメッセージに対して,ユーザの応答を通知するメッセージです。
- このメッセージが出力されたときは,ユーザの応答を待ちます。
- R(Request)
- 出力メッセージに対するユーザからの応答を待っていることを通知するメッセージです。
- メッセージテキスト
- 構成ソフトウェアが出力したメッセージテキストを示します。
- なお,メッセージテキスト中の可変値(メッセージが出力される状況によって変わる値)は,「xx....xx」(xxは英小文字)の形式で示します。
- 可変値に関する説明
- メッセージテキスト中の可変値に表示される情報を「xx....xx:表示される情報」(xxは英小文字)の形式で示します。可変値に関する説明の記述例を次に示します。
- (例)
- aa....aa:ファイル名
- bb....bb:アプリケーション名
- 説明
- メッセージが通知された要因やメッセージを出力した構成ソフトウェアの動作など,メッセージに対する補足説明を示します。
- 対処
- ユーザが実施する対処を表します。なお,対処方法の「保守員に連絡してください」とは,購入時の契約に基づいて,システム管理者が弊社問い合わせ窓口へ連絡することを示します。