Vem ska egentligen äga dokumentationen?
Verksamheten bör utse en dokumentationsansvarig, det kan vara en intern resurs eller en extern teknisk skribent, som äger dokumentationen och ser till att den tas fram, är korrekt och uppdateras.
I teorin kan det verka självklart att låta utvecklare och tekniska experter skriva dokumentationen men det ger sällan ett bra resultat. Att vara kunnig på sitt område betyder inte nödvändigtvis att man är duktig på att förklara det man jobbar med på ett begripligt sätt.
När ansvarsfördelningen är tydlig blir dokumentationen både mer aktuell och enklare att förvalta.
Hur mycket teknisk kunskap måste en teknisk skribent ha?
En teknisk skribent behöver ha tillräcklig teknisk förståelse för att kunna ställa rätt frågor och förklara komplex information på ett begripligt sätt. Däremot behöver skribenten sällan vara den främsta tekniska experten.
Det viktigaste är att snabbt kunna sätta sig in i nya produkter, system eller processer genom intervjuer, tester och nära samarbete med utvecklare, ingenjörer och andra ämnesexperter. Förmågan att omvandla tekniska detaljer till tydlig dokumentation är ofta viktigare än att själv kunna utveckla produkten.
Hur får man utvecklare, ingenjörer eller projektledare att bidra med information?
För att skapa bra dokumentation krävs samarbete med de personer som har den tekniska kunskapen. Den största utmaningen är dock sällan ovilja, utan brist på tid.
Ett effektivt arbetssätt är att låta den tekniska skribenten intervjua experterna istället för att be dem skriva dokumentationen själva. Genom korta möten, workshops eller strukturerade frågor kan viktig information samlas in på kort tid.
Hur dokumenterar man komplexa processer på ett enkelt sätt?
Nyckeln till att dokumentera komplexa processer på ett enkelt sätt är att bryta ner det
i mindre, logiska steg. Börja med att beskriva processens syfte och fortsätt sedan med varje moment i den ordning de utförs. Korta stycken, tydliga rubriker och punktlistor gör informationen mer lättillgänglig.
Visuella hjälpmedel som flödesscheman, processkartor och skärmbilder kan göra avancerade arbetsflöden betydligt enklare att förstå. Anpassa också innehållet efter målgruppen. En tekniker behöver ofta mer detaljer än en slutanvändare eller en projektledare.
Slutligen bör dokumentationen testas av någon som inte deltagit i arbetet. Om personen kan följa instruktionerna utan ytterligare förklaringar är dokumentationen sannolikt tillräckligt tydlig.
Hur bygger man ett effektivt gransknings- och godkännandeflöde?
Ett välfungerande granskningsflöde säkerställer att dokumentationen håller hög kvalitet utan att skapa onödiga förseningar.
Tre steg för att bygga ett effektivt gransknings- och godkännandeflöde
1. Den tekniska skribenten tar fram ett utkast.
2. Ämnesexperter granskar innehållets tekniska korrekthet.
3. Produktägare och dokumentansvarig godkänner dokumentet innan publicering.
Varje granskare bör endast fokusera på sitt ansvarsområde. Ingenjören granskar tekniken, skribenten ansvarar för språk och struktur, och beslutsfattaren säkerställer att dokumentationen uppfyller verksamhetens krav. Med tydliga roller, versionshantering och fasta deadlines blir granskningsprocessen både snabbare och mer effektiv.
Sammanfattning
När processer blir mer komplexa ökar kraven på tydlig dokumentation. En väl genomarbetad teknisk dokumentation gör det enklare att arbeta effektivt, minskar risken för missförstånd och säkerställer att kunskap kan delas och underhållas över tid.