次の方法で共有


NDF ヘルパー クラス拡張機能の UI ガイドライン

ヘルパー クラスを構築するときは、ユーザーがインシデントの原因と可能な修復手順を理解するのに役立つテキストを作成する必要があります。

根本原因と修復

インシデントが発生すると、何が起こったかをユーザーに通知するダイアログ ボックスが表示されます。 作成したテキストは、2 つの異なる領域に表示されます。

  • 根本原因: 問題の原因の簡単な説明。 管理者または高度なユーザーが問題のトラブルシューティングに役立つ情報が含まれています。
  • 修復: 根本原因を拡張して、時間がかかりすぎずに、ユーザーが実行できる手順の詳細を提供します。

各根本原因または修復には、タイトルと説明が必要です。 タイトルには、最初の "\n" 文字の前のすべてのテキストが使用されます。 最初の "\n" 文字の後にあるすべてのテキスト (後続の改行を含む) が説明に使用されます。

タイトル のガイドライン

根本原因または修復のタイトルは、次のガイドラインに従う必要があります。

  • 128 文字以下にする必要があります。 (40 文字以下をお勧めします。
  • ピリオドで終わるべきではありません。

説明のガイドライン

根本原因または修復の説明は、次のガイドラインに従う必要があります。

  • 512 文字以下にする必要があります。
  • 各文はピリオドで終わる必要があります。
  • "\n" 文字を使用して、説明に改行を作成できます。