Uppdraget
När Marvells teknikskribent slutade fick en Dokumenterakonsult under tio månader hela ansvaret för hantering och kvalitetssäkring av företagets produktdokumentation. Dokumentationen var en supportfunktion för utvecklingsgrupperna och därför underordnades dokumentproduktionen produktionscyklerna när det gällde schemaläggning, resurser och deadlines. Dokumentationsprocessen fick därför inte komma i olag när ansvaret överfördes från en person till en annan.
Några exempel: Marvellkoncernens detaljerade regler för hur dokument utformas, godkänns och publiceras styrde det dagliga arbetet. Arbetsredskapet var Framemaker med en uppsättning mallar som inte fick ändras. Därtill tillämpades strikta koncerninterna skrivregler för teknisk engelska.
Eftersom Dokumenterakonsulten redan hade skrivit dokument åt företagets marknadsföringsgrupp kände han till hur verksamheten fungerade och kunde därför kliva direkt in i den nya rollen, något som kunden såg som en stor fördel.
Utmaningar och åtgärder
Balansgången tid/kvalitet: När blir “tillräckligt bra” tillräckligt bra?
En tumregel för projektledare säger att inom triangeln deadline, budget, kvalitet kan man inte maxa alla tre, utan minst en måste stryka på foten. Många gånger blir det kvaliteten, eftersom den inte är lika lätt att kvantifiera och mäta som de andra. I denna balansgång behöver dina kollegor och du slå fast vad som är godtagbar kvalitet, ”tillräckligt bra”. Ingen kund minns att ett dokument nådde honom exakt vid deadline, men varje gång som han läser det påminns han om dess eventuella fel och brister.
Konsulten vidtog därför två åtgärder för att höja kvaliteten inom rådande budgetar och tidsramar:
- Han gick in i textproduktionen i ett tidigare skede och förbättrade
målgruppsanpassningen, det vill säga: vad behöver just den här
målgruppen faktiskt veta? Dokumenten blev därigenom kortare och mer
precisa. - Peer reviewförfarandet som krävdes för att ett dokument skulle
godkännas för publicering strömlinjeformades. Konsulten skilde på ett
informellt kvalitetssäkrande skede som löpte mer eller mindre parallellt
med skrivande och ett avslutande formellt skede som hanterade det
byråkratiska i en snabb process. Detta minskade arbetsbelastningen för
kundens tekniker.
God engelska: “The devil is in the details”
Samtliga Marvelldokument skrevs på engelska. Koncernens språkpolicy slog fast tillåtna termer, grammatiska konstruktioner och stavningsregler. Syftet var att göra språket lättillgängligt och otvetydigt för läsare som inte hade engelska som modersmål.
Marvells ingenjörer kom från många länder och hade varierande kunskaper i engelska. Därtill var det få som förstod sig på språkpolicyns finare detaljer. Därför satsade den tvåspråkige konsulten mycket möda på att korrläsa och rätta texter under pågående dokumentproduktion.
Kundnytta
Det mer pragmatiska arbetssättet gjorde att kundens tekniker behövde ägna mindre tid åt språk och formalia, vilket minskade pressen inför de schemalagda releasetillfällena. Täta informella uppföljningsmöten identifierade eventuella dokumentproblem tidigt, vilket i sin tur gjorde det lättare att justera planeringen och göra snabba punktinsatser för tidskritiska dokument.
Kundens vinst i korthet: Teknikerna fick mer tid för produktutveckling samtidigt som fler dokument publicerades enligt releaseschemat.
