Page Comparison

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/M3PA/pages/2694710069#Ta2726232305/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 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å
  

  Status
  colour Green title PUBLICERAD

  ​ = sidan är publicerad
  

  Status
  colour Green title Automatisk

  = används på sidor som anses “färdiga” och publicerade redan av mallen
  

  Status
  colour Yellow title PÅBÖRJAD

  ​ = sidan är påbörjad men ännu inte helt klar för publicering
  

  Status
  colour Red title BEHÖVER SES ÖVER

  ​ = sidan är publicerad men behöver ses över
  

  Status
  title 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 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,

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

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.

Om inget mer saknas på sidan, ta bort etiketten todo på sidan (du hittar information om hur man tar bort etiketter på Confluence hjälp). Så listas sidan inte längre på sidan i /wiki/spaces/M3/pages/2694710123.