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 | ||
---|---|---|
| ||
|
Åtkomst till lösningens yta
Excerpt | ||
---|---|---|
| ||
Behörighet till ytan delas ut under Space Settings. Man kan dela ut behörigheter till grupper, eller enskilda individer. Administratörsrättigheter till ytanMan bör ha en grupp ( Skrivrättigheter till ytanPersoner 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 ytanPersoner 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 |
Sidor som skall underhållas i mallen
...
name | Sidor 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
Excerpt | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Generella riktlinjerOmfattande 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. SidegenskaperHö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 * |
| ||||||
Lösning | |||||||
Status på sidan |
|
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 |
|
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 | ||
---|---|---|
| ||
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.
...
Instruktionstext och exempel i mallenInstruktionstext 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 mallenVärden som ska ersättas med faktiskt information står mellan As-is och To-BeOm 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, |
Ta bort information
Excerpt | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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
...
name | Ofullstä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 | ||||
---|---|---|---|---|
|
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 | ||||||||
---|---|---|---|---|---|---|---|---|
|