Gå til hovedinnhold

Prinsipper for navngiving av felter og typer

Vi navngir felter og typer på en måte som gjør det enkelt for brukeren å forstå hva de representerer. Dette innebærer at vi følger prinsippene beskrevet nedenfor.

Bruk norsk for domenebegreper og dagligspråk, engelsk for tekniske begreper​

Vi tilstreber å bruke naturlig norsk språk for ikke-tekniske begreper. Vi oversetter derfor ikke domenebegreper til engelsk, men vi benytter engelsk der det er naturlig for tekniske begreper.

For domenebegreper bruker vi standardisert terminologi der det er mulig. Våre hovedkilder til terminologi er begrepskatalogen og Universitets- og høyskolerådets termbase.

ÆØÅ oversettes til AOA, bortsett fra der det kan skape misforståelser. I så fall brukes AE, OE og AA. For eksempel blir "mål" til "maal", heller enn "mal".

Vi bruker fuge-s der det er naturlig ved sammensetning av norske ord, men ikke der vi har sammensetninger av et domenebegrep/dagligtalebegrep og et teknisk begrep. Eksempelvis skriver vi institusjonskode med fuge-s, men institusjonId uten fuge-s.

Bruk naturlig ordrekkefølge​

Vi prøver å bruke en ordrekkefølge som ligger nær norsk dagligtale i sammensatte ord. For eksempel foretrekker vi fraDato fremfor datoFra.

Unngå forkortelser​

Vi unngår å forkorte ord der det er mulig, selv om det medfører lange feltnavn. Dette gjør det enklere for brukeren å forstå hva feltet representerer. Akronymer og forkortelser som er godt kjent i bransjen er imidlertid tillatt.

Bruk lowerCamelCase for å skille mellom ord​

Vi bruker lowerCamelCase for å skille ord der vi på norsk ville satt mellomrom eller bindestrek. Et akronym eller en forkortelse regner vi som ett ord i denne sammenhengen, dvs. heller rapportertTilNsd enn rapportertTilNSD.

Feltnavn som indikerer språk, skal bruke språkkode etter offentlig standard​

Feltnavn som inneholder en språkkode skal følge DigDirs standard for bruk av språkkoder på offentlige nettsider. I praksis betyr det at vi bruker den korteste tilgjengelige språkkoden fra ISO 639-standardene for språket. Eksempelvis bruker vi nb for bokmål og nn for nynorsk, men und for udefinert språk.

Boolean-felt navngis med verb​

Boolean-felt bør ha verb for å tydeliggjøre at feltet har en Boolean-verdi. Et felt som representerer om en bruker er aktiv, bør for eksempel hete erAktiv fremfor aktiv.

Vi samsvarsbøyer normalt ikke statuser​

Et feltnavn som angir om et objekt er aktiv vil for eksempel normalt hete erAktiv, også for objekter der typenavnet grammatisk angir intetkjønnsform.