Dokumentstrukturer

M˚anga f¨orekommande praktiska problem vid dokumentation kan d¨armed l¨osas med ovan n¨amnda f¨orslag, men f¨or att uppfylla un- derh˚allbarhet kr¨avs stabila och effektiva dokumentstrukturer. Un- ders¨okningen visade att tv˚a olika l¨osningar var av intresse. Den f¨orsta dokumentstrukturen har fokus p˚a enkelhet medan den andra p˚a en mer komplex struktur f¨or att erh˚alla en kvalitativ h˚allbarhet. Det som ¨ar gemensamt i b˚ada l¨osningarna ¨ar att om det ing˚ar flera dokument i ett projekt ska det utf¨ardas generella och ut¨okningsbara mallar f¨or flera eller samtliga dokument. Detta f¨or att snabbare kun- na f¨or¨andra n˚agot som man vill ska p˚averka dokumenten.

Mer specifikt best˚ar den f¨orstn¨amnda av en enkel och mindre djup tr¨adstruktur av mappar f¨or att organisera filer med dokumentets delar. Detta f¨or att samtliga delar ska vara ˚atkomliga inom ett eller tv˚a klick. F¨or att erh˚alla denna struktur beh¨over samtliga filer d˚a vara l¨angre, vilket st¨aller krav p˚a att redigeraren ¨ar bekv¨am med att oftare rulla upp och ner i dokumentets delar. Vidare ¨ar denna struktur f¨orl˚atande f¨or eventuell felplacering av n˚agon del.

Den andra l¨osningen best˚ar av en mer komplex och djup tr¨adstruktur. I denna variant sker det en f¨orgrening f¨or varje kapitel och avsnitt f¨or att minimera beroendet mellan varje enstaka del i dokumentet. Dock st¨aller det ist¨allet krav p˚a att redigeraren ¨ar bekv¨am med och snabb p˚a att identifiera de aktuella beroendena mellan samtliga de- lar f¨or att uppn˚a en effektiv navigering. Vidare ¨ar denna struktur mer k¨anslig f¨or felplaceringar ¨an den f¨orsta.

N¨ar det g¨aller unders¨okningen kring detta ¨ar det ¨aven v¨art att n¨amna att en ˚aterkoppling ¨agde rum. Detta var d˚a avsett f¨or de som antydde att man f¨orstod fr˚agorna genom att ge ett informa- tivt svar. Under denna ˚aterkoppling framgick det att dessa personer hade f¨orst˚att fr˚agorna genom en muntlig diskussion.

D.6 Diskussion

Fr˚an unders¨okningen framgick det att man f¨oreslog en av tv˚a ovan n¨amnda l¨osningar beroende p˚a vanor. Vissa i projektgruppen var mer vana med att hantera mindre textm¨angder ˚at g˚angen och f¨ored- rog d¨armed en djupare tr¨adstruktur medan andra k¨ande sig mer be- kv¨ama med det motsatta. F¨or att finna en l¨osning som passar samtli- ga medlemmar i projektgruppen skulle dessa kunna kombineras. F¨or att str¨ava efter ett effektivt arbete med fokus p˚a h˚allbarhet kan man till exempel anv¨anda den enkla och mindre djupa tr¨adstrukturen f¨or mindre dokument och den andra f¨or mer omfattande.

Det ¨ar ¨aven viktigt att anpassa denna kombination till hur pro- jektmedlemmarnas ˚asikter f¨orh˚aller sig till varandra. Genom att l˚ata f¨ordelningen mellan dessa ¨onskade l¨osningar styra vilken som ska do- minera kan man erh˚alla ett mer r¨attvist och bekv¨amt arbete. D¨arf¨or skulle projektgruppen, exempelvis i slutet av dokumentationsutbild- ningen, kunna ha en gemensam diskussion eller unders¨okning om vilka dokumentstrukturer man arbetar effektivt med. Med hj¨alp av detta kan man d˚a utforma en skr¨addarsydd dokumentationsstrategi som undviker m˚anga problem som har n¨amnts tidigare.

Dessutom ¨ar det v¨art att n¨amna att unders¨okningen i sig ¨aven har varit en komplexitetsfaktor. Vissa av fr˚agorna som handlade om do- kumentstrukturer uppfattades som otydliga eller sv˚ara att f¨orst˚a. Vidare var det inte m˚anga svar p˚a de fr˚agor som ans˚ags tydliga eller l¨attare att f¨orst˚a. Detta har lett till att man har beh¨ovt tolka svaren f¨or att finna m¨onster. Unders¨okningen skulle med andra ord kunnat ha ett st¨orre omf˚ang n¨ar det g¨aller antalet deltagare och enkla och inte alltf¨or ¨oppna fr˚agor. D˚a hade f¨ormodligen olika ˚asikter framg˚att tydligare, vilket resulterat i ett mer p˚alitligt resultat.

D.7 Slutsatser

Syftet med detta individuella bidrag var att analysera vilka praktis- ka problem som har identifierats vid dokumentation i onlinetj¨ansten ShareLaTeX och vilka l¨osningar som finns p˚a det. Vidare innefatta- de det huruvida man ska organisera dokumentation i ShareLaTeX f¨or att erh˚alla en kvalitativ dokumentstruktur. Unders¨okningen har besvarat detta och man kan dra slutsatser kring fr˚agest¨allningarna enligt f¨oljande:

1. Det har och kan uppst˚a m˚anga olika problem inom inl¨arning, programmering och erfarenhet. Vidare finns det l¨osningar som baseras p˚a att f˚a kunskap och erfarenhet kring dessa problem, men ibland kan ett problems ursprung begr¨ansa vilka ˚atg¨arder som ¨ar m¨ojliga.

2. Det beh¨ovs en skr¨addarsydd dokumentstruktur f¨or varje spe- cifikt projekt och projektgrupp, vilket kan utformas med hj¨alp av en intern diskussion eller unders¨okning. Det har d˚a visat sig mynna ut i en kombination av tv˚a tr¨adstrukturer f¨or map- par och filer d¨ar den ena ¨ar enkel och mindre djup medan den andra mer komplex och djup. F¨or att b¨attre svara p˚a denna fr˚agest¨allning skulle det dessutom beh¨ovas en mer omfattande unders¨okning.

E

Petter Granli - Automatiserad drifts¨attning

av kod f¨or webbapplikationer

Detta kapitel inneh˚aller den individuella delen skriven av Petter Granli som behandlar automatiserad drifts¨attning. Delen inleds med att presentera omr˚adet, syftet och fr˚agest¨allningen f¨or delen. Forts¨att- ningsvis behandlas bakgrund, teori och metod f¨or unders¨okningen. Delen g˚ar vidare med ett resultat och en diskussion och avslutas i en sammanfattning.

E.1 Inledning

Vid arbete med webbapplikationer ¨ar det ofta viktigt att snabbt f˚a ut uppdaterad kod i produktion, dels ur ett s¨akerhetsperspektiv, t.ex. d˚a den uppdaterade koden ¨ar t¨ankt att t¨appa till s¨akerhetsh˚al, dels f¨or att nya funktioner ska n˚a ut till kunder p˚a en h˚art kon- kurrensutsatt marknad. Att manuellt uppdatera kod p˚a servrar kan vara mycket tidskr¨avande och riskabelt om det g¨ors p˚a fel s¨att. Det finns tj¨anster och verktyg som automatiskt s¨atter webbapplikatio- ner i produktion och som naturligt integreras med ett git-baserat arbetsfl¨ode.

E.1.1 Syfte

Syftet med denna individuella del ¨ar att klarg¨ora hur ett webbappli- kationsprojekt kan dra nytta av en automatiserad uppdatering av kod hos servrar i produktion.

E.1.2 Fr˚agest¨allningar

1. Vad kan ett projekt tj¨ana p˚a att anv¨anda sig av automatiserad drifts¨attning?

2. Passar en tj¨anst som Heroku f¨or utveckling av sm˚a webbappli- kationer?

3. Vilka begr¨ansningar finns det vid anv¨andning av automatiserad drifts¨attning?

E.2 Bakgrund

I det h¨ar projektet har gruppen utvecklat en webbapplikation och beh¨ovde s˚aledes k¨ora den skrivna koden p˚a en server. Gruppen st¨alldes d˚a inf¨or ett dilemma: Ska alla gruppmedlemmar ha tillg˚ang till denna server och sj¨alva uppdatera koden n¨ar den ¨ar redo eller ska detta arbete delegeras till en person eller del av gruppen? Att konti- nuerligt manuellt uppdatera kod som k¨ors p˚a en server kan medf¨ora komplikationer som ¨ar kopplade till den m¨anskliga faktorn. Ansva- rig person kan t.ex. gl¨omma att uppdatera eller beg˚a ett misstag vid uppdatering.

E.3 Teori

I den h¨ar delen presenteras dels definitioner av olika molntj¨ansttyper, dels verktyg som kan anv¨andas f¨or drifts¨attning av kod samt leve- rant¨orer av dessa verktyg och molntj¨anster.