Informationsverkstan Produkt

Låt oss utveckla, förvalta och uppdatera din produktinformation

Att hålla produktinformationen aktuell innebär att du slipper många ”onödiga” frågor och korrigerande åtgärder. Du spar tid och kan fokusera på produktivt arbete och offensiva kundkontakter.

”Information är det dyraste vi äger”

Så brukar många företag säga när de ska värdera sina tillgångar. Ofta mot bakgrund av att få företag har produkter idag som är unika och som inte relativt enkelt kan kopieras eller ersättas av likvärdig produkt. Värdet har förskjutits från att vara ensidigt knutet till den produkt som företaget tillverkar och marknadsför till den information som krävs för att producera, vidareutveckla, underhålla och använda den. Det är enkelt att föreställa sig att denna ”mjukvara” är betydligt svårare att kopiera.

Hur ser verkligheten ut?

Företag som saknar sälj- och marknadsstrategi för sina produkter är nog svårt att hitta. Däremot har få företag en en strategisk och utmejslad strategi för sin produktinformation. Företag med en värdeadderad syn på sin produktinformation bör också ha en klar uppfattning om hur den ska uppdateras och förvaltas. Annars blir det bara en klyscha utan förankring i verksamheten och bland slutkunderna. En snabb bedömning ger svaret att ytterst få företag har strategi och metoder för sin information som ligger i linje med den som gäller för sina produkter.

Metodik för lösningar

Här ryms ett stort affärsområde med många möjligheter för ett informationsföretag. Det handlar om att förpacka, strukturera, presentera, ta fram metoder för förvaltning av ett företags produktinformation.

I ett utvecklingsprojekt kan det finnas många aktörer och flera leverantörer av design och lösningar. Beställaren bör ha en kravspec ifikation med checklista för hur inkommande information ska hanteras för att skapa ”rätt” värde.

Informationsverkstan erbjuder olika lösningar och samarbetsformer för att förbättra din dokumentation:

• Hjälp att komma igång
• Handledning
• Mallar och metoder
• Resurs på plats
• Helhetsåtagande (outsourcing)

För att din dokumentation ska uppnå sitt syfte och bidra offensivt till verksamheten måste den uppfylla vissa grundkrav. Bra och ändamålsenlig dokumentation ska vara:

• Uppdaterad
• Lätt åtkomlig
• Språkligt korrekt

Saknas ett av ovanstående krav hjälper det föga att resten är på topp. Klicka på länkarna för att läsa mer!

Uppdaterad

Utvecklare slår sig inte till ro bara för att du har sparat ner ditt dokument. Rättningar, justeringar och vidareutveckling pågår ständigt och i samarbete med många olika kravställare.

Det medför att teknisk dokumentation är färskvara. Din uppgift som dokumentatör blir att kartlägga processer som leder fram till förändringar som i sin tur påverkar ditt dokument. Processerna kan vara både formella och informella.

Vad är det som triggar en förändring i det system eller produkt som du är satt att dokumentera?

Exempel på triggers:

• Buggrättningar
• Hantering av problem och incidenter
• RFC (request for change)
• Verksamhetskrav
• Förändringsprojekt

Ansvarig för aktiviteterna kan vara ett projektkontor, system-, drift- eller applikationsförvaltare. Se till (kräv!) att få insikt, styr upp dokumentationsarbetet efter definierade aktiviteter. Det kommer att underlätta din vardag på ett påtagligt sätt.

Versionshantering

Se till att nå en intern uppgörelse för hur dina dokument ska uppdateras. Det är önskvärt att de håller jämna steg med utvecklingen av det aktuella systemet eller produkten.

Förslag på frekvens:

• Vid varje ny release
• Vid överlämning av ett projekt till en förvaltningsorganisation
• I samband med revision

I dokumentet ska genomförda uppdateringar visas på ett tydligt sätt, gärna i tabellform.

Förslag på information:

• Revisionsnummer
• Datum
• Notering (vad som ändrats)
• Ansvarig

Se alltid till att något händer här! Även om den senaste releasen inte innebar några stora förändringar för ditt system eller produkt ska historiken alltid hänga med.

Lätt åtkomlig

De flesta har varken tid eller lust att leta länge efter ett dokument, även om det är aldrig så uppdaterat.

Informationen behövs för att snabbt svara på en fråga eller lösa ett problem, ofta med kunden i telefonen. Undvik en situation där det känns lättare att fråga kollegan om muntliga råd istället för att söka upp dokumentation.

Sådant bygger bara upp personberoenden och försvagar informationskvaliteten. Acceptera inte ”teknik”-förslag som fritextsökning viat ex Google Desktop. Det ger inte relevant precision och levererar som regel ett alltför omfattande sökresultat.

Ta alltid hänsyn till användarnas arbetsmiljö. Om t ex Helpdesk är målgrupp för ditt dokument måste informationen kunna nås omedelbart och helst i samma miljö. Personalen kanske bara har ett par minuter på sig innan ärendet eskaleras.

Dokumentstrategi

För att få bra åtkomst behövs en strategi för komponenter och begrepp som berör dokumentationen. Bygg upp metoder för hantering av dessa som gör dokumenten spårbara.

- Filnamn

- Dokumenttitel

- Projektnamn, release

- Förvaltningsorganisation

Många företag och organisationer använder någon form av dokumenthanteringssystem. Se till att få behörighet att bygga upp en struktur och metodik för att ingående dokument ska bli lätt och konsekvent sökbara.

Rörlighet och spårbarhet

Man brukar säga att bra teknisk dokumentation är ”levande”, dvs att den ständigt är föremål för uppdatering och förändring. Inte så sällan betyder det också att dokumenten rör sig mellan utvecklar-grupper, projekt- och förvaltningsgrupper etc.

Det tillhör dokumentatörens uppgifter att ha överblick och göra dokument spårbara och därmed åtkomliga.

Språkligt korrekt

Ditt dokument måste även hålla en bra nivå rent språkligt och stilistiskt. Annars riskerar det att uppfattas som mindre trovärdigt och kommer kanske inte nå ut även om de tekniska uppgifterna är korrekta.

Vanliga fallgropar är syftningsfel och rent grammatiska fel (språkfel). Teknisk dokumentation innehåller ofta instruktioner och beskrivningar av processer och förlopp. Se till att reda ut vem som gör vad. Dvs ange om användaren eller operatören ska utföra en aktivitet eller om systemet levererar informationen.

Ett tekniskt dokument är inte att betrakta som litteratur och behöver inte vara briljant och nå konstnärliga höjder. Däremot måste det vara korrekt och konsekvent. Se till att ingående instruktioner, flöden, förlopp, processer och metoder beskrivs på ett likartat sätt.

Uttryck och begrepp

Teknisk dokumentation brukar ofta innehålla en mängd specifika ord, förkortningar, produktnamn etc.

Du behöver inte nödvändigtvis ”försvenska” orden men det krävs ett förhållningsätt till dem. Låt dem inte bara ”dyka upp” i texten utan att ha förklarat dem initialt. Skapa t ex en tabell tidigt i dokumentet med begrepp och tillhörande beskrivning.