Namnkonventioner för Datakällor, Entiteter och deras fält

Använda Boards on Fire 2023-09-22

Fördelar med att följa namnkonventionerna

Den främsta fördelen med att följa namnkonventionerna nedan är att ni får bättre koll på de datakällor och entiteter ni använder. Om ni består av flera siter på flera orter som alla använder egna datakällor och entiteter blir det även lättare att se vilka som tillhör de olika siterna. Detta blir extra relevant om er organisation är flerspråkig, för att alla som ska administrera tjänsten hos er ska förstå vad de gör. Avslutningsvis så blir det enklare att få data som integreras att synas på rätt plats om det finns en tydlig namnstruktur.

Namn på Datakällor & Entiteter

  • Använd alltid engelska
  • Använd inte specialtecken (med undantag för underscore "_")
  • Använd beskrivande namn för att klart indikera vilken typ av data som ska lagras i datakällan/entiteten. Undvik t.ex namn som "team1_datakälla" eller "kalles_avvikelser_3".
  • Undvik förkortningar eftersom det kan vara svårt för andra att förstå.

Namngivning av fält (namnet på nyckeln)

  • Använd beskrivande namn för att klart indikera vilken typ av data som ska lagras i fältet. Använd t.ex hellre "goal" eller "outcome" än "value_x"
  • Undvik långa namn. Även om beskrivande namn är viktiga, bör du undvika att göra fältnamnen alltför långa. Balansera mellan tydlighet och överskådlighet. Om namnet blir för långt kan det vara svårt att hantera och skapa översikt.

Fältnamn som består av flera ord

När man namnger fält där man vill kommunicera en tillhörighet, börja med tillhörigheten och avsluta med vad det avser. 

Exempel:

  • s_value
  • group_1_goal
  • group_1_value

Standardnamn för entitetsfält

De här namnen rekommenderas att användas där det är tillämpligt. Dessa används av de olika standardtyper av entitet som vi har, t.ex Projektmodulen, Besöksmodulen, enkla entiteter m.m.

Nyckel Datatyp Beskrivning
name String Används för fältet som beskriver entitetsobjektet
description Text Utförligare beskrivning av Entitetsobjektet
responsible User Ansvarig person
start_date Date/Datetime

Ett startdatum/tid av något slag

end_date Date/Datetime Ett slutdatum/tid av något slag
status Status Entitetsobjektets status
tasks TodoList Uppgifter som tillhör entitetsobjektet
position Number Vilken sorteringsordning entitetsobjektet ska ha.
date Date / Datetime Används bl.a. när man vill datummärka ett entitetsobjekt för att kunna filtrera på det.

Gratis webbdemo

Vi kan berätta allt om Boards on Fire. Men det är enklare att visa. En snabb webbdemo ger dig grunderna i våra lösningar.