Är det din tur att skriva release notes, leveransinformation eller versionsnyheter? Här är knepen som gör det lätt som en plätt!
- Sätt dig in i vad läsaren vill och behöver veta
Vem är det som läser? Börja där. Vad vill läsaren veta?
Ofta verkar release notes få formen av en braindump där du bara häver ur dig allt som har hänt sedan senast, men ofta har läsaren inte alls det perspektivet. Troligen vill läsaren ha någon slags översiktlig beskrivning av större förändringar – vad har varit i fokus för den här versionen?
Därefter vill läsaren kunna hitta vissa specifika nyheter, kanske baserat på en viss del i produkten eller utifrån ett inrapporterat fel.
rad - Vad behöver användaren göra?
Var extra tydlig med om läsaren behöver göra något för att den nya versionen ska fungera korrekt, till exempel installera något eller ändra på någon inställning.
rad - Skilj på nyheter och buggfixar
Ha separata rubriker i dokumentet för ny funktionalitet och för rättningar av fel. Ibland är gränsen hårfin, jag vet. Lösningen på buggfixen kan ibland vara att göra en ny funktion. I så fall kanske beskrivningen kan platsa under båda rubrikerna?
rad - Kategorisera innehållet
Vilken del av produkten är det som påverkas? Eller är det bara en viss typ av användare som nyheten rör? Samla alla förändringar per del av produkten eller per användartyp eller någon annan avgörande parameter, det blir lättare för läsaren att ta in. Även här kan vissa förändringar platsar under flera rubriker.
rad - Beskriv det nya, inte det gamla
Ofta när jag läser release notes så förstår jag inte om det som beskrivs är hur det var förut eller hur det fungerar nu. Ibland är det också otydligt vad som var ett problem eller oönskat beteende och vad som var den tänka funktionen. Var tydlig!
I princip är det bara hur det fungerar nu som du ska beskriva i dina release notes. Om du vid enstaka tillfällen vill beskriva hur det fungerade förut så var explicit med att det är det gamla och felaktiga du beskriver. Var sedan (över)tydlig när du går över till att beskriva hur det fungerar idag.
rad - Beskriv nya användarflöden
Det är när funktionaliteten är ny som du har tillfälle att styra hur användaren gör! Skriv en instruktion. Den kan du sedan återanvända i manualen. Om du känner dig extra ambitiös kan du komplettera med en film där du visar flödet.
