Linee guida dell'interfaccia utente per le estensioni della classe helper NDF

Quando si compila la classe helper, è necessario creare testo per aiutare l'utente a comprendere la causa di un evento imprevisto e i possibili passaggi di riparazione che possono essere eseguiti.

Causa radice e riparazione

Quando si verifica un evento imprevisto, verrà visualizzata una finestra di dialogo per informare l'utente su ciò che è successo. Il testo creato verrà visualizzato in due aree separate.

• Causa radice: breve descrizione della causa del problema. Contiene informazioni per aiutare un amministratore o un utente avanzato a risolvere il problema.
• Ripristino: espande la causa radice per fornire altri dettagli sui passaggi che un utente può eseguire, senza ottenere troppo tempo.

Ogni causa radice o riparazione deve avere un titolo e una descrizione. Tutto il testo prima del primo carattere "\n" verrà usato per il titolo. Tutto il testo che segue il primo carattere "\n" (incluse le interruzioni di riga successive) verrà usato per la descrizione.

Linee guida per il titolo

Il titolo di una causa radice o di una riparazione deve seguire queste linee guida:

• Deve essere di 128 caratteri o meno. (è consigliabile 40 caratteri o meno).
• Non deve terminare con un periodo.

Linee guida per la descrizione

La descrizione di una causa radice o di una riparazione deve seguire queste linee guida:

• Devono essere 512 caratteri o meno.
• Ogni frase deve terminare con un punto.
• Il carattere "\n" può essere usato per creare un'interruzione di riga nella descrizione.