Att skriva för den som inte var där
Läsaren har inte din kontext. Skriv som om du förklarade för en ny kollega.
Fällan: tyst kunskap
När du skriver om något du kan bra utelämnar du automatiskt det som känns självklart. Men det självklara för dig är inte självklart för någon annan.
”Starta om tjänsten och kontrollera loggen” är en instruktion som bara fungerar om läsaren vet vilken tjänst, hur man startar om den, och vilken logg.
Fyra frågor som räddar anteckningen
| Fråga | Varför |
|---|---|
| Vem gäller det? | Roll, avdelning, behörighet |
| När gör man det? | Vid vilken händelse eller vilket läge? |
| Vad behövs först? | Förkunskaper, behörigheter, verktyg |
| Hur vet man att det lyckades? | Förväntat resultat — annars går det inte att verifiera |
Den sista är nästan alltid bortglömd. Utan den vet läsaren inte om det gick bra.
Skriv kort — men inte för kort
En anteckning ska vara tillräcklig, inte uttömmande. Om den blir för lång blir den inte läst. Om den blir för kort går den inte att följa.
Hur du skriver anteckningar som går att använda utan din kontext. Fällan med tyst kunskap och fyra frågor som räddar anteckningen.
Betyg
0
0
Det finns inga kommentarer just nu.
Gå med i denna Kurs
för att vara först med att lämna en kommentar.