Benutzeroberflächenrichtlinien für NDF-Hilfsklassenerweiterungen

  • Artikel

Wenn Sie Ihre Hilfsklasse erstellen, müssen Sie Text erstellen, um dem Benutzer zu helfen, die Ursache eines Vorfalls und die möglichen Reparaturschritte zu verstehen.

Grundursache und Reparatur

Wenn ein Vorfall auftritt, wird ein Dialogfeld angezeigt, in dem der Benutzer über das Geschehen informiert wird. Der von Ihnen erstellte Text wird in zwei separaten Bereichen angezeigt.

  • Grundursache: Eine kurze Beschreibung der Ursache des Problems. Enthält Informationen, die einem Administrator oder fortgeschrittenen Benutzer bei der Problembehandlung helfen.
  • Reparatur: Erweitert die Grundursache, um weitere Details zu den Schritten bereitzustellen, die ein Benutzer ausführen kann, ohne zu langwierig zu werden.

Jede Grundursache oder Reparatur sollte einen Titel und eine Beschreibung haben. Der gesamte Text vor dem ersten "\n"-Zeichen wird für den Titel verwendet. Der gesamte Text, der dem ersten "\n"-Zeichen folgt (einschließlich aller nachfolgenden Zeilenumbrüche), wird für die Beschreibung verwendet.

Titelrichtlinien

Der Titel einer Grundursache oder Reparatur sollte den folgenden Richtlinien entsprechen:

  • Darf maximal 128 Zeichen lang sein. (Maximal 40 Zeichen werden empfohlen.)
  • Sollte nicht mit einem Punkt enden.

Beschreibungsrichtlinien

Die Beschreibung einer Grundursache oder Reparatur sollte den folgenden Richtlinien entsprechen:

  • Darf maximal 512 Zeichen lang sein.
  • Jeder Satz sollte mit einem Punkt enden.
  • Das Zeichen "\n" kann verwendet werden, um einen Zeilenumbruch in der Beschreibung zu erstellen.