Redigera en specifikation¶
På Editera uttrycks information om specifikationer med hjälp av egenskaper/fält i huvudsak från profiles vocabulary med några extra egenskaper från ADMS och DCAT.
Nedan listar vi de olika inmatningsfälten med kommentarer om hur man ska fylla i dem.
Specifikationstyp - obligatorisk¶
Här finns två alternativ: 1. Normal - motsvarar en specifikation som är självständig, man kan förstå den genom att läsa dess specifikationsdokument. Specifikationen är inte att betrakta som en variant eller anpassning av en annan specifikation. 2. Profil - motsvarar en specifikation som inte kan förstås utan att man förhåller sig till en annan specifikation som etablerar en bas. En profilspecifikation förtydligar, specialiserar eller anpassar basspecifikationen för att göra den enklare att använda inom ett visst område / kategori av data.
Profil av¶
Obs bara om man angett Profil som specifikationstyp!
Man pekar ut vilken/vilka specifikation(er)/profil(er) som denna profil anpassar. Det går utmärkt att peka ut profiler / specifikationer som hanteras i andra projekt så länge de är publicerade (och därmed synliga för specifikationens redaktör).
Titel - obligatorisk¶
Man bör tillhandahålla specifikationens titel på både svenska och engelska. Då titeln är det som kommer visas i både administrativa gränssnitt såväl som i länkar från datamängder är det viktigt att den är tydlig. Man bör dock inte baka in allting i titeln, t.ex. bör man inte ange vilken organisation som är utgivare då det finns i ett annat fält och kommer visas upp när det finns behov av mer information. Man ska sträva efter att titeln får plats på en rad.
Beskrivning¶
Beskrivningen är en längre text som berättar om specifikationens syfte, vilken data som åsyftas osv. Precis som titeln är det bra att ange beskrivningen på både svenska och engelska. Till skillnad från titeln kan beskrivning vara flerradig.
Identifierare¶
En specifikations webbadress är dess formella identifierare, men i vissa fall kan det även finnas behov av en identifierare som är enklare att referera till i t.ex. flytande text. Exempel på en sådan är identifieraren DCAT-AP-SE2.0.0 för den svenska anpassningen av DCAT-AP2.0.0. Notera att identifieraren ofta är en del av webbadressen för specifikationen.
Utgivare - obligatorisk¶
Vilken aktör som är utgivare av specifikationen. Om du lägger ut en specifikation som tagits fram av eller på uppdrag av din organisation bör den egna organisationen stå som utgivare. Om du däremot lägger upp en specifikation för någon annan organisations räkning, t.ex. en specifikation som tagits fram av en standardiseringsorganisation bör den anges som utgivare. Kontakta supporten om du inte hittar den organisation som du behöver.
Kontakt¶
En kontakt motsvarar en person eller funktion hos en organisation som man kan vända sig till om man har frågor om specfikationen. Det är rekommenderat att använda en funktionsadress.
Har resurs¶
En specifikation består alltid av minst en resurs. Det finns en mängd olika syften med resurs man pekar ut från en specifikation. De roller man kan ange för en resurs är:
- specifikation - detta är själva specifikationsdokumentet som riktar sig till människor som vill förstå specifikationen.
- exempel - resurser som syftar till att ge praktiska exempel på hur data som följer specifikationen kan se ut.
- mappning - en instruktion om hur man överför data från ett format till ett annat, eventuellt också från en specifikation till en annan.
- schema - ett uttryck som är maskinläsbart och beskriver syntax och / eller vilka delar data består av. Ett schema kan beskriva i hög detalj hur datat ser ut eller enbart ge en översiktlig fingervisning vad som finns i datat, det beror på vilken typ av schema som används.
- terminologi - en förteckning av begrepp som används i datauttrycket. Kompletterar ett schema med information om vilka värdemängder som förväntas i vissa delar av datat.
- vägledning - ett textdokument som utöver specifikationsdokumentet ger mer information och ibland även detaljerade instruktioner om hur data ska uttryckas i olika scenarior.
- validering - en resurs som erbjuder validering av data i enlighet med specifikationen, till skillnad från ett schema som är en statisk resurs är en valideringsresurs ofta en webbtjänst eller mjukvara som man kan använda för validering direkt.
Tema¶
Här återanvänder vi de teman som används för kategorisering av datamängder för att göra det enklare att hitta relevanta specifikationer när man beskriver datamängder. Det finns 13 teman som motsvarar breda sektorer som t.ex. miljö, energi, transport. Det är helt ok att markera att en specifikation går att använda inom flera teman. Om en specifikation är av mer generell karaktär, som t.ex. en specifikation av dataformatet JSON eller XML, så är det bättre att inte markera med något tema alls än att välja något som känns krystat.
Nyckelord¶
De 13 teman som man kan välja är väldigt breda och bör komplettera med mer specifika nyckelord. Precis som för tital och beskrivningar är det bra att tillhandahålla samma nyckelord på både svenska och engelska.
Utgivningsdatum¶
Det datum då specfikationen gavs ut. Om specifikationen har kommit ut i flera versioner är det den nuvarande versionens utgivningsdatum som åsyftas.
Ändringsdatum¶
Om en specifikation ändras över tid så ska man ange senaste ändringsdatum. Det är också lämpligt att ha en ändringslogg, t.ex. i den resurs som motsvarar själva specifikationsdokumentet. Om specifikationen kommer i olika versioner bör man ha endast ett utgivningsdatum och eventuellt relationer till tidigare, senare och senaste version, se dessa fält nedan.
Status¶
En specifikation kan genomgå olika faser, följande faser kan man markera:
- Under utveckling - i detta läge bör man inte använda specifikationen, men det kan vara intressant för andra att se att det pågår ett arbete att ta fram en specifikation, därför kan specifikationen ändå vara publicerad.
- Färdig - specifikationen har nått en viss mognad och kan användas, dvs det är fritt fram att uttrycka data i enlighet med vad specifikationen säger. Man kan förvänta sig att eventuella ändringar av specifikationen kommer tydligt markeras eller dyka upp i en ny version av specifikationen.
- Avvecklad - specifikationen är inte lämplig att använda längre, eventuellt finns det en senare version som man ska använda istället.
- Tillbakadragen - specifikationen är olämplig att använda, antingen på grund av allvarliga feltänk eller på grund av att arbetet med att ta fram den avbröts till fördel för ett annat angreppsätt. En specifikation som varit publicerad, markerats som färdig och börjat användas bör aldrig markeras som tillbakadragen, det räcker med att markera den som avveckad.
Föregående version¶
Med denna relation kan man peka ut en föregående specifikation. En föregående version hanteras oftast i samma projekt, men man kan också peka ut en version i ett annat projekt.
Nästa version¶
Med denna relation kan man peka ut den nästa version av specifikation. Nästa version hanteras oftast i samma projekt, men man kan också peka ut en version i ett annat projekt.
Senaste version¶
Med denna relation kan man peka ut den senaste versionen av specifikation. Senaste versionen hanteras oftast i samma projekt, men man kan också peka ut en version i ett annat projekt.