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.
Sidornas struktur
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.
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 * | OBLIGATORISK |
Lösning | |
Status på sidan | BEHÖVER SES ÖVER |
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å
PUBLICERAD = sidan är publicerad
AUTOMATISK = används på sidor som anses “färdiga” och publicerade redan av mallen
PÅBÖRJAD = sidan är påbörjad men ännu inte helt klar för publicering
BEHÖVER SES ÖVER = sidan är publicerad men behöver ses över
ARKIVERAD = sidan är arkiverad (dvs inte längre aktuell)
Instruktionstext och exempel i mallen
Instruktionstext och exempel i mallen är definierade som informationsrutor likt denna:
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
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,