exempelvärden

Exempelvärden är värden som används i dokumentation, uppgifter, gränssnitt och undervisningsmaterial för att illustrera hur en funktion, ett fält eller en variabel förväntas se ut och bete sig. De hjälper användare att förstå vilket format, vilka enheter och vilka begränsningar som gäller samt hur data kan komma att se ut i praktiken.

Användningen av exempelvärden är vanlig i API- och användardokumentation, i handböcker för programvaruverktyg, vid testfall och i undervisande material. De visar både vad som är giltigt och hur felmeddelanden kan se ut när indata saknas eller är felaktig. Exempelvärden bör därmed vara tydliga, konsekventa och lätta att reproducera i tester eller demonstrationsmiljöer.

När man väljer exempelvärden finns det flera överväganden. Välj värden som är reprezentativa för typiska scenarier, samt inkludera gränsfall för att visa hur systemet hanterar kantfall. Ange tydligt datatyp och enhet (t.ex. ålder i år, vikt i kilogram, datum i ÅÅÅÅ-MM-DD). Om personuppgifter används som exempel bör verkliga identitetsuppgifter undvikas eller dummydata används. För numeriska och datumbaserade exempel kan man också visa hur olika fält samverkar, till exempel en rabatt som beräknas utifrån pris och antal. Exempelvärden bör alltid vara lätta att kopiera och klistras in i tester eller demonstrationsmiljöer.