Att Skapa Bra Utåtriktad Dokumentation : Stöd för utveckling av dokumentationspolicy

Sammanfattning: Extern dokumentation finns till för att förklara för en slutanvändare hur ett verktyg fungerar och hur det bör användas. Att skriva dokumentation tar dock tid vilket kan leda till att vissa utvecklare väljer att avstå från detta. Dokumentationen kan sedan bli eftersatt eller sakna relevant information vilket kan leda till att vissa väljer att inte läsa den. För att ta reda på vad utvecklare önskar av dokumentation och hur man kan stötta dem vid skapandet av det skapades en enkät. Två intervjuer utfördes även som stöd för att komma på frågor samt alternativ till enkäten och delvis svara på frågeställningarna. En litteraturundersökning utfördes av samma anledning. Enkäten delades ut till de med en i undersökningens stund anställning som utvecklare och delades även på internet. 22 deltagare svarade på enkäten och efter en analys av det totala resultatet drogs följande slutsatser: De viktigaste egenskaperna som dokumentation bör besitta anses vara att den ska vara aktuell och utförlig. Den viktigaste typen av innehåll anses bland annat vara kodexempel på vanliga användningsområden. Förslag på stöd eller hjälp för skaparna av dokumentation är att de bör se det som en iterativ process. När dokumentation ska publiceras ansågs en README-fil på Github vara lämpligast. Om något komplext dokumenteras kan en separat hemsida vara mer lämplig.