Kent-Ove Lindström
  • Kent-Ove Lindström

Är teknisk dokumentation en uppgift som bäst klaras av "lite snabbt" av mjukvaruprogrammerare? Kräver skapandet av teknisk dokumentation varken eftertanke eller planering? Behövs inga specialister för att ta fram bra dokumentation?

Grunden till uppfattningen att teknisk dokumentation inte är mödan värd ligger i att den uppfattas som rent ut sagt tråkig. En psykologisk följd av detta blir att vi i våra sinnen förminskar vikten av dokumentation. Väldigt många drar sig för att ens läsa instruktionerna till förstärkaren, mikrovågsugnen eller bilen. "Ägarmanualen behövs inte" tänker vi och vrider om startnyckeln på bilen.

Teknisk dokumentation upplevs som snustorr text utan själ. Tekniska dokumentatörer använder till och med uttrycket "våga vara tråkig" som ledstjärna för sitt arbete. Det kan för en utomstående te sig som en bekräftelse av saken. Men i "våga vara tråkig" ligger en djupare betydelse än vad som är uppenbart på ytan.

Gustave Flaubert var en berömd författare, han räknas till en av de tongivande inom den konstnärliga strömningen realismen. Hans stora genombrott var "Madame Bouvary" från 1857. I sina verk beskrev han trovärdigt vanliga människors liv, utan att väja för deras skönhetsfläckar och skavanker.

Det anmärkningsvärda med Flaubert är att han medvetet försökte undvika poetiska och svävande omskrivningar. Han sökte i sitt författande, som han uttryckte det, finna "le seul mot juste", det enda rätta ordet. Han tog tid på sig, reviderade ofta sin text i efterhand och vägde noggrant sina ord och fraser.

Stilen utmärkte sig genom sin språkliga exakthet och harmoniska meningsbyggnad. På ren svenska betyder det att han tydligt och lättläst lyckades beskriva något så komplicerat som livet själv.

Teknisk Dokumentation kan aldrig aspirera på att nå Flauberts konstnärliga höjder. Arbetet att ta fram dokumentation är snarare ett hantverk snarare än stor litteratur, och dokumentation behöver inte inspirera eller vara tänkvärd för att fylla sitt syfte. Men dokumentation ska vara lättförståelig och tydlig - och däri ligger kopplingen till Flaubert.

Bra dokumentation beskriver tydligt och lättläst även mycket komplicerade förhållanden. Den tillkommer, i likhet med Flauberts verk, inte till följd av plötslig och intensiv inspiration, utan måste ges tid att växa fram. Den måste revideras och justeras tills den är korrekt - till dess författaren funnit de rätta orden.

När han diskuterade författande påpekade Flaubert vid ett flertal tillfällen att synonymer egentligen inte existerade. Han menade att olika ord aldrig kan ersätta varandra utan att påverka innebörden i en mening. Även i den åsikten finns det en koppling. God dokumentation låter en noga vald term, och endast den termen, beskriva en viss sak. En bra teknisk skribent använder aldrig synonymer. I brist på Flauberts fantasieggande paroll "le seul mot juste", brukar tekniska skribenter tala om behovet att "våga vara tråkig".

Även om teknisk dokumentation inte är konstverk betyder det inte att tekniska skribenter saknar en konstnärlig ådra. Det krävs ett mått av författartalang, kreativitet och pedagogik för att beskriva verkligheten på ett greppbart sätt. Det krävs specialister såsom mig själv – Tekniska skribenter.