Dela via

Riktlinjer för felmeddelanden

  • Artikel

Ett felmeddelande är text som visas för att beskriva ett problem som har uppstått som hindrar användaren eller systemet från att slutföra en uppgift. Problemet kan leda till att data skadas eller går förlorade. Andra meddelandetyper är bekräftelser, varningar och meddelanden. Riktlinjerna i det här avsnittet är avsedda att hjälpa dig att skriva tydliga felmeddelanden som är enkla att lokalisera och användbara för kunder.

Dåligt skrivna felmeddelanden kan vara en källa till frustration för användarna och kan öka kostnaderna för teknisk support. Ett välskrivet felmeddelande innehåller följande information till användaren:

  • Vad hände och varför?
  • Vad är slutresultatet för användaren?
  • Vad kan användaren göra för att förhindra att det händer igen?

Textens längd är inte ett problem så länge utvecklaren hanterar buffertstorlekarna korrekt. Det är viktigt att användaren har all information som krävs för att lösa problemet. Om ett meddelande har flera målgrupper kan du behöva ange separat text för administratörer, slutanvändare och utvecklare.

Metodtips

Följande är sätt att förbättra dina felmeddelanden:

  • Undvik feltillstånd. Om du kan förutsäga att ett fel inträffar när en användare utför en specifik åtgärd skriver du om koden så att användaren inte kan orsaka felet.
  • Skriv ett separat felmeddelande för varje känd orsak till felet. Använd inte ett enda allmänt meddelande för att förklara alla möjliga orsaker till felet om du inte kan fastställa orsaken till felet när det inträffar.
  • Ange problemet tydligt och förklara vad som orsakade problemet om det är till hjälp för användaren. När det är möjligt ersätter du de allmänna meddelandena från systemresurserna i meddelandetabellen med ett detaljerat meddelande som är specifikt för problemet.
  • Ge användaren en lösning på problemet. Om lösningen innehåller mer än ett steg kan du läsa ett hjälpavsnitt som förklarar uppgiften i detalj.
  • Visa endast produkt-, komponent- eller guidenamnet i meddelandets namnlist. Detta hjälper användaren att avgöra var problemet finns. Sammanfatta inte problemet i namnlisten eller ta med ordet "fel".
  • Använd inte teknisk jargong, använd terminologi som målgruppen förstår. Använd inte slang eller förkortningar.
  • Använd lämpliga kommandoknappar, till exempel OK, Avbryt, Ja, Nej och Försök igen. Du kan använda kombinationer av dessa knappar. Knapparna Ja och Nej måste alltid användas i kombination och måste alltid föregås av en fråga.
    • Om du vill stoppa en åtgärd och stänga meddelanderutan använder du knappen Avbryt.
    • Om du vill stänga en meddelanderuta använder du knappen Stäng.
    • Om du vill ange mer information om orsaken till felet använder du knappen Information.
    • Om du vill ange mer information om lösningen på problemet använder du knappen Hjälp.
    • Om en användaråtgärd ingår i meddelandet använder du knappen OK för att stänga meddelanderutan.
    • Ja och Inga knappar måste användas i kombination och måste alltid föregås av en fråga.
  • Om felet är ett kritiskt fel skriver du det till händelseloggen.

Stilöverväganden

  • Använd fullständiga men enkla meningar.
  • Använd presensen för att beskriva de villkor som orsakade problemet eller ett tillstånd som fortfarande finns. Du kan använda tidigare tempus för att beskriva en distinkt händelse som inträffat tidigare.
  • Använd aktiv röst när det är möjligt. Du kan använda passiv röst för att beskriva feltillståndet.
  • Undvik versaler och utropstecken.
  • Få inte användaren att känna sig fel även om problemet beror på ett användarfel.
  • Antropomorfisera inte. Antyda inte att program eller maskinvara kan tänka eller känna.
  • Använd inte talspråkliga ord eller fraser. Använd inte termer som kan vara stötande i vissa kulturer.
  • Blanda inte flera substantiv utan att lägga till en preposition eller underklient för att klargöra innebörden. Till exempel bör "Site Server LDAP Service Directory Server" ändras till "Katalogserver för LDAP-tjänsten för platsservern".
  • Infoga deskriptorer före en term för att klargöra meningens innebörd. Till exempel ska "Ange InfID när Identifiering är inställt på Nej" ändras till "Ange InfID-parametern när alternativet Identifiera är inställt på Nej".
  • Undvik ordet "dålig". Använd mer beskrivande termer för att berätta för användaren vad som är fel. Undvik till exempel meddelanden som "Felaktig storlek". Tala i stället om för användaren vilka kriterier som ska användas när du anger en storlek.
  • Undvik ordet "snälla". Det kan tolkas som att en obligatorisk åtgärd är valfri.
  • Placera ord som både finns i indexet och som är relevanta för den centrala innebörden i början av meddelandesträngen.