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) Lösning för att lätt kunna sortera ut lösningar i Spaces - Confluence (atlassian.net)

Mallen är indelad i följande övergripande sidor. Alla delar är idag inte obligatoriska att använda vilket framgår i tabellen nedan.

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

• Man startar i förstudie och fyller i så djupt man kan. Här kan as-is och to-be scenarier finnas med i olika stycken. Det kan också finnas olika varianter av lösningsförslag.

• Man utvecklar framförallt lösningsarkitekturen under projektets gång. Lösningar som förkastas flyttas till arkivsidan för att uppnå spårbarhet. I slutet av projektet kvarstår bara de implementerade lösningarna. As-is flyttas till arkivet, to-be ligger kvar men behöver ingen rubrik för “to-be”.

• Man påbörjar förvaltningsinformationen under projektet och dokumenterar löpande så att informationen växer fram successivt som en del av lösningen.

• Vid överlämning till förvaltning kontrolleras att deploymentdiagram och driftsinformation är korrekta.

• Dokumentationen underhålls löpande vid normalt systemunderhåll. Kommer nya målbilder om framtida lösningar, kan det vara aktuellt att införa as-is och to-be scenarios igen.

• Nya projekt som berör lösningen dokumenteras normalt i samma i Confluenceyta (space). Skapar man en helt ny lösning som ersätter den gamla skapar man en ny yta för den nya lösningen och arkiverar den gamla ytan när man pensionerat den gamla lösningen.

De flesta sidor har en liknande struktur. Nedan beskrivs de element som oftast ingår på en sida.

1. Sidans namn / titel

2. 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.

   

3. 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.

4. Om sidan skall innehålla innehåll, läggs detta efter stycket och linjen enligt punkt 3 ovan.

5. 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.

6. 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.