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

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

根本原因和修复

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

  • 根本原因:问题原因的简要说明。 包含可帮助管理员或高级用户排查问题的信息。
  • 修复:扩展根本原因,提供有关用户可执行的步骤的更多详细信息,而不会过长。

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

游戏指南

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

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

说明指南

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

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