Begrepskatalog
Forklaring på statuser
Aktiv = Anses som "klart til bruk". Definisjon av begrepene med denne statusen er enten validert av sektorbrukere eller uendret fra eksisterende bruk av begrepet i våre produkter.
Utkast = Foreslått begrep og definisjon. Begrepet er ikke validert av sektorbrukere.
Begrepskatalog - Hva og hvorfor?
Katalogen inneholder definisjoner av begreper som brukes i og understøttes av FS, Admissio (opptaksløsninger) og Sikts utdanningsregistre.
Katalogen er en del av den felles utviklingsplattformen for produktområde Studieadministrasjon i Sikt, og inneholder begreper og definisjoner for det studieadministrative forretningsområdet vi leverer støtte til.
Formålet med katalogen er å skape felles kontekst og forståelse av begreper i våre løsninger, og at de samme begrepene brukes likt i brukerflater, API, dokumentasjon og datamodell. Dette er så vi unngår forvirring for interne utviklingsteam, eksterne utviklingsteam og for virksomheter og brukere som benytter seg av våre produkt.
Det er et mål at innholdet i begrepskatalogen skal kunne deles med Felles Datakatalog over tid.
- Vi i produktområdet bruker denne felles referanserammen som grunnlag for både it-utvikling og forretningsutvikling.
- Vi jobber iterativt etter prinsippet om at det er bedre med en mangelfull beskrivelse som vi kan motta tilbakemeldinger på, enn ingen beskrivelse i det hele tatt.
Prinsipper for valg av begreper
- Begreper bør korrespondere med vanlig norsk språkbruk
- Begreper bør følge sjargongen i utdanningssektoren (studieadministrativ fagterminologi)
- Ett begrep for én ting
- Tekniske termer (f.eks. datastrukturtermer) kan velges der det er et særlig behov for presisjon, og det ikke finnes et eksisterende etablert begrep for konseptet begreper beskriver.
Hvordan bidra til katalogen
Alle kan medvirke til utviklingen av katalogen. Arbeidsprosessen vi legger opp til baserer seg på at produktområde Studieadministrasjon har det redaksjonelle ansvaret.
Vi tar imot endringsforslag som merge requests. En merge request (MR) er et forslag for å inkorporere endringer som leverer som en form for redigert kopi av opprinnelig tekst.
Prosess for å gi tilgang til eksterne brukere er under utarbeidelse, vi vil oppdatere denne siden med mer info når det foreligger. Inntil videre må eksterne brukere melde endringsforslag til kontakt@sikt.no
Krav til format
Beskrivelser i katalogen skrives i Markdown (CommonMark) og publiseres offentlig.
Hvilken informasjon (innhold og metadata) må med i katalogen?
Kjente problemer med løsningen
Det er dessverre noen begrensninger i publiseringsverktøyet vårt som vi ikke har løst enda.
- Vi må sette feltene /slug/ og /title/ for at dokumentene skal få riktig URL og tittel.