共用方式為


NDF 協助程式類別延伸模組的 UI 指導方針

建置協助程式類別時,您必須建立文字,以協助使用者瞭解事件的原因,以及可採取的可能修復步驟。

根本原因和修復

事件發生時,會出現一個對話方塊,通知使用者發生什麼事。 您建立的文字會出現在兩個不同的區域中。

  • 根本原因:問題原因的簡短描述。 包含可協助系統管理員或進階使用者針對問題進行疑難排解的資訊。
  • 修復:擴充根本原因,以提供使用者可採取之步驟的詳細資料,而不需要太冗長。

每個根本原因或修復都應該有標題和描述。 第一個 「\n」 字元之前的所有文字都會用於標題。 第一個 「\n」 字元之後的所有文字 (包括任何後續分行符號) 將用於描述。

標題指導方針

根本原因或修復的標題應遵循下列指導方針:

  • 必須是 128 個字元或更少。 建議 (40 個字元或更少。)
  • 不應該以句號結尾。

描述指導方針

根本原因或修復的描述應遵循下列指導方針:

  • 必須是 512 個字元或更少。
  • 每個句子都應該以句號結尾。
  • 「\n」 字元可用來在描述中建立分行符號。