Att få fram underlag till teknisk dokumentation är verkligen en utmaning.
Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden i Jira eller Trello.
Ofta slutar det med att jag sitter med minst sagt bristfällig information och en deadline som snabbt närmar sig.
Vaga och intetsägande svar
För även om dina utvecklare eller produktägare går att få tag på och gärna vill hjälpa dig så är det inte alltid så lätt för dem heller.
När jag frågor om vem som ska använda produkten så får jag ofta svar i stil med ”ja du, det skulle kunna vara vem som helst”. När jag frågar eller hur lång tid en installation tar blir svaret ”det går inte att säga, det beror på så många olika faktorer”.
Känns det igen? Det är oerhört frustrerande för dig som skribent. Men det är viktigt att komma ihåg att det inte handlar om en ovilja från informantens sida.
Snarare vill personen ifråga inte säga något som är fel. Eller för snävt.
Så, ska vi skribenter bara ge upp här och nöja oss med att skriva ett intetsägande material som inte är till hjälp för någon?
Naturligtvis inte!
Lösningen är inget för fegisar
Det finns ett knep som är nästan helt idiotsäkert, men det kräver att du vågar framstå som lite korkad. Det kräver också en viss fantasi från din sida.
Knepet innebär att provocera fram rätt information. Utan tortyrredskap. Istället för att lämna tomt där du saknar information så skriver du något som troligen är fel. Du gillrar helt enkelt en fälla.
Så här går det till:
När utvecklaren säger att det inte går att säga hur lång tid installationen tar, då säger du ”ok, då skriver jag att det tar ca 5 minuter”.
”Nej, är du dum i hela huvet!” kommer utvecklaren då säga. ”Först ska’ru ladda ner exe-filen och den är stor, det tar minst en timme även med snabb uppkoppling. Sen är det rätt många steg i själva installationen, så det tar säkert minst 20 minuter bara att stega sig igenom det. Sedan är det ju verifieringen och då måste man invänta en ledig server, och efter att man väl fått kontakt så står den väl och tuggar i 1-2 timmar.”
Och se där, plötsligt har du fått en mycket mer detaljerad redogörelse.
Skräm fram svaren
Det funkar även på annat material och andra personer.
När du ber om de viktigaste nya funktionerna i senaste releasen och bara får en massa svammel till svar, eller inga svar alls, så välj ut tre på måfå och skriv dem.
Visa sedan versionsnyheterna för produktchefen. När hen får akut blodstörtning över dina dåliga val så kommer du garanterat att få en mycket tydligare bild av vad du istället borde ha skrivit. Då att det bara att le lite oskyldigt och anteckna.
Flera fördelar för den modige
Om du (som jag) konstant fabulerar text i din dokumentation så kommer det också göra att folk blir mer benägna att granska det du har skrivit, vilket också kommer att ge bättre resultat i slutänden.
Men som sagt, den här provokativa metoden kräver en viss själsstyrka från din sida. Du behöver utsätta dig för att uppfattas som dum och trögtänkt. Men skrattar bäst som skrattar sist!
Lär dig fler knep
Läs om 6 tips för effektiva release notes.
Lär dig fler knep genom att gå någon av mina online-kurser:
- Styr upp er tekniska dokumentation (gratiskurs)
- Skriv en manual
