User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner eller installationsanvisningar.
Det här är första delen i en liten serie om hur du kan använda dig av user stories när du skriver din tekniska dokumentation.
Vad är ens en user story?
Är du osäker på vad en user story är? User stories är vanliga inom agil mjukvaruutveckling och beskriver en produkts funktioner ut ett användarperspektiv. Här är några exempel:
Som sjuksköterska vill jag kunna registrera en ny patient för att kunna föra journal.
Som administrativ personal vill jag ha tillgång till alla yrkeskategoriers kalendrar för att kunna göra tidsbokningar åt patienterna.
Som utvecklare hos kundföretaget vill jag kunna integrera produkten med andra system för att få ett smidigare flöde.
Om du vill läsa mer om user stories i agil mjukvaruutveckling så kan jag rekommendera den här artikeln.
Hur user stories hjälper dig att skriva agil teknisk dokumentation
User stories löser flera problem kring dokumentationen, eftersom:
- den beskriver vem användaren är, det vill säga vem du skriver för.
- du vet vad användaren vill göra och varför.
- den ger en struktur att utgå ifrån som följer användarens behov, istället för produktens delar. Du kan alltså börja i liten skala och sedan iterera dig framåt.
Jag förklarar den första punkten, den om att du vet vem användaren är, i texten nedan. De andra punkterna kommer jag att prata mer om i kommande bloggposter!
Punkt 1: Du vet vem du skriver för
I din user story står det tydligt vem som är den tänkta användaren. Varför är det bra för dokumentationen? Jo, det är så mycket lättare att skriva när du vet vem du skriver för. Det gör det enklare för dig att avgöra hur mycket bakgrundsinformation du behöver ta med, vilka termer du bör använda och hur du ska förklara något.
För vad du väljer att säga, och hur du ska säga det, beror till största delen på mottagaren. Inte på produkten. Eller det borde i alla fall göra det.
Om din produkt är en säkerhetsapp, hur skulle du beskriva den för din 5-åriga dotter, jämfört med en affärsbekant i samma bransch? Kommer du överhuvudtaget att använda samma ord?
Samma sak gäller om du ska beskriva hur man gör en linssoppa. När jag pratar matlagning med mina barn, så behöver jag säga att de ska skala löken och vilken siffra de ska vrida till på spisplattan. Det brukar däremot inte min man behöva höra.
Vi anpassar oss intuitivt till mottagaren av informationen, men då behöver vi först veta vem det är!
Gör det ännu enklare med personas
Att din user story berättar vilken typ av användare du riktar dig till är ett stort plus. Om du vill göra det ännu lättare att skriva så kan du tänka på en specifik person som du känner, som skulle kunna representera den användaren.
Till exempel, när jag skriver dokumentation som riktar sig till utvecklare så brukar jag tänka på min bror som är it-konsult. Vad skulle han behöva veta om han kom in som konsult här? Ibland funkar det bättre att tänka på en specifik kund som du har varit i kontakt med eller någon annan du känner.
Genom att använda den här typen av personas så kommer du instinktivt lägga dig på rätt nivå, och säga rätt saker.
Nästa del i serien om user stories kommer att dra fler paralleller till matlagning.
Läs mer om agil teknisk dokumentation
Om du vill läsa mer agil teknisk dokumentation så kan jag rekommendera några tidigare blogginlägg:
Agil dokumentation – en oxymoron?
Agil dokumentation tips #2
Agil dokumentation tips #3
Eller har du svårt att överhuvudtaget få fram information till din tekniska dokumentation? Då ska du läsa Trick för att locka inforamtion ur utvecklare.
