Поделиться через

Рекомендации по пользовательскому интерфейсу для расширений вспомогательного класса NDF

  • Статья

При создании вспомогательного класса необходимо создать текст, чтобы помочь пользователю понять причину инцидента и возможные шаги по восстановлению, которые можно выполнить.

Первопричина и исправление

При возникновении инцидента появится диалоговое окно, информирующее пользователя о том, что произошло. Создаваемый текст будет отображаться в двух отдельных областях.

  • Первопричина: краткое описание причины проблемы. Содержит сведения, которые помогут администратору или опытным пользователям устранить проблему.
  • Исправление: расширяется основная причина, чтобы предоставить дополнительные сведения о действиях, которые может выполнить пользователь, не слишком долго.

Каждая первопричина или исправление должна иметь заголовок и описание. Весь текст перед первым символом "\n" будет использоваться для заголовка. Для описания будет использоваться весь текст после первого символа "\n" (включая все последующие разрывы строк).

Руководство по заголовкам

Заголовок первопричины или исправления должен соответствовать следующим рекомендациям:

  • Должно содержать не более 128 символов. (Рекомендуется использовать не более 40 символов.)
  • Не должен заканчиваться точкой.

Рекомендации по описанию

Описание первопричины или исправления должно соответствовать следующим рекомендациям:

  • Должно содержать не более 512 символов.
  • Каждое предложение должно заканчиваться точкой.
  • Символ "\n" можно использовать для создания разрыва строки в описании.