User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva.
Välkommen till andra delen i min serie om hur user stories hjälper dig att skriva bättre teknisk dokumentation!
Vad är kopplingen mellan user stories och skriva instruktioner?
Tänk dig att din user story ser ut så här:
Som sjuksköterska vill jag kunna registrera en ny patient för att kunna föra journal.
Då är det rimligt att du åtminstone behöver skriva en instruktion för hur man registrerar en ny patient.
Du behöver troligen även instruktioner angående ”föra journal”. Kanske flera olika, beroende vilken typ av journal vi pratar om. En besöksanteckning i relativ fritext kan behöva en slags instruktion, ett formulär för audionomundersökning kan behöva en annan. Dessutom kan du behöva lägga till ytterligare instruktioner för hur användaren kan redigera en journalanteckning, signera en anteckning och så vidare.
Lägg inte över jobbet på läsaren
I en användarmanual bör du fokusera på vad användaren vill göra i systemet. Motsatsen är att fokusera på vad som händer om användaren klickar på olika knappar i systemet. Då blir manualen istället produktcentrerad. En sådan manual blir svår för användaren att få hjälp av, såvida inte användaren råkar vara ute efter referensinformation för en viss detalj.
I en produktcentrerad manual behöver nämligen användaren läsa mycket mer, för att sedan själv koppla ihop hur ett flöde ska gå till och vad som är bästa sättet att göra det på. Det kräver mycket av användaren och risken är att användaren inte orkar ta sig igenom dokumentationen. Eller missförstår.
Vi kan jämföra med hur matlagningsrecept brukar vara utformade!
Exempel 1: Användarcentrerat recept
Ett bra, användarcentrerat recept listar ingredienserna och vilken mängd du behöver. Därefter kommer en steg för steg-instruktion. Som exempel har jag använt Icas linssoppa med tomat. Jag har gjort en egen bild här nedan.
Inga konstigheter va? Men hur skulle det se ut om vi skriver receptet såsom många manualer är utformade?
Exempel 2: Produktcentrerat recept
Ett produktcentrerat recept skulle istället se ut så här:
Det går kanske att lista ut hur man gör linssoppan från den beskrivningen också, särskilt om ingredienserna listas i ordning.
Men det här ligger väl ändå ganska långt ifrån teknisk dokumentation? Nja. Faktum är att om du byter ut ingredienserna mot ikoner eller menyval i tabellen ovan, så liknar det många manualer jag ser.
En sådan manual lägger över allt jobb på användaren och blir oerhört jobbig att läsa. För att inte tala om att förstå.
Så var lite schysst mot din användare. Skriv hur man gör, inte bara vad som finns i gränssnittet.
Nästa del i serien om user stories
Nästa del i serien om user stories ger ett konkret tips på hur du kan börja dokumentera i liten skala, för att sedan iterera fram mer dokumentation med tiden.
Missade du första delen i serien om user stories? Här hittar du User stories ger rätt fokus i teknisk dokumentation (del 1).
Läs mer om agil teknisk dokumentation
Om du vill läsa mer om fokus på användaren eller på produkten så har jag skrivit mer om det tidigare:
Handlar din manual om produkten eller om användaren?
Kom igång med en användarcentrerad manual
Eller är du nyfiken på 6 olika sätt att skriva instruktioner?
