6 tips för effektiva release notes

Ä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!

  1. 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
  2. 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
  3. 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
  4. 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
  5. 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
  6. 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.
Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

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

Läsare av teknisk dokumentation

Fixa dokumentationen med user stories (del 1)

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

Musfälla

Trick för att locka information ur utvecklare

Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden

Tips till dig som skriver lathund i affekt

Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Lathundar kan vara många olika saker. Allt

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.