Gå till innehållet

Översikt specifikationer

Exakt vad gränserna för vad som menas med en specifikation går kan diskuteras. Dock bör en specifikation som ett minimum innefatta en teknisk beskrivning av hur man ska uttrycka och förstå data.

Det finns många sätt att sätta samman en specifikation och processen att nå dit ligger utanför denna dokumentation. Istället är fokus på hur man tillhandahåller beskrivningar av specifikationer på dataportal.se. Målsättningen är att det skapas en förteckning av tillgängliga specifikationer med syftet att:

  1. Främja vidareutnyttjande av data och API:er.
  2. Ge andra aktörer vägledning hur man ska publicera liknande data.
  3. Bidra till ökad enhetlighet i publicerad data och interoperabilitet mellan datamängder.

Den som vill fördjupa sig kan läsa sektionen om vilka fördelar man har av att jobba med specifikationer.

För att beskriva en specifikation måste du ha en användare på editera.dataportal.se. När du lägger upp en specifikation skapar du en stabil webbadress som kan användas för att referera till specifikationen, t.ex. från en datamängd. Specifikationens dokument kan antingen laddas upp till editera eller länkas till om de redan har en stabil adress någon annan stans.

Vad är en specifikation

Med en specifikation menar vi i huvudsak ett eller flera dokument som i tekniska termer beskriver en informationsmodell.Informationsmodellen bör vara oberoende av både format och hur den implementeras i olika system. I vissa fall inkluderas i specifikationen även beksrivning av ett eller flera format och kanske även de protokoll som används för att få åtkomst till data. Specifikationens huvuddokument består ofta av flödande text blandat med tabeller, diagram (ofta olika UML diagram) och inklippta exempel på datauttryck. En specifikation innefattar även ibland andra former av resurser, t.ex. scheman, profiler, ontologier och relaterade terminologier.

Vem är ett specifikationsdokument framtaget för

Specifikationsdokument är i huvudsak ämnade att läsas av människor, inte maskiner. Utöver informationsmodellen kan dokumentet beskriva bakgrund och motiveringar, t.ex. i form av användarfall / scenarier. Detta för att hjälpa den tekniska läsaren att förstå intentionen bakom de val som gjorts. Utöver specifikationsdokumentet kan det finnas relaterade resurser som scheman, profiler och ontologier. Dessa är dock oftast ämnade för maskinell bearbetning.

Vem tar fram en specifikation

En specifikation kan vara skriven av mer eller mindre erkända standardiseringsorganisationer som ISO, IEEE, Oasis, W3C, SIS osv. men den kan också vara framtagen av domänspecifika intresseorganisationer eller enskilda aktörer som ser ett behov av att vara stringenta och har en förhoppning om att deras arbete ska plockas upp och användas av andra.

För mer information om standarder, se Svenskt ramverk för digital samverkan.

Metadata för en specifikation

Den förteckning som skapas på dataportal.se använder sig av en metadataprofil som bygger i huvudsak på Prof med några extra properties från ADMS och DCAT.