| Page Properties | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Innehållsförteckning
| Table of Contentsdetailssummary |
|---|
Inledning
Här finns anvisningar om vad https://jiragu.atlassian.net/wiki/spaces/M3 är och hur man använder mallen.
Hur man hittar mallen
Mallen finns i Confluence på ytan https://jiragu.atlassian.net/wiki/spaces/M3 .
Syfte och målgrupp för mallen
| Excerpt | ||
|---|---|---|
| ||
https://jiragu.atlassian.net/wiki/spaces/M3 är en mall för en yta/site för hela lösningsdokumentationen, allt från arkitektur, förvaltning och projekt. Dokumentationen beskriver lösningen och ska underhållas löpande. Mallen utgör en struktur för att man ska känna igen sig och hitta information på samma ställe i olika lösningar. Mallen skall användas för lösningar inom GUSPP-förvaltningen, dvs både inom projekt eller förvaltning kring lösningar och applikationer. Primärt används den idag för att dokumentera arkitekturen för en lösning, både under införande (projekt) och efterkommande förvaltningsfas. Mallens version finns angiven på ytan översiktssida Overview, i tabellen, raden Mall. Alla Confluenceytor som rör lösningar är taggade med Label (kategori)  |
Mallens struktur och innehåll
...
| name | Struktur och innehåll |
|---|
Mallen är indelad i följande övergripande sidor. Alla delar är idag inte obligatoriska att använda vilket framgår i tabellen nedan.
...
Övergripande sidor i mallen
...
Beskrivning
...
Obliga-torisk att fylla i
...
Överblick/Overview
...
Startsida för lösningen
...
Ja
...
Arkitektur
...
Arkitekturbeskrivningen. Lösningsdokumentationen följer övergripande alla de lager i arkitekturen som beskrivs i https://jiragu.atlassian.net/wiki/spaces/GA.
...
Ja
...
Användarhandbok
...
Sida med ingångar till användarhandböcker
...
Ja
...
Krav
...
Den samlade kravbilden, som hanteras under en egen sida så att kravbilden kan underhållas över tiden.
...
Ja
...
Projekt
...
Information om projekt och inititativ för lösningen. Det är avgörande att separera projektinformation från lösningsinformation. Projekt dör efter hand, men lösningen består. Det är ok att dokumentera projektinformation, men detta ska ligga under sidan Projekt.
...
Nej
...
Förvaltning
...
information som behövs för att förvalta och drifta lösningen.
Genom att dokumentatera via Förvaltning och Arkitektur, kan man underhålla samma information som man gör i wiki.it.gu.se.
...
Nej
...
Risk- och sårbarhetsanalys
...
Information om lösningens risk- och sårbarhetsanalys
...
Ja
Lösningens livscykeln - håll dokumentationen uppdaterad
| Excerpt | ||
|---|---|---|
| ||
Det är naturligtvis viktigt att dokumentationen är aktuell och korrekt. Därför ingår det i samtliga projekts och förvaltningspersonals uppgifter att rätta fel och ändra dokumentationen när lösningen ändras. Lösningar är inte statiska utan förändras kontinuerligt. Därför är det viktigt att se dokumentationen som en del av lösningen och säkerställa att den hänger med i förändringen. Tanken är därför att informationen ska vara levande
|
Sidornas struktur
...
| name | Sidstruktur |
|---|
De flesta sidor har en liknande struktur. Nedan beskrivs de element som oftast ingår på en sida.
Tips! Om du skapar egna sidor kan det vara bra att utgå från en mallsida för att få med olika element på sidan.
...
Sidans namn / titel
På varje sida infogas med fördel generell sidinformation.
Sidinformationen läggs inom ett makro som heter Page properties, som gör att man kan hämta ut denna information och visa på andra sidor.
...
...
Under sidinformationen, placeras när det är tillämpligt en innehållsförteckning, här anges texten Innehållsförteckning (i formatet Normal) med fet stil. Och så infogas antingen innehållsförteckning för sidan, eller en lista över undersidor.
Efter innehållsförteckningen placeras en linje - via makrot Divider.
...
Om sidan skall innehålla innehåll, läggs detta efter stycket och linjen enligt punkt 3 ovan.
...
Om det är tillämpbart, så kan man på slutet av sidan lägga in relaterat innehåll, via makrot Content by Label. I makrot anges man vilket/vilka labels man vill innehåll skall visas för. Se till att bocka ut “Show Labels for Each Page” och “Show Space Name for Each Page”.
Se till att ha en linje - via makrot Divider ovanför Content by Label.
...
Längst ner på sidan till höger, visas eventuella Labels som är satta för sidan. Läs mer om hur man använder etiketter på Confluence hjälpsidor.
Hur man skapar en yta från mallen
...
| name | Skapa en yta från mallen |
|---|
...
Skapa en ny “tom” yta (space) - se instruktion Create a blank space | Confluence Cloud | Atlassian Support
Se till att namnge ytan med ett lämpligt namn på lösningen, tex applikaitonens namn
...
Kopiera översiktssidan i mallen - https://jiragu.atlassian.net/wiki/spaces/M3
Select space: välj din nya yta/space
Parent page: välj sidan som heter Home på slutet för din nya yta/space
Include X childe pages: bocka i detta val.
Klicka på Copy.
...
|