Från frustration till lösning – 3 tips för bättre dokumentation
Jag vet – ingen vill läsa manualen. De flesta ser den som en sista utväg, något de tar till när de redan är frustrerade och inte kan lösa sitt problem på egen hand. Så förutsättningarna när de tittar i dokumentationen är inte de bästa – de vill hitta ett svar snabbt och inte behöva ta sig igenom långa komplicerade texter. Minsta lilla distraktion eller hinder kan skapa en explosiv situation som hamnar i knät på nån stackars supporttekniker.
Och helt ärligt – innan en användare tittar i dokumentationen har de sannolikt testat flera andra saker:
De har kollat sina anteckningar.
De har frågat en eller flera kollegor.
De har letat runt på användarforum.
De har sökt på Google och i AI-verktyg.
De har ringt en släkting de inte pratat med på evigheter.
Efter detta KANSKE de plockar fram dokumentationen. När de slår upp innehållsförteckningen eller går in på docs-sajten börjar klockan ticka. Du har typ femton sekunder på dig, make them count!
För att minimera risken att användaren slår igen dokumentationen och ringer supporten - följ de här grundreglerna.
#1 – Se till att den är lätt att förstå
Dokumentation som är skriven av utvecklare har ofta ett “inifrån-och-ut”-perspektiv. Gör det enkelt! Skriv som om du förklarar för en kollega som inte jobbar i samma team. Och be någon utanför utvecklingsavdelningen att läsa igenom – det är ofta då ni upptäcker vad som behöver förklaras tydligare. Undvik akronymer, förkortningar och intern terminologi. Förklara tekniska termer innan ni använder dem – och samla dem i en ordlista.
Du kan använda verktyg som ChatGPT för att säkerställa att tonen är rätt och texten är lättförståelig. Du kan till exempel be AI:n att skriva en version av texten riktad till en specifik kunskapsnivå, som "en teknisk nybörjare" eller "en erfaren utvecklare". Testa också att mata in en teknisk text och be AI:n skriva om den i en mer vänlig och pedagogisk ton.
#2 – Skapa en navigerbar struktur
Tänk som en användare: vilka frågor ställer de? Se till att ha en bra sökfunktion som gör det lätt att navigera. Undvik långa sjok av text – innehållet måste vara enkelt att scanna av med blicken. Skriv bra och tydliga rubriker, använd punktlistor och numrerade listor (för procedurer), bryt av med en illustration när det är motiverat. Om ni har en fysisk manual – en bra innehållsförteckning och ett index är guld värt.
Återigen – AI kan göra mycket “heavy lifting” här, och hjälpa dig att skapa en tydligare struktur genom att analysera din text. Du kan t.ex. be AI:n identifiera viktiga rubriker eller generera en innehållsförteckning baserad på ditt material. AI-verktyg kan också simulera en användares sökbeteende genom att identifiera vilka termer eller frågor som är mest relevanta, så att du kan prioritera rätt innehåll.
#3 – Gör den levande
Tänk på dokumentationen redan från starten av utvecklingsresan. Genom att låta en teknisk skribent vara med tidigt kan ni säkerställa att den blir lika genomtänkt som resten av produkten, och dessutom spara tid i längden.
Uppdatera kontinuerligt – användare tappar snabbt förtroende för dokumentation som inte matchar produktens utveckling. Se den som en del av produktens livscykel! Sätt en rutin för att uppdatera den varje gång något ändras i produkten. Om ni har mycket dokumentation kan ett system som ett CCMS (Component Content Management System) vara en gamechanger.
Behöver ni hjälp?
Det behöver inte vara svårt – med rätt struktur, en tanke bakom innehållet och smart användning av AI kan dokumentationen bli ett riktigt användbart verktyg.
Behöver ni hjälp på vägen? Hör av er till mig, så pratar vi om hur ni kan få dokumentation som både ni och era användare blir nöjda med.
