Höstens Digpro Lab ämnade utforska användardokumentation – hur verktygen för att skapa den kan förbättras, och hur det följaktligen kan bli lättare för användarna av vårt nätverksinformationssystem (NIS) att ta till sig informationen.
Lina Lokander, Technical Writer, tillsammans med Christer Folkesson, Senior Developer, och Pontus Lindström, Head of QA, initierade höstens Digpro Lab. Hon tillbringade en intensiv vecka tillsammans med Christer och utvecklarna Emiliano Kloster, Radha Ravi och Jakob Kratz. Digpro Lab-teamet får en egen plats på kontoret, samt obegränsade tillgångar till snacks och drycker. Vanliga arbetsuppgifter läggs på paus, och allt fokus är på att utforska projektet genom att ställa frågor och hitta svar.
Tre områden att utforska
”Vi hade tre huvudområden där vi ville konceptbevis”, berättar Lina. ”För det första ville vi ha ett nytt och modernt sätt att bygga systemet för användarguiden. För det andra ville vi ta reda på om vi kunde använda GITs versionshantering för det dokumentationsverktyg som vi använder idag. För det tredje strävade vi efter att hantera ‘diffs’, detta för att stödja personerna som granskar de texter vi skriver.”
För det första området hittade utvecklarna ett system som skulle uppfylla kraven för den komplexa användarguiden. Ett antal nyckelkoncept identifierades, anpassades efter Digpros behov och stresstestades därefter. För den andra delen utforskades möjligheten att använda GIT för versionskontroll.
”Det här området visade sig vara helt perfekt, och nu kommer jag att kunna använda samma versionskontroll för den tekniska dokumentationen som utvecklarna gör för sin kod”, strålar Lina. ”Och för det tredje området är jag nöjd med att det nu kommer att vara lättare för alla att granska texter.”
Med lite kärlek från utvecklarna är förändringar i användarguiden nu tydligt synliga.
”Vår tekniska dokumentation är skriven i XML eller HTML”, förklarar Lina. ”Och nu konverteras alla ändringar till ‘snippets’ där färger indikerar redigeringarna. Ny text markeras i grönt, och borttagen text markeras i rött samt markeras med ett streck över. Därmed blir det mycket enklare för korrekturläsarna att veta vad de ska fokusera på.”
Förbättringar för användarguiden
Sammanfattningsvis är Lina mycket nöjd med Digpro Lab-veckan.
”Användarguiden är en viktig del av de tjänster vi tillhandahåller. Det var verkligen lyxigt att ha fyra så kompetenta utvecklare som ägnade sin kunskap och innovation åt den tekniska dokumentationen. Att se dem arbeta var imponerande. Ena sekunden är de fördjupade i livliga diskussioner. Nästa är de försjunkna i egna uppgifter framför sina egna datorer. Att veta att all denna tid och fokus ägnades åt användarguiden, som har en tendens att vara lite i bakgrunden av ett system, var verkligen givande”, avslutar hon.
Om Digpro Lab
Digpro Lab är en vecka för innovation, där olika tekniker eller idéer testas. Alla på Digpro är välkomna att lämna in förslag, och dessa sammanställs i olika projekt. Ett projekt väljs för varje vår och höst, när Digpro Lab hålls.
Digpro Lab är en populär aktivitet för Digpro-anställda. Läs mer om att arbeta på Digpro på våra karriärsidor.