Analys

Ibland får vi i uppdrag att undersöka hur vi skulle göra för att förbättra ett företags produktinformation. Det kan vara olika orsaker som föranlett uppdraget, men ofta är det frågan om man ska byta verktyg som leder till att man tar in en konsult. I de flesta fall är det dock processen som är problemet. Man måste alltid titta på alla delar, då det är helheten som leder till resultatet: verktyg, information och processer.

När man ska handla upp ett nytt verktyg bör man fokusera på att först ta fram processen för hur man skriver sin dokumentation. Steg två är sedan att ta fram ett verktyg som stödjer det sättet att arbeta. Alltför ofta börjar man tvärtom med att köpa ett verktyg, sedan går all kraft åt till att förändra dokument och process för att passa in i det nya verktyget.

Informationsanalys

Målet med en informationsanalys

Målet med en informationsanalys är ofta en informationsmodell, ett dokument som handlar om dokumenten. Informationsmodellen förklarar hur dokumentationen ska upplevas av kund, vilka typer av dokument som ska ingå, vilka målgrupper varje dokument har och vilka kapitel som ska ingå i varje dokument.

Leverabler vid en fullständig analys är:

informationsmodell
dokumentinstruktion
dokumentmallar
exempeldokument

För att få en komplett bild bör man också se över logistiken, hur dokumenten distribueras. Trycker man och lägger med manualer på samtliga målspråk vid produktionsorten, eller använder man en print-on-demand-lösning vid distributionscentralen, så att man bara lägger i rätt målspråksmanual? Här finns det mycket pengar att spara.

Arbetsgången i en informationsanalys brukar vara:

Genomläsning av en stort antal dokument
Intervjuer av personer på olika poster i företaget, ca 6-12 stycken
Gemensam workshop för att få samsyn
Rapport med upptäckter och lösningar

Ta först fram er arbetsprocess, införskaffa därefter ett verktyg som stödjer ert arbetssätt.
Se över om distributionen av era produkter går att effektivisera.

Strukturering

Att ha en bra struktur på sin informationsleverans blir allt viktigare. Det är viktigt att läsaren snabbt hittar rätt information. Vad är då en informationsstruktur?

Ett ord ingår i en mening, en mening ingår i ett stycke och ett stycke ingår kanske i ett kapitel som ingår i en bok. Det är en hierarkisk struktur. Om man bara ser en mening utan sammanhang är det svårt att förstå vad det handlar om. Nyhetssajter på nätet lägger ut en lösryckt mening som gör oss nyfikna och får oss att klicka för att kunna läsa hela artikeln och få veta vad det handlar om.

Förändringen som sker inom informationshanteringen är att man går ifrån kontextkänslig text till mer fristående moduler. Under många år har man arbetat med strukturer, till exempel kapitelstrukturer eller menystrukturer. På grund av växande behov av att konsumera information via telefoner och liknande, behöver man kunna arbeta med mindre moduler som kan hanteras och förstås utan kontext.

För teknisk dokumentation använder många företag modulorienterade verktyg, till exempel DITA, som är en XML-standard och olika former av wikis. Här använder man sig av metadata för att skapa strukturer och lätt kunna söka fram rätt information.

Analysera vilka frågor som en tänkt användare har och använd dem för att bygga upp era informationsstrukturer. Det gör informationen lättare att producera och framför allt blir den lättare att söka i och snabbt hitta rätt.

XML

XML är fortfarande ett hett ämne inom teknikinformation. Oavsett om man pratar försvarsindustrins S1000D eller senaste DITA-standarden så är XML en teknik som blir mer och mer intressant även för mindre och medelstora företag.

Större industrier som varit med ett tag har ofta redan investerat i lösningar. Återanvändning, samt enklare och billigare översättningshantering brukar vara de krafter som driver fram en XML-baserad skribent- och publiceringsmiljö.

XML står för eXtensible Markup Language och är vad man kallar ett metaspråk. En specifik syntax används för att ge olika ord och meningar extra värde. Exempel på det är en enkel tagg som heter till exempel title, då vet både människa och maskin att det som står mellan taggarna är en titel. Det är just det här som är poängen med XML. Det är ett språk som ska kunna läsas av både AI:n och alla oss andra.

Det ger mycket större möjligheter till återanvändning av texter och bilder, vilket leder till mer konsekvent dokumentation och sparar både tid och pengar vid översättningar. En annan stor möjlighet är att du kan konfigurera informationen på samma sätt som du konfigurerar produkten. Slutkunden kan få en manual som innehåller exakt information om sin konfigurerade produkt, och slipper gå igenom mängder av information för att så småningom hitta rätt.

En stor fördel med XML är också att man skiljer på innehåll och layout. Texten lagras oformatterad på ett enda ställe. Sedan lägger man på olika typer av stylesheets, beroende på vilken marknad den ska lanseras på eller om det ska presenteras i tryck eller på webb. Det innebär att du kan ha flera olika utseenden på samma text och när du behöver uppdatera din text så gör du det på ett enda ställe. Uppdateringarna syns då direkt på alla ställen och i alla format där informationen presenteras.