NDF 帮助程序类扩展的 UI 指南

生成帮助程序类时,需要创建文本来帮助用户了解事件的原因和可能采取的修复步骤。

根本原因和修复

事件发生时,将显示一个对话框,告知用户发生了什么情况。 你创建的文本将显示在两个单独的区域中。

  • 根本原因:问题原因的简要说明。 包含帮助管理员或高级用户解决问题的信息。
  • 修复:展开根本原因,提供有关用户可以采取的步骤的更多详细信息,而无需太长。

每个根本原因或修复都应有标题和说明。 第一个“\n”字符之前的所有文本将用于标题。 第一个“\n”字符之后的所有文本(包括任何后续换行符)都将用于说明。

游戏准则

根本原因或修复的标题应遵循以下准则:

  • 必须为 128 个字符或更少。 (建议使用 40 个字符或更少字符)。
  • 不应以句点结尾。

说明指南

根本原因或修复的说明应遵循以下准则:

  • 长度必须为 512 个字符或更少。
  • 每个句子应以句点结束。
  • “\n”字符可用于在说明中创建换行符。