Delen via

Richtlijnen voor foutberichten

  • Artikel

Een foutbericht is tekst die wordt weergegeven om een probleem te beschrijven dat heeft plaatsgevonden waardoor de gebruiker of het systeem een taak niet kan voltooien. Het probleem kan leiden tot beschadiging of verlies van gegevens. Andere berichttypen zijn bevestigingen, waarschuwingen en meldingen. De richtlijnen in dit onderwerp zijn bedoeld om u te helpen bij het schrijven van duidelijke foutberichten die gemakkelijk te lokaliseren en nuttig zijn voor klanten.

Slecht geschreven foutberichten kunnen een bron van frustratie zijn voor gebruikers en kunnen de kosten voor technische ondersteuning verhogen. Een goed geschreven foutbericht bevat de volgende informatie voor de gebruiker:

  • Wat is er gebeurd en waarom?
  • Wat is het eindresultaat voor de gebruiker?
  • Wat kan de gebruiker doen om te voorkomen dat deze zich opnieuw voordoet?

De lengte van de tekst is geen probleem zolang de ontwikkelaar buffergrootten correct verwerkt. Het is belangrijk dat de gebruiker beschikt over alle informatie die nodig is om het probleem op te lossen. Als een bericht meerdere doelgroepen heeft, moet u mogelijk afzonderlijke tekst opgeven voor beheerders, eindgebruikers en ontwikkelaars.

Aanbevolen procedures

Hier volgen manieren om uw foutberichten te verbeteren:

  • Vermijd foutvoorwaarden. Als u kunt voorspellen dat er een fout optreedt wanneer een gebruiker een specifieke actie uitvoert, herschrijft u de code zodat de gebruiker de fout niet kan veroorzaken.
  • Schrijf een afzonderlijk foutbericht voor elke bekende oorzaak van de fout. Gebruik geen enkel algemeen bericht om alle mogelijke redenen voor de fout uit te leggen, tenzij u de oorzaak van de fout niet kunt bepalen wanneer deze optreedt.
  • Geef het probleem duidelijk op en leg uit wat het probleem heeft veroorzaakt als het nuttig is voor de gebruiker. Vervang indien mogelijk de algemene berichten uit de systeemberichttabelresources door een gedetailleerd bericht dat specifiek is voor het probleem.
  • Geef de gebruiker een oplossing voor het probleem. Als de oplossing meer dan één stap heeft, raadpleegt u een Help-onderwerp waarin de taak gedetailleerd wordt uitgelegd.
  • Alleen de naam van het product, onderdeel of de wizard weergeven op de titelbalk van het bericht. Dit helpt de gebruiker te bepalen waar het probleem zich voordoet. Vat het probleem niet samen in de titelbalk of neem het woord 'fout' op.
  • Gebruik geen technisch jargon, gebruik terminologie die uw publiek begrijpt. Gebruik geen slang of afkortingen.
  • Gebruik de juiste opdrachtknoppen, zoals OK, Annuleren, Ja, Nee en Opnieuw proberen. U kunt combinaties van deze knoppen gebruiken. De knoppen Ja en Nee moeten altijd in combinatie worden gebruikt en moeten altijd worden voorafgegaan door een vraag.
    • Als u een bewerking wilt stoppen en het berichtvak wilt sluiten, gebruikt u de knop Annuleren.
    • Als u een berichtvak wilt sluiten, gebruikt u de knop sluiten.
    • Als u meer informatie wilt over de oorzaak van de fout, gebruikt u de knop Details.
    • Als u meer informatie wilt over de oplossing voor het probleem, gebruikt u de knop Help.
    • Als een gebruikersactie is opgenomen in het bericht, gebruikt u de knop OK om het berichtvak te sluiten.
    • Ja en Knoppen Nee moeten in combinatie worden gebruikt en moeten altijd worden voorafgegaan door een vraag.
  • Als de fout een kritieke fout is, schrijft u deze naar het gebeurtenislogboek.

Overwegingen voor stijlen

  • Gebruik volledige maar eenvoudige zinnen.
  • Gebruik de huidige tijd om de voorwaarden te beschrijven die het probleem hebben veroorzaakt of een status die nog bestaat. U kunt afgelopen tijd gebruiken om een afzonderlijke gebeurtenis te beschrijven die in het verleden is opgetreden.
  • Gebruik waar mogelijk actieve stem. U kunt passieve spraak gebruiken om de foutvoorwaarde te beschrijven.
  • Vermijd hoofdletters en uitroeptekens.
  • Zorg ervoor dat de gebruiker zich fout voelt, zelfs niet als het probleem het gevolg is van een gebruikersfout.
  • Antropomorphiseren niet. Impliceren niet dat programma's of hardware kunnen denken of voelen.
  • Gebruik geen colloquiale woorden of woordgroepen. Gebruik geen termen die in bepaalde culturen aanstootgevend kunnen zijn.
  • Meng niet meerdere zelfstandige naamwoorden zonder een voorzetsel of subclause toe te voegen om de betekenis te verduidelijken. De adreslijstserver van de SiteServer LDAP-service moet bijvoorbeeld worden gewijzigd in Adreslijstserver voor de LDAP-service van de siteserver.
  • Voeg descriptors in vóór een term om de betekenis van de zin te verduidelijken. 'Geef bijvoorbeeld InfID op wanneer Detecteren is ingesteld op Nee'. Moet worden gewijzigd in 'Geef de parameter InfID op wanneer de optie Detecteren is ingesteld op Nee'.
  • Vermijd het woord 'slecht'. Gebruik meer beschrijvende termen om de gebruiker te laten weten wat er mis is. Vermijd bijvoorbeeld berichten zoals 'Ongeldige grootte'. Laat in plaats daarvan de gebruiker weten welke criteria moeten worden gebruikt bij het opgeven van een grootte.
  • Vermijd het woord 'alsjeblieft'. Het kan worden geïnterpreteerd om te betekenen dat een vereiste actie optioneel is.
  • Plaats woorden die zich in de index bevinden en die relevant zijn voor de centrale betekenis aan het begin van de berichtreeks.