Riktlinjer för användargränssnitt för NDF-hjälpklasstillägg

När du skapar hjälpklassen måste du skapa text som hjälper användaren att förstå orsaken till en incident och de möjliga reparationssteg som kan vidtas.

Rotorsak och reparation

När en incident inträffar visas en dialogruta som informerar användaren om vad som har hänt. Texten som du skapar visas i två separata områden.

• Root Cause: En kort beskrivning av orsaken till problemet. Innehåller information som hjälper en administratör eller avancerad användare att felsöka problemet.
• Repair: Expanderar rotorsaken för att ge mer information om de steg som en användare kan vidta, utan att bli för lång.

Varje rotorsak eller reparation bör ha en rubrik och en beskrivning. All text före det första tecknet "\n" används för rubriken. All text som följer det första tecknet "\n" (inklusive efterföljande radbrytningar) används för beskrivningen.

Riktlinjer för rubrik

Rubriken på en rotorsak eller reparation bör följa dessa riktlinjer:

• Måste vara 128 tecken eller färre. (Högst 40 tecken rekommenderas.)
• Bör inte avslutas med en punkt.

Beskrivningsriktlinjer

Beskrivningen av en rotorsak eller reparation bör följa dessa riktlinjer:

• Måste vara 512 tecken eller färre.
• Varje mening ska avslutas med en punkt.
• Tecknet "\n" kan användas för att skapa en radbrytning i beskrivningen.