Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Ändrat från mall 3.0 till 4.0
Page Properties

...

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

Excerpt
nameSkapa en yta från mallen
  1. Skapa en ny “tom” yta (space) - se instruktion Create a blank space | Confluence Cloud | Atlassian Support

    1. Se till att namnge ytan med ett lämpligt namn på lösningen, tex applikaitonens namn

  2. Kopiera översiktssidan i mallen - https://jiragu.atlassian.net/wiki/spaces/M3

    1. Select space: välj din nya yta/space

    2. Parent page: välj sidan som heter Home på slutet för din nya yta/space

    3. Include X childe pages: bocka i detta val.

    4. Klicka på Copy.

  3. Sidorna skall ny skapas upp på ytan som pekades ut, i steg 2 ovan.

Åtkomst till lösningens yta

Excerpt
nameÅtkomst

Behörighet till ytan delas ut under Space Settings. Man kan dela ut behörigheter till grupper, eller enskilda individer.

Administratörsrättigheter till ytan

Man bör ha en grupp (Group) som administrerar ytan/spacet.

Skrivrättigheter till ytan

Personer som arbetar inom arkitekturfunktionen, i projekt och förvaltning av lösningen, samt i objektet som lösningen tillhör, bör default alla kunna komma åt att skriva på ytan.

Läsrättigheter till ytan

Personer som arbetar inom arkitekturfunktionen, i projekt och förvaltning av lösningen, i objektet som lösningen tillhör, samt övrig personal som arbetar inom GUSPP, bör default alla kunna komma åt att läsa på ytan.

Enklast är att göra ytan läsbar för alla inloggade användare univeristets Confluencesajt, (dvs gruppen confluence-users).

Sidor som skall underhållas i mallen

...

nameSidor att underhålla

Följande sidor skall underhållas för lösningen:

...

Alla sidor som är markerade som obligatoriska - de listas här ​​.

...

Utöver de obligatoriska sidorna finns även, ett flertal sidor som är “frivilliga” att använda.
Vilka alla dessa är listas på sidan ​​ .

Hur man fyller i mallen

  • Beskrivning: här fyller man i en kort beskrivning av vad sidan innehåller och syftar till.

  • Skall vara ifylld *: här visas en statusetikett för om sidan anses vara FRIVILLIG eller OBLIGATORISK. Ändra inte innehållet i denna för sidor som kommer i mallen, utan låt det värde stå som finns på sidan.

    • Obligatorisk sida = sidan skall ha information eller länk till annan plats där informationen lagras. Att sidan är obligatorisk indikerar att detta är information som skall finnas beskriven om lösningen.

    • Frivillig sida = sidan är INTE obligatorisk - utan frivillig att använda. Om motsvarande information finns någon annanstans, så kan man med fördel länka till denna sida istället. Eller så kan man helt ta bort sidan om man vill. Det kan tex handla om information som inte är relevant för systemet, tex information kring underhållsrutiner om systemet driftas som en molntjänst.

  • Lösning : här anges länken till själva ytan för lösningen, tex https://jiragu.atlassian.net/wiki/spaces/M3.

  • Status på sidan: här skall det finnas en statusetikett som visar på sidans status. Ange /Status så hittar Confluence makrot statusetikett att infoga. Någon av följande statusar anges, gärna med dessa färgkoder också
    Excerpt
    nameSidor att underhålla

    Generella riktlinjer

  • Omfattande information går bra att bryta ner i undersidor så länge som man länkar från rätt stycke på toppnivån.

  • Ta inte bort sidor och rubriker, det ska gå att utläsa att man beaktat sidan eller stycket även när det saknas relevant information att fylla i. Skriv N/A eller en kort kommentar om varför information inte är relevant.

  • Ta inte bort information om olika lösningsförlag - utan arkivera det. Information om hur man hanterar borttag kan man läsa under avsnittet https://jiragu.atlassian.net/wiki/spaces/PA/pages/2726232305/Mall+3.0+Anv+ndarhandbok#Ta-bort-information.

    Sidegenskaper

    Högst upp på de flesta sidor, finns en ruta med något som kallas för sidegenskaper. Genom att fylla i information i denna ruta så kan man lista detta innehåll om flera olika sidor på en annan sida.

    Beskrivning

    Här finns information om lösningens risk- och sårbarhetsanalys

    Skall vara ifylld *

    Status
    titleOBLIGATORISK

    Lösning

    https://jiragu.atlassian.net/wiki/spaces/M3

    Status på sidan

    Status
    colourRed
    titleBEHÖVER SES ÖVER

    Beskrivning

    På denna sidan finns informaiton om hur man underhåller informationen på en sida som är skapad utifrån lösningsdokumentation https://jiragu.atlassian.net/wiki/spaces/M3 .

    Status på sidan

    Status
    colourGreen
    titlePUBLICERAD

    Innehållsförteckning

    Table of Contents

    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
    nameSyfte och målgrupp

    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)

    Image Removed

    Mallens struktur och innehåll

    ...

    nameStruktur 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
    nameLivscykel

    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.

    Sidornas struktur

    ...

    nameSidstruktur

    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.

    ...

    informatiton om vad Mall 4.0 är och syftar till, samt anvisningar kring hur mallen används.

    Status på sidan

    Status
    colourGreen
    titlePUBLICERAD

    ​ = sidan är publicerad
    Status
    colourGreen
    titleAutomatisk
    = används på sidor som anses “färdiga” och publicerade redan av mallen
    Status
    colourYellow
    titlePÅBÖRJAD
    ​ = sidan är påbörjad men ännu inte helt klar för publicering
    Status
    colourRed
    titleBEHÖVER SES ÖVER
    ​ = sidan är publicerad men behöver ses över
    Status
    titleARKIVERAD
    ​ = sidan är arkiverad (dvs inte längre aktuell)

    Instruktionstext och exempel i mallen

    Instruktionstext och exempel i mallen är definierade som informationsrutor likt denna:

    Info

    Instruktionstext som ska tas bort när man fyller i mallen med faktisk information.

    Instruktionstext tas bort. Exempel ersätts med faktisk information utan informationsruta.

    Värden som skall ersättas i mallen

    Värden som ska ersättas med faktiskt information står mellan <>, till exempel < ange xx >.

    As-is och To-Be

    Om man har scenarior och lösningsförslag för inte bara nuläget (as-is) utan också för framtida målbilder - börläge - to-be, så kan det vara bra att även informera om as-is scenarios/lösningar.

    Man kan med fördel placera as-is scenarios i makrot Expand, likt följande exempel

    Image Removed

    To-be scenarios som förkastas, flyttas till arkivet och as-is ligger kvar men behöver ingen rubrik för “as-is”.

    När as-is scenarios implmenteras så kvarstår enbart dessa beskrivna, och As-is flyttas till arkivet,

    Ta bort information

    Excerpt
    nameTa bort information

    Man skall inte ta bort information om olika lösningsförlag.

    Utan allt skall sparas under en arkivsida /wiki/spaces/M3/pages/2694710037.

    Anledningen till att det skall arkiveras, och inte tas bort, är att man vill kunna gå tillbaka och förklara varför man inte slog in på den ena eller andra vägen. Syftet är att spara tid i situationer där gamla beslut ifrågasätts. Då ska det finnas dokumenterat varför man valde eller inte valde ett visst spår.

    Använd etiketter (Label) på sidor

    Excerpt
    nameEtiketter

    Om du vill kunna hitta eller generera listor av sidor med en viss etikett, så kan du sätta eller lägga till etiketter på en sida. Det enklaste är att skrolla längst ned på sidan och klicka på etikett-ikonen till höger och lägga till den eller de etiketter du vill.

    Läs mer om hur man använder etiketter på Confluence hjälpsidor.

    Information som behöver kompletteras eller inte stämmer

    ...

    nameOfullständig information

    När du upptäcker att information är felaktig eller saknas på en sida

    Om information behöver uppdateras, så kan du ange texten <TODO> vid texten. Det går bra att markera text som behöver kompletteras eller som inte stämmer med hjälp av t.ex. rödtext eller kursiv text.

    Märk också sidan med etiketten (label) todo på sidan - se information om hur man lägger till etiketter i Confluence hjälp.

    Samt ändra Status på sidan till

    Status
    colourRed
    titleBEHÖVER SES ÖVER
    .

    Lista vilka sidor som har taggats med att information saknas eller är felaktig

    Sidor som taggats med etiketten todo dyker upp i listan på sidan /wiki/spaces/M3/pages/2694710123.

    Rätta uppgifter som markerats saknade/felaktiga

    Om du stöter på texten <TODO> på en dokumentationssida så bör den saknade informationen skrivas dit.

    ...

    Innehållsförteckning

    Page Properties Report
    firstcolumnSidans namn
    headingsBeskrivning
    sortBySortering
    cqllabel = "mall3_0" and space = currentSpace ( ) and parent = "2726232305"