Skriv effektiva versionsrapporter (+ verkliga exempel och mallar)

Alla som arbetar med att skriva versionsrapporter tycker att de är tråkiga och tidskrävande. Man ser ofta människor som bokstavligen flyr från dem. Men kom ihåg att det är viktigt att publicera produktrelease anteckningar och hålla din changelog uppdaterad för din affärstillväxt. I den här artikeln kommer vi också att titta på mallar för release notes.

Förutom att driva en changelog-tjänst hanterar vi också release notes väldigt ofta. Vi fortsätter att uppdatera våra användare om de senaste ändringarna förbättringar som vi gjort på vår produkt. Därför har vi utvecklat tekniker för att göra hela processen mer uthärdlig och effektiv.

Vad är Release Notes?

Release notes är ett dokument i punktform som kommer tillsammans med en programvaruversion för att berätta för användarna vad som har ändrats. Även om det inte finns något universellt format innehåller typiska versionsanteckningar information om felrättningar, nya funktioner och ibland kända problem. Release notes kan vara ett tråkigt tekniskt dokument som ingen gillar att läsa och skriva. Men vårt uppdrag som produktchef, är att göra till dessa anteckningar mer tilltalande, intressanta och informativa.

Vad är problemet med dem?

Tre huvudproblem som är förknippade med versionsanteckningar är
– hantering,
– bruten kommunikation,
– och en distributionskanal.

Det största problemet vi möter är bristande kommunikation inom teamet. Även i små företag har det tekniska teamet svårt att förklara vad som har ändrats. Ofta fixar de något, och några veckor senare glömmer de också vad som gjordes den här månaden.
Ja, och att lämna uppgiften med release notes till utvecklingsteamet är också ett misstag. De tenderar att skriva mycket tekniska versionsanteckningar för personer med doktorsexamen i datavetenskap.
Läsarna bryr sig inte om hur något har rättats, de bryr sig bara om slutresultatet. Hur kan de dra nytta av uppdateringen?

Tips för att skriva versionsinformation (med mallar)

Om man bortser från ämnet humor i versionsinformation för senare, kan majoriteten av informationen i versionsinformation mallas till en begriplig form. Så nästa gång en utvecklare skickar dig anteckningar om ett åtgärdat fel eller en ny funktion kommer ni båda att spara tid.
Så, istället för att ta emot en kommentar från en utvecklare som inte är begriplig. Du kommer att ha en djupare förståelse för vad som har ändrats och hur du bättre kan kommunicera det till slutanvändarna.
Så, här kommer vi till min personliga lista med tips och tricks som jag använder för att göra bra release notes! Låt dig inspireras och skriv dina egna mallar för produktrelease notes!. Mallar för produktrelease anteckningar är ett bra sätt att spara tid.

1. De > Vi

Förbered dig inte på att börja med ”Vi har gjort det här”. Användarna bryr sig inte om vad DU har gjort, de bryr sig bara om vad de får ut av det du har gjort.

Du kan nu .
Nyligen utgiven är tillgänglig för din användning. Nu kan du

2. Fokusera på användaren

Använd ”DU” oftare. Det är ett copywriting-trick som omedelbart förändrar hur textinformationen uppfattas. De blir omedvetet mer benägna att läsa texten när de ser ”du”.

Goda nyheter för dig! låter dig samla in feedback från dina användare.
Glatt att meddela att det hjälper dig att undvika dataförlust.
Spara tid med

3. Följ enkla mallar för versionsanteckningar

Skapa dessa mallar och be er utvecklare att skriva era anteckningar endast i detta format. På så sätt undviker ni missförstånd och ni vet exakt vad som har ändrats, hur det fungerar och vilka mål det försöker uppnå. Enbart dessa 4 mallar täcker 90 % av alla versionsanteckningar.

• Förut X är nu Y
• Du kan nu göra X i stället för Y
• X gör inte längre X, Y när Z, Q, W
• X gör inte längre Y. Detta innebär att du inte längre behöver göra Z

4. Undvik att vara alltför formell

Självklart beror det på ditt företags varumärke. Formellt skrivande är dock vanligtvis långt och inte direkt till poängen. Det gör det alltså svårare för läsarna att skanna texten. Försök att använda ett konsekvent språk och undvik att vara alltför formell i dina dokumentmallar för versionsanteckningar.

5. Expandera och förenkla sedan

En bra release note är kort och koncis. Men för att nå dit utökar du texten, se till att den återspeglar allt som en ny funktion, en felrättning handlar om. Dessutom består mycket av skrivandet av release notes av att ta en stor mängd information och pressa in den i korta stycken. Se till att varje versionsanteckning inte tas ur sitt sammanhang.

Låt oss titta på de bästa exemplen på versionsanteckningar. 3 företag med fantastiska sidor för Release Notes och hur kan du lära dig av dem?

👉Relaterad artikel: Allt du behöver veta om nyckeltal i SaaS

Exempel på release notes

Salesforce Release Notes Examples

Salesforce är en CRM-plattform med många produkter under sitt paraply. Så att hålla kunderna uppdaterade om nya funktioner och produktförändringar är ett helvete för tekniska skribenter, produktchefer och utvecklare.
Jag antar att företaget förbereder release notes kvartalsvis och kallas ”Salesforce Summer ’19 Release Notes”, vilket är en mycket omfattande release notes-sida med sina kategorier och underkategorier.
Salesforce release notes är en blandning av vanliga release notes samt produktkarta. Det är en detaljerad förklaring av hur varje funktion kommer att fungera och specifikt för vilka användare de kommer att vara tillgängliga.

Den uppenbara fördelen med sådana omfattande sidor med versionsanvisningar är att de tar arbete från supportavdelningarnas axlar. Om de till exempel får en kundfråga som rör ett specifikt ämne. De kan enkelt omdirigera dem till sidan, där användarna kan hitta svaret.

Nyckelproffstips att ta med sig:

1. Hur man använder avsnittet med versionsanteckningar

2. Detaljerade, visuellt förståeliga tabeller med en produktplan

3. Filteravsnitt

4. Generaliserad förklaring, generaliserad förklaring och sedan följt av en detaljerad beskrivning av hur en ny funktion fungerar.

Salesforce följer också mallar för release notes.

Steg 1: Förklara vad den nya funktionen handlar om.
Du behöver inte längre byta till Salesforce Classic för att hantera områdestilldelningar på sidan Konto. Du kan nu redigera den relaterade listan Assigned Territories i Lightning Experience. Tidigare var den relaterade listan skrivskyddad i Lightning Experience.

Du behöver inte längre utföra . Du kan nu göra . Tidigare kunde du bara göra .

Steg 2: Förklara hur du aktiverar eller får tillgång till funktionen
Var: Den här ändringen gäller Lightning Experience i Performance- och Developer-utgåvorna och Enterprise- och Unlimited-utgåvorna med Sales Cloud.

Steg 3: Förklara hur du använder funktionen
Hur: Om sidlayouten för Kontosidan innehåller den relaterade listan Tilldelade territorier krävs ingen inställning. Klicka på Assign Territories och tilldela för att hantera tilldelningar.

Sketch Release Notes Examples

Om din produkt inte är så komplicerad och inte är en plattform med ett stort paraply av underverktyg, kan du kolla in Sketch company.
Layouten är intressant. På höger sida har du en detaljerad beskrivning av alla nya funktioner och buggfixar och på vänster sida finns beskrivningar av de viktigaste stora funktionerna. Och CTA.

Smart Distribute Upgrades

Du kan nu använda Smart Distribute för att styra avståndet i rutnät. Du kan enkelt justera det vertikala avståndet mellan rader av lager samt det horisontella avståndet mellan varje lager i en rad. Vi har också infört en ny knapp ”Ordna” i inspektören. Den anpassar snabbt ett urval av flera lager till ett snyggt rutnät, vilket gör det ännu enklare att skapa och hantera komplexa layouter.

Återigen ser vi en enkel mall:
Du kan nu göra . Du kan enkelt göra . Vi har också infört en ny .

I förbättringar:
Vi har lagt till ett nytt kommando Välj allt i Artboard i menyn Redigera så att du snabbt kan ta tag i alla lager på en Artboard som du har valt. Vi har också gett de olika Select All-kommandona sin egen undermeny.

• Vi har lagt till , så att du nu kan göra .
• Rättat en krasch som kunde inträffa när du försöker dra-till-markering med verktyget Magic Wand.
• Rättat ett fel som gjorde att rätt typsnittsvikt inte visades för typsnitt med samma namn.

– Fixade ett fel i sid- och lagerlistorna där markeringar inte markerades korrekt när de var anslutna till en extern bildskärm.

Så, för att återgå till användarorienterade versionsanteckningar, måste vi förstå att vi skriver våra versionsanteckningar för vår målgrupp. Salesforce skriver sina releaser för personer utan teknisk bakgrund, för försäljningsavdelningar och marknadsförare, entreprenörer, grundare osv.

Skissen används av grafiska designers och konstnärer. Således använder både Salesforce och Sketch en generisk ton, mycket användarvänlig, inriktad på riktiga människor.

Getpostman Release Notes Examples

Om din produkt är teknisk och dina användare är utvecklare, så är det motsatta en tumregel. Ju kortare, mer teknisk, inte visuellt tilltalande, desto bättre.

Till exempel är Getpostman en teknisk produkt för utvecklare.

Release Notes kan snabbt skannas igenom för att få en allmän uppfattning om vad som är nytt. Och de följer ett mycket förenklat format.

Uppdateringsnummer, datum och information i en mening om varje uppdatering utan detaljer om vad den betyder för en användare, hur den ska användas eller hur man får tillgång till den.

Desto enklare desto bättre. De kommer att förstå.

Humor i versionsnotiser

Vi har redan talat om exempel på versionsnotiser i appar som är roliga och underhållande att läsa. Tonläget är dock inte lämpligt för majoriteten av teknikföretag. Och de behöver en stilguide för Release Notes. Dessutom har inte alla mjukvaruprodukter en mobilversion och majoriteten av företagen publicerar sina release notes på en separat sida någonstans under support- eller hjälpavsnittet. (Företag begraver strategiskt sina release notes och klagar sedan på att ingen läser dem.)

Det finns många smarta sätt att tillkännage produktuppdateringar. Till exempel genom att skriva ett bra e-postmeddelande för att introducera produktuppdateringar eller skapa ett separat blogginlägg.

👉 Relaterad artikel: Det bästa och sämsta app Release Notes som kommer att inspirera dig

Som i allt i livet, genom att föra struktur och organisation samt modern teknik skapar vi en enklare lösning, som inte är så tråkig och onödig.

Förhoppningsvis hjälpte våra exempel på mallar för programvaruversionsnoteringar
och exempel dig.