1. Definiera dokumentets identitet
Skriv ner titel, syfte, målgrupp, språk och vad dokumentet gäller. Lägg till utgåva eller giltighetsuppgift när verksamheten använder det. Datum för uppladdning är inte automatiskt samma sak som godkänd dokumentversion. Be innehållsansvarig avgöra vilken uppgift som identifierar rätt utgåva.
I övningen heter resursen Installationsanvisning för modell A, svensk utgåva 2. Ta även fram en engelsk version och en äldre svensk utgåva. Kan någon skilja dem åt utan att öppna filerna? Om inte behöver presentationen mer precisa uppgifter.
2. Bestäm vad en stabil länk ska betyda
En länk kan syfta på en bestämd historisk utgåva eller på den aktuella resursens presentationssida. Skriv ner vilket beteende som behövs innan filer ersätts. Äldre projektdokumentation kan behöva hänvisa till exakt den utgåva som användes då.
Kontrollera vad CMS faktiskt gör när en fil ersätts: ändras adressen, skrivs innehållet över eller skapas en ny fil? Utgå inte från filnamnet. Testa i förhandsvisning och behåll en separat känd kopia för övningen.
| Fält | Vad besökaren behöver veta | Ansvarig kontroll |
|---|---|---|
| Titel | Vilket dokument det är | Skiljer sig från liknande filer |
| Språk | Vilken version som kan läsas | Stämmer med filens innehåll |
| Utgåva | Vilken version som gäller | Godkänd av innehållsansvarig |
| Länk | Vad som hämtas | Testad från den publicerade sidan |
3. Beskriv innehållet vid nedladdningen
Använd en länk som exempelvis Installationsanvisning modell A, utgåva 2, PDF. Visa storlek när den är känd och språk när det kan vara oklart. Uppgifter om format och storlek behöver stämma med den fil som faktiskt levereras.
Låt nödvändiga instruktioner finnas på webbsidan också, om besökaren behöver dem för att välja dokument. En nedladdningsknapp bör inte vara den enda förklaringen till vad filen innehåller. Kontrollera att länken kan nås och förstås med tangentbord.
4. Öva ett versionsbyte från början till slut
Publicera en markerad testutgåva i en säker miljö. Följ länkar från översikt, relaterade sidor och eventuella andra språk. Hämta filen och kontrollera dess innehåll, inte bara att servern svarar. Leta efter gamla versionsnamn i kort och beskrivningar.
Låt en annan person hitta rätt utgåva och dokumentera resultatet. Bestäm hur äldre dokument märks, arkiveras eller tas bort och vem som godkänner beslutet. En URL-ändring behöver dessutom en genomtänkt hantering av tidigare länkar; ta inte bort dem utan genomgång.