ヘルパー クラスを構築するときは、インシデントの原因と可能な修復手順をユーザーが理解するのに役立つテキストを作成する必要があります。
根本原因と修復
インシデントが発生すると、何が発生したかをユーザーに通知するダイアログ ボックスが表示されます。 作成したテキストは、2 つの異なる領域に表示されます。
- 根本原因: 問題の原因の簡単な説明。 管理者または上級ユーザーが問題のトラブルシューティングを行う際に役立つ情報が含まれています。
- 修復: 根本原因を拡張して、ユーザーが実行できる手順の詳細を提供します。時間がかかりすぎないようにします。
各根本原因または修復には、タイトルと説明が必要です。 最初の "\n" 文字の前のすべてのテキストがタイトルに使用されます。 説明には、最初の "\n" 文字 (後続の改行を含む) に続くすべてのテキストが使用されます。
タイトルのガイドライン
根本原因または修復のタイトルは、次のガイドラインに従う必要があります。
- 128 文字以下にする必要があります。 (40 文字以下をお勧めします。
- ピリオドで終わるべきではありません。
説明のガイドライン
根本原因または修復の説明は、次のガイドラインに従う必要があります。
- 512 文字以下にする必要があります。
- 各文はピリオドで終わる必要があります。
- "\n" 文字を使用して、説明に改行を作成できます。