ClickUp Release Notes Template
Product Management

Hoe schrijf je release-antekeningen die gelezen worden (met voorbeelden)

De meeste aantekeningen worden niet gelezen, en de meeste zouden er eigenlijk niet moeten zijn.

Het goed schrijven van release notes heeft minder te maken met schrijfstijl en meer met discipline. Uit een onderzoek van Empirical Software Engineering onder 1.529 problemen in 1.139 opslagplaatsen bleek dat de meeste tekortkomingen in release notes te wijten waren aan tekortkomingen in de planning en automatisering, en niet aan slecht schrijven.

Teams zijn erg gefocust op de toon, terwijl het eigenlijke probleem verderop in het proces ligt: beslissen waarover er überhaupt een aantekening moet worden gepubliceerd.

Deze gids is bedoeld voor productmanagers, engineeringleiders en iedereen die verantwoordelijk is voor het informeren van gebruikers over wat er is veranderd. We bespreken het proces, het format, de kanalen en de redactionele keuzes die bepalen of gebruikers je publicaties daadwerkelijk openen.

TL;DR

  • Beoordeel elke wijziging voordat je gaat schrijven: aankondigen, integreren of weglaten. De meeste teams maken te veel bekend
  • Begin met de impact voor de gebruiker, niet met de wijziging in de code. „Zoeken gaat drie keer sneller“ klinkt beter dan „Gemigreerd naar Elasticsearch“.
  • Stel de aantekening op in het ticket terwijl het werk nog gaande is, en niet pas vijf minuten voor de implementatie
  • Kies specifieke kanalen voor de verdeling en maak je die eigen. Stop met lukraak verspreiden
  • De kop is voor 80% van de lezers de aantekening. Zorg ervoor dat deze op zichzelf staat

Wat zijn release-opmerkingen?

Release-opmerkingen zijn een document, een pagina of een bericht in de app waarin gebruikers wordt verteld wat er nieuw is, wat er is verholpen en wat er is gewijzigd in een specifieke software-release. Ze vormen de brug tussen het werk van je ontwikkelteam en de ervaring van je gebruikers.

Deze bevatten doorgaans nieuwe functies, verbeteringen, bugfixes, bekende problemen en alles wat gebruikers moeten weten na een update.

Uit onderzoek van de Nielsen Norman Group naar ‘veranderblindheid’ blijkt dat gebruikers wijzigingen in de interface vaak over het hoofd zien, tenzij de waarde ervan duidelijk is en goed wordt gecommuniceerd. Het is niet voldoende om een functie te lanceren. Je moet ook uitleggen waarom deze belangrijk is.

Release notes verschillen van changelogs en patch notes. Een changelog is een doorlopend overzicht van alle productwijzigingen in alle versies. Release notes richten zich op één specifieke software-update en belichten de wijzigingen die voor gebruikers het belangrijkst zijn. Patch notes zijn doorgaans beperkter van opzet en richten zich voornamelijk op bugfixes.

Voor SaaS-teams fungeren release notes als de gebruikersgerichte laag van een implementatie of Sprint. In plaats van ruwe technische tickets te tonen, leggen ze in begrijpelijke taal uit wat de praktische gevolgen van de release zijn.

Het format verschilt per product. Aantekeningen over de release van software kunnen op een speciale pagina op je productwebsite staan, in een modaal venster in de app, in een e-mail of als beschrijving van een update in de app store.

Waarom zijn goede release notes belangrijk voor productteams?

Release-antekeningen voor producten doen meer dan alleen vastleggen wat je hebt uitgebracht. Ze hebben direct invloed op hoe je product wordt waargenomen, geaccepteerd en ondersteund.

  • Gebruik van functies: Gebruikers kunnen geen gebruik maken van functies waarvan ze niet weten dat ze bestaan. Release notes zijn de eenvoudigste manier om nieuwe functionaliteiten onder de aandacht te brengen van gebruikers die het product al gebruiken
  • Minder supporttickets: Plotselinge wijzigingen in de gebruikersinterface brengen gebruikers in verwarring. Duidelijke release aantekeningen voorkomen ‘bugrapporten’ die worden veroorzaakt door verwachte updates
  • Vertrouwen en transparantie: Door bekende problemen en bugfixes te vermelden, laat het team zien dat het luistert en actie onderneemt, in plaats van problemen te verbergen
  • Interne afstemming: Engineering, support, sales en marketing moeten allemaal weten wat er is uitgebracht en waarom. Release notes zorgen ervoor dat alle teams op één lijn zitten
  • Feedbacksignaal: Aantekeningen die uitnodigen tot reacties (replies, reacties, upvotes) bieden productteams een eenvoudige feedbackloop van klanten om de stemming te peilen

De selectie van release-antekeningen: niet elke wijziging verdient een aantekening

De meeste teams maken standaard alles bekend. Daarom worden hun release notes niet gelezen.

Een slimmere aanpak is om elke wijziging in een van de volgende drie categorieën in te delen voordat je iets gaat schrijven:

  • Uitbrengen en aankondigen: De wijziging verandert het gedrag van gebruikers, doorbreekt verwachtingen of vereist actie. Schrijf de aantekening. Daar zijn release notes voor bedoeld.
  • Ship-and-embed: De wijziging is direct zichtbaar in het product zelf: een nieuwe knop, een duidelijk menu-item, een tooltip. Het product legt het zelf uit. Sla de aantekening over
  • Ship-and-bury: Werk dat uitsluitend intern is, zoals infrastructuurmigraties, refactoring en onopgemerkte prestatieverbeteringen. Dit hoort thuis in engineeringlogs, niet in aantekeningen voor klanten

Het gaat er niet om betere release-antekeningen te schrijven. Het gaat erom te weten welke wijzigingen geen release-antekeningen nodig hebben. Minder, maar wel scherpere antekeningen worden gelezen. Een maandelijks overzicht van „12 kleine verbeteringen“ wordt genegeerd.

Wie moet release-aantekeningen schrijven?

Technische teams schrijven vaak standaard release aantekeningen omdat zij de code uitbrengen. Het probleem is dat technische teams van nature beschrijven wat ze hebben gebouwd, en niet wat de gebruiker eraan heeft.

Het resultaat zijn aantekeningen vol intern jargon en verwijzingen naar databasemigraties en wijzigingen in eindpunten. Deze zeggen de gemiddelde klant helemaal niets.

Een beter model is gedeelde verantwoordelijkheid. Productmanagers of productmarketingmanagers moeten de eindverantwoordelijkheid dragen voor het definitieve concept, omdat zij het dichtst bij zowel de productstrategie als de klant staan. De technische afdeling levert de basisinformatie via pull-aanvragen, tickets en sprintverslagen. Ondersteunings- en customer success-teams controleren de aantekeningen op duidelijkheid en mogelijke onduidelijkheden.

In een klein team kan de persoon die de PR heeft samengevoegd ook de aantekening schrijven. Dat is prima, zolang hij of zij deze maar herschrijft vanuit het perspectief van de gebruiker voordat deze wordt gepubliceerd. In grotere teams die wekelijks of dagelijks releases uitbrengen, leidt vaak een speciale releasemanager of -coördinator het proces om het in goede banen te leiden.

Het is ook gebruikelijk om twee versies van dezelfde release-antekening te maken. Interne release-antekeningen kunnen wijzigingen in de database, updates van de infrastructuur of API-details bevatten. Release-antekeningen voor klanten moeten zich uitsluitend richten op de gevolgen voor de gebruiker en uitleg in begrijpelijke taal.

Wat moet er in elke release-aantekening staan?

Een consistent format voor release notes helpt gebruikers te weten waar ze moeten zoeken en helpt schrijvers te weten wat ze moeten behandelen. Hier is een checklist voor elke release:

  • Versienummer of releasedatum: Geeft aan wanneer de aantekening is opgesteld, zodat gebruikers en ondersteuningsteams er later naar kunnen verwijzen
  • Samenvattende kop: Eén zin die de belangrijkste wijziging in eenvoudige taal weergeeft
  • Nieuwe functies: Wat er is toegevoegd, beschreven in termen van wat de gebruiker nu kan doen
  • Verbeteringen: Verbeteringen aan bestaande functies, waaronder wijzigingen in prestaties, gebruikerservaring of werkstroom
  • Bugfixes: Wat er niet werkte en wat de gebruiker nu kan verwachten, zonder alarmerende taal te gebruiken
  • Bekende problemen: Alles waarvan het team op de hoogte is, maar wat nog niet is opgelost. Door deze te vermelden, bouw je geloofwaardigheid op
  • Verouderde functies of ingrijpende wijzigingen: Alles wat is verwijderd of zodanig is gewijzigd dat gebruikers actie moeten ondernemen
  • Links naar technische documentatie: Verwijs de lezer naar helpartikelen of handleidingen voor meer achtergrondinformatie over belangrijke wijzigingen

Niet elke release zal al deze onderdelen bevatten. Een kleine patch bevat misschien alleen bugfixes en een nummer voor de versie. Beschouw deze checklist als een maximum, niet als een minimum.

Productleider Shreyas Doshi heeft het LNO-raamwerk populair gemaakt, dat productteams aanspoort om ‘Leverage’-taken te identificeren die een 10x grotere impact opleveren dan ‘Overhead’-taken die louter administratief zijn. Te veel bedrijven beschouwen release notes als Overhead (een saaie klus die moet worden afgevinkt) in plaats van als een Leverage-kans om nieuwe waarde aan gebruikers te presenteren.

Hoe schrijf je release notes: een stapsgewijze handleiding

Goede release notes vervullen één belangrijke functie: ze helpen gebruikers te begrijpen wat er is veranderd, waarom dat belangrijk is en wat ze vervolgens nog moeten doen. De fout die de meeste teams maken, is dat ze release notes als een bijzaak beschouwen en ze pas vijf minuten voor de implementatie opstellen.

Een beter proces begint al veel eerder. Hier is onze door experts goedgekeurde aanpak voor het schrijven van release notes.

Stap 1: Bepaal voor wie je release notes bedoeld zijn

Bepaal, voordat je ook maar één regel schrijft, wie de belangrijkste doelgroep is. Meestal zijn je aantekeningen gericht op een of meer van deze groepen:

  • Eindgebruikers
  • Beheerders of IT-teams
  • Ontwikkelaars en API-gebruikers
  • Interne teams zoals support, sales of customer success

Deze stap is belangrijker dan de meeste teams beseffen. Als je release notes een mengeling zijn van technisch jargon, marketingtaal en instructies voor de installatie, zullen de meeste mensen stoppen met lezen.

Gebruik deze eenvoudige regel:

  • Schrijf voor de persoon die door de wijziging wordt beïnvloed
  • Leg eerst de impact uit
  • Voeg alleen technische details toe waar dat nodig is

Als schrijven niet je sterkste kant is, maak je dan geen zorgen. De meeste tools voor projectmanagement bieden tegenwoordig AI aan om je te helpen bij het eenvoudig opstellen van een eerste concept.

Stap 2: Verzamel updates gedurende de hele releasecyclus

Het slechtste moment om release notes te schrijven is vlak voor de implementatie. Dan vergeten teams namelijk belangrijke fixes, laten ze randgevallen buiten beschouwing of schrijven ze vage samenvattingen omdat niemand de volledige context meer kent.

Goede release-antekeningen worden tijdens de ontwikkeling voortdurend opgebouwd. Niet pas aan het einde.

De eenvoudigste manier om dit te doen is door tijdens het werk samenvattingen vast te leggen in tickets, pull-aanvragen of taakupdates, zodat deze direct klaar zijn voor gebruik in de release-opmerkingen. Sommige teams maken het veld ‘release-opmerkingen’ zelfs verplicht in elk ticket.

Een eenvoudige gewoonte helpt daarbij:

  • Schrijf de samenvatting voor de gebruiker wanneer het ticket wordt aangemaakt
  • Werk de release notes bij als de scope verandert
  • Gebruik de formulering later nog eens in de release-antekeningen

Veel teams genereren tegenwoordig een eerste versie van release-aantekeningen rechtstreeks op basis van tickets en samengevoegde pull-aanvragen.

Dit is wat we hebben geleerd van een Redditor in r/SaaS

Schrijf featuretickets vanaf het begin in gebruiksvriendelijke taal. Als in het ticket de gevolgen voor de gebruiker al duidelijk worden uitgelegd, wordt het genereren van release notes op basis van samengevoegde taken veel eenvoudiger en gemakkelijker te automatiseren.

Dit verhoogt ook de nauwkeurigheid. De meeste productwijzigingen ontstaan uit verzoeken van klanten, dus het oorspronkelijke ticket bevat meestal de duidelijkste uitleg van het probleem en de waarde van de oplossing.

Als je tickets zijn gekoppeld aan een supportportaal, kun je zelfs de gebruikers die om de functie hebben gevraagd op de hoogte brengen zodra de update live gaat.

Het doel is simpel: maak het aanmaken van release notes onderdeel van de werkstroom, in plaats van een schrijfklusje op het laatste moment.

Stap 3: De wijzigingen in duidelijke categorieën indelen

De meeste gebruikers lezen release notes niet van begin tot eind; ze scannen de tekst. Als je updates als één groot blok van tekst worden weergegeven, missen gebruikers de belangrijke wijzigingen. Duidelijke categorieën lossen dat op.

Zodra je al het materiaal voor je release-antekeningen hebt verzameld, verdeel je dit in brede rubrieken. Enkele veelgebruikte categorieën in release-antekeningen zijn:

  • Nieuwe functies
  • Verbeteringen
  • Bugfixes
  • Veiligheidsupdates
  • API-wijzigingen
  • Integraties
  • Bekende problemen
  • Verouderde functies

Als je dashboardfilters nu bijvoorbeeld sneller laden, zet je dit onder ‘Verbeteringen’. Heb je een manier gelanceerd om terugkerende factuurherinneringen in te plannen? Categoriseer dit dan onder ‘Nieuwe functies’.

Zo kunnen lezers snel vinden wat voor hen van belang is. Ook voorkomt dit verwarring tussen teams. Ondersteuningsteams kunnen zich concentreren op oplossingen. Ontwikkelaars kunnen API-wijzigingen doornemen. Klanten kunnen zoeken naar nieuwe functies.

Hierbij een paar praktische tips:

  • Zet de belangrijkste updates bovenaan
  • Zorg ervoor dat categorienamen in alle releases consistent zijn
  • Gebruik opsommingstekens in plaats van compacte alinea’s
  • Vermijd het door elkaar halen van updates die niets met elkaar te maken hebben
  • Voeg bij grote releases bovenaan een korte TL;DR-sectie toe met de één of twee belangrijkste updates

Door wijzigingen te taggen per productgebied (bijv. ‘Dashboard’, ‘Mobiel’, ‘API’) voeg je een tweede navigatieniveau toe, zodat gebruikers direct naar het deel van het product kunnen gaan dat voor hen van belang is. Dit is vooral waardevol voor platformproducten met meerdere soorten gebruikers.

Stap 4: Leg duidelijk uit wat gebruikers nog moeten doen

Eén over het hoofd geziene instructie kan al honderden supporttickets opleveren. Daarom verdienen actiepunten een eigen paragraaf in de release notes.

Als gebruikers iets moeten aanpassen, vermeld dit dan duidelijk en in een vroeg stadium. Verberg het niet in een alinea.

Hieronder vallen onder andere:

  • Vereiste migraties
  • Wachtwoord opnieuw instellen
  • Wijzigingen in toestemming
  • Verouderde API's
  • Nieuwe configuratievereisten
  • Geplande onderhoudsperiode
  • Wijzigingen in de facturering
Wat je niet moet schrijvenWat je in plaats daarvan kunt schrijven
Er zijn verificatie-updates doorgevoerd voor de HubSpot-integratieWe hebben de verificatie voor HubSpot-integraties bijgewerkt. Beheerders moeten HubSpot-integraties vóór 1 juni opnieuw autoriseren om verbindingsfouten te voorkomen.
Ondersteuning voor verouderde methoden voor verificatie verwijderdWe hebben de ondersteuning voor verouderde methoden voor verificatie gestopt. Applicaties die hiervan gebruikmaken, zullen na 15 juli niet meer werken, tenzij ze worden geüpgraded naar OAuth 2.0

Hier is een voorbeeld van release notes van Salesforce die voor iedereen duidelijk maken wat er nog te doen is.

Salesforce-release-aantekeningen
Een release-aantekening van Salesforce waarin de volgende stappen voor beheerders duidelijk worden uitgelegd

Release-antekeningen moeten wijzigingen toelichten. Ze mogen geen uitgebreide producthandleidingen worden.

Proberen om elk uitzonderlijk geval, elke stap van de installatie en elke werkstroom in release-aantekeningen uit te leggen, leidt tot twee problemen:

  • Het document wordt te lang
  • Belangrijke updates vallen steeds minder op

Schrijf je release aantekeningen in plaats daarvan als een begeleidende samenvatting. Geef lezers eerst de belangrijkste update en koppel vervolgens aan gedetailleerde documentatie als ze meer context willen.

Je kunt linken naar helpartikelen, changelogs, API-documentatie, video-tutorials en andere relevante content. Bijvoorbeeld:

” Ondersteuning voor SAML-gebaseerde SSO is toegevoegd. Bekijk deze video om te leren hoe je SSO voor je werkruimte kunt configureren. ”

” Ondersteuning voor SAML-gebaseerde SSO is toegevoegd. Bekijk deze video om te leren hoe je SSO voor je werkruimte kunt configureren. ”

Deze aanpak werkt omdat verschillende gebruikers verschillende niveaus van detail nodig hebben. Een productmanager heeft misschien alleen de samenvatting nodig. Een beheerder die de functie instelt, heeft wellicht een configuratiehandleiding met 20 stappen nodig.

Stap 6: Bekijk de release notes met alle teams

In aantekeningen die door één enkel team zijn geschreven, ontbreekt meestal iets belangrijks.

De technische afdeling richt zich mogelijk te veel op implementatiedetails. Marketing maakt mogelijk te veel ophef over de verandering. Productteams vergeten mogelijk uitzonderingsgevallen. Ondersteuningsteams zien mogelijk meteen verwarrende bewoordingen.

Daarom worden goede release aantekeningen vóór publicatie door verschillende afdelingen beoordeeld.

Betrek in ieder geval vertegenwoordigers van de productafdeling, de technische afdeling en de klantenservice bij het proces. Betrek ook technische schrijvers of documentatieeigenaars, indien beschikbaar.

Geef elke beoordelaar een eenvoudige checklist:

  • Zijn de releasedata correct?
  • Is de taal duidelijk?
  • Is er iets misleidend?
  • Zijn de actiepunten zichtbaar?
  • Zijn de gekoppelde links correct?
  • Zijn bekende problemen gedocumenteerd?

Stap 7: Publiceer release-antekeningen op plekken waar gebruikers ze daadwerkelijk zullen zien

Zelfs uitstekende release-antekeningen hebben geen zin als niemand ze leest. Een veelgemaakte fout is het verbergen van updates op een vergeten changelog-pagina die gebruikers nooit bezoeken.

Verspreid release aantekeningen in plaats daarvan via kanalen die je doelgroep al gebruikt. Dit kunnen bijvoorbeeld zijn:

  • Notificaties in de app
  • E-mailupdates
  • Productblogs
  • Helpcentra
  • Ontwikkelaarsportalen
  • Communityforums
  • GitHub-wijzigingslogboeken

Het juiste kanaal hangt ook af van het type release en de impact ervan. Grote wijzigingen verdienen bijvoorbeeld een aankondiging via e-mail en in de app, kleine aanpassingen daarentegen niet.

Ook de timing is belangrijk. Als gebruikers vóór een deadline actie moeten ondernemen, publiceer de release notes dan vroeg genoeg zodat ze kunnen reageren.

Hier is een korte video waarin het praktische proces van het schrijven van effectieve release aantekeningen van begin tot eind wordt gedemonstreerd.

Best practices voor het schrijven van release-opmerkingen die echt helpen

Volg deze tips om ervoor te zorgen dat je release-antekeningen niet alleen gemakkelijk te schrijven zijn, maar ook nuttig voor je gebruikers.

Begin met een herbruikbaar sjabloon

Een sjabloon neemt het moeilijkste deel van het schrijven van release notes weg: beginnen met een leeg blad. Het zorgt er ook voor dat elke release consistent is, wat belangrijk is voor teams die elke week of elke dag een release uitbrengen.

Een eenvoudig sjabloon voor release-aantekeningen moet het volgende bevatten:

  • Feedbackgedeelte
  • Versie-nummer of releasedatum
  • Nieuwe functies
  • Verbeteringen
  • Bugfixes
  • Bekende problemen

Sla het sjabloon op op de plek waar het team al werkt. Dat kan een wiki zijn, een documentatietool of een werkruimte voor projectmanagement. Hoe gemakkelijker het toegankelijk is, hoe groter de kans dat mensen het consequent zullen gebruiken.

Veel projectmanagementtools bevatten sjablonen voor release-opmerkingen die automatisch gekoppelde taken en details van de versies ophalen, waardoor er tijdens de releaseweek minder handmatig werk nodig is.

De sjabloon voor release-opmerkingen van ClickUp helpt je bijvoorbeeld om belangrijke wijzigingen in elke productrelease vast te leggen en te delen. Je kunt:

  • Maak taken met verschillende aangepaste statussen om de voortgang van elke release bij te houden
  • Categoriseer en voeg attributen toe om je release aantekeningen en featureverzoeken te beheren met aangepaste velden
  • Verbeter het bijhouden van releases met reacties op opmerkingen, geneste subtaaken, meerdere toegewezen personen en prioriteiten
  • Maak gebruik van de geïntegreerde AI-schrijver van ClickUp Brain om je teksten te verbeteren
Maak geweldige release notes en deel ze met belanghebbenden met behulp van de ClickUp-sjabloon voor release notes

Begin met de gevolgen voor de gebruiker, niet met de wijzigingen in de code

Dit is de grootste fout die de meeste teams maken.

Gebruikers maken het niet uit dat je team diensten heeft gemigreerd, frameworks heeft bijgewerkt of de indexering van de database heeft geoptimaliseerd. Het gaat hen erom wat er voor hen is veranderd.

Vergelijk deze twee versies van dezelfde wijziging:

Wat je niet moet schrijvenWat je in plaats daarvan kunt schrijven
Het verouderde eindpunt is afgeschaftDe oude API-versie (v1) is verwijderd. Migreer naar v2 vóór [datum]
Een race condition in de notificatieservice is opgelostEen bug verholpen die soms leidde tot dubbele notificaties
OAuth 2.0 PKCE-werkstroom geïmplementeerdEr is een methode voor de veiligheid van de aanmelding toegevoegd voor mobiele apps
De indexering van zoekresultaten is gemigreerd naar Elasticsearch voor betere query-prestatiesZoekresultaten worden nu tot drie keer sneller geladen bij alle abonnementstypen
De module voor toestemming is herzien om rolgebaseerde toegangscontrole te ondersteunenJe kunt nu aangepaste rollen toewijzen om te bepalen wie wat ziet in je werkruimte

Een eenvoudige regel helpt hierbij: als de release-aantekening technologische termen bevat waar de meeste gebruikers nog nooit van hebben gehoord, herschrijf deze dan. Het is jouw taak om ‘wat wij hebben gebouwd’ te vertalen naar ‘wat jij krijgt’.

Gebruik eenvoudige taal en vermijd vakjargon

Goede aantekeningen klinken eenvoudig omdat ze zijn geschreven om te scannen, niet om grondig te lezen.

Vermijd afkortingen, tenzij je publiek zeer technisch onderlegd is. Schrijf termen voluit wanneer ze voor het eerst voorkomen. Vervang technische jargon waar mogelijk door alledaagse taal.

Eenvoudige taal betekent niet dat je het niveau verlaagt; het zorgt ervoor dat er geen kloof ontstaat tussen wat je hebt geschreven en wat gebruikers ervan begrijpen.

Interne release-antekeningen voor de technische afdeling kunnen en moeten technisch van aard blijven. Deze stap geldt voor aantekeningen die voor klanten bestemd zijn.

Streef naar duidelijke, eenvoudige taal die de meeste lezers snel kunnen doorlezen. Bij consumentenproducten werken kortere zinnen en alledaagse woordkeuze het beste. In B2B-SaaS zullen je lezers wellicht meer technische termen tolereren, maar duidelijkheid wint altijd.

Wees voorzichtig met het woord ‘verbetering’. Teams gebruiken het vaak als een vage verzamelterm. Bouw in plaats daarvan geloofwaardigheid op met specifieke taal. Bijvoorbeeld: ‘Verbeterde backend-processen’ komt minder goed over dan ‘Zoekresultaten verschijnen nu tot 40% sneller’.

Voeg schermafbeeldingen of GIF's toe om te laten zien wat er is veranderd

Visuele veranderingen zijn moeilijk in tekst te beschrijven. Een schermafbeelding met pijltjes of markeringen geeft een herontwerp meestal sneller weer dan een alinea. Korte GIF’s werken nog beter voor nieuwe werkstroomen of interacties, omdat gebruikers de functie dan meteen in actie kunnen zien.

Enkele best practices:

  • Gebruik schermafbeeldingen met aantekeningen voor interface-updates
  • Zorg dat GIF's korter zijn dan 15 seconden
  • Voeg alt-tekst toe aan schermafbeeldingen en afbeeldingen
  • Voeg bijschriften toe aan animaties of GIF's

We vinden het geweldig hoe het team van Blender visuele elementen gebruikt om hun productwijzigingen zo begrijpelijk mogelijk te maken. Neem eens een kijkje.

Vergelijking van de interface-bedieningselementen in de aantekeningen van Blender-versies 5.0 en 5.1
Gebruik afbeeldingen om je release aantekeningen begrijpelijker te maken, net zoals Blender dat doet

Eén praktische gewoonte helpt hierbij enorm. Zorg ervoor dat je elke Sprint een gedeelde map met schermafbeeldingen bijhoudt. Anders moet de schrijver van de release notes op het laatste moment op zoek naar afbeeldingen.

Zorg dat de tekst aansluit bij de toon van je merk, zonder verkooppraatjes

Release notes zijn een communicatiemiddel, geen marketingkanaal voor het product. Gebruikers hebben geen bezwaar tegen een persoonlijke toon, maar hebben een hekel aan reclame.

Sommige bedrijven staan bekend om hun grappige, persoonlijk getinte aantekeningen. De updates in de app store van Slack (“We hebben een paar bugs verholpen en ze eens flink de les gelezen”) werken omdat die informele toon overal bij hun merk past. Als de toon van jouw merk formeel en nauwkeurig is, ga dan niet plotseling grappen maken in de changelog.

Een handige test: lees de release-aantekening hardop voor.

Als het klinkt als iets wat een supportmedewerker vanzelfsprekend tegen een klant zou zeggen, is de toon waarschijnlijk goed. Als het klinkt als een persbericht, herschrijf het dan.

Vraag gebruikers om feedback en sluit de cirkel

Sluit elke release-aantekening af met een eenvoudige manier om feedback te verzamelen: een link om te reageren, een reactieoptie, de vraag ‘Was dit nuttig?’ of een link naar een feedbackforum.

Release notes zijn een van de weinige momenten waarop gebruikers actief aandacht besteden aan productwijzigingen. Daardoor zijn ze een sterke indicator voor het sentiment onder gebruikers.

Het belangrijkste is om de cirkel later gesloten te maken. Als gebruikers om een wijziging vragen en jouw team voert die door, maak dan een vermelding daarvan in een toekomstige release-aantekening. Eenvoudige zinnen als “Jullie vroegen erom, wij hebben het doorgevoerd” bouwen verrassend snel vertrouwen op.

Hoe moet je release notes verdelen?

Kies kanalen die bij je target passen en ga voor consistentie in plaats van breedte.

  • In-app-notificatie of modaal venster: Het meest geschikt voor grote releases omdat de zichtbaarheid hoog is. Gebruik dit spaarzaam om notificatie-moeheid te voorkomen.
  • Speciale changelog-pagina: hiermee maak je een doorzoekbaar archief dat gebruikers op elk moment kunnen raadplegen. Dit is de officiële startpagina voor alle release aantekeningen van je app
  • E-mail: Werkt goed voor betrokken gebruikers die zich hebben aangemeld voor updates. Houd e-mails kort en koppel een link aan de volledige release-aantekening
  • Beschrijving van de update in de app store: Vereist voor mobiele apps. Aangezien er een limiet aan tekens geldt, moet je in de aantekeningen van de app store de twee of drie belangrijkste wijzigingen bovenaan vermelden.
  • Interne kanalen (Slack, Teams, ClickUp Chat of een gedeeld document): Voor interne release-antekeningen gericht op ondersteunings-, verkoop- en klantenserviceteams. Plaats deze voordat de externe aantekening live gaat, zodat deze teams niet voor verrassingen komen te staan.
  • Sociale media of blog: Optioneel, het beste te reserveren voor grote lanceringen of functies met een brede aantrekkingskracht

Kies twee of drie kanalen die bij je doelgroep passen en publiceer daar regelmatig op. Verspreid je berichten over alle kanalen met wisselende kwaliteit, dan is dat slechter dan je goed op twee kanalen te concentreren.

Bij ClickUp publiceren we bijvoorbeeld wekelijkse updates in ons openbare changelog, dat per kwartaal is geordend in ClickUp Docs. Van daaruit wordt de verdeling gedaan via e-mail, in-app-notificaties, sociale media, blogposts en YouTube-video’s bij grote lanceringen. Het changelog is de enige betrouwbare bron; al het andere dient ter aanvulling.

Achter de schermen: hoe we bij ClickUp met release notes omgaan

Elke week brengt ons productteam updates uit. Die updates moeten miljoenen gebruikers bereiken op een manier die duidelijk, actueel en gemakkelijk te vinden is. Hier lees je hoe we dat voor elkaar krijgen zonder ClickUp te verlaten.

Alles begint met een taak. Wanneer een functie of oplossing klaar is voor release, zet het engineeringteam de taak in ClickUp-taak op de status ‘gesloten’. Die ene handeling zet de werkstroom voor de release notes in gang. Niemand hoeft een ontwikkelaar op de schouder te tikken en te vragen: “Hé, wat heeft dit gedaan?”

AI Super Agents stellen de eerste versie op. Zodra een taak wordt afgesloten, genereert een ClickUp Super Agent die de taak in de gaten houdt automatisch een conceptversie van de release-opmerking. Hierbij wordt context gehaald uit de taakbeschrijving, het bovenliggende epic en gekoppelde items. Het concept verschijnt als een opmerking bij de taak, zodat het hele team er zichtbaarheid voor heeft. Teams controleren en bewerken de tekst nog wel, maar dit versnelt het opstellen van het eerste concept aanzienlijk voor wekelijkse releases.

De definitieve versie staat in ClickUp Docs. Onze release notes staan in ClickUp Docs, geordend per kwartaal. Elke documentpagina behandelt één wekelijkse release met duidelijke kopjes, korte beschrijvingen, GIF’s of schermafbeeldingen en links naar helpartikelen. De eigenaar en bijdragers van het document worden bovenaan vermeld, zodat iedereen weet wie er verantwoordelijk is.

Omdat ClickUp Docs realtime samenwerking ondersteunt, kunnen de engineering- en productmarketingteams op één plek de documenten bekijken en van opmerkingen voorzien, in plaats van een link naar een Google-document heen en weer te sturen.

Teams krijgen automatisch een notificatie. ClickUp-automatiseringen (of een speciale Super Agent) treden in actie zodra de status van de release-aantekening in ClickUp-documenten verandert in ‘Gepubliceerd’. Er wordt een notificatie over de changelog verstuurd naar de support- en CS-kanalen. Interne teams worden op de hoogte gebracht voordat klanten de update te zien krijgen.

De verdeling vindt plaats via meerdere kanalen. Zodra een release-antekening is goedgekeurd, wordt deze verspreid via:

  • Onze openbare changelog (de enige betrouwbare bron)
  • In-app-notificaties voor actieve gebruikers
  • E-mailupdates naar onze gebruikers
  • Blogberichten voor de lancering van belangrijke functies
  • Social media en YouTube-video’s voor grotere releases
ClickUp-pagina met release-aantekeningen 4.04 en een ingesloten video
Een voorbeeld van een release-aantekening uit de changelog van ClickUp

Waarom dit belangrijk is voor je team. Je hebt geen aparte wiki, Notion-pagina, Confluence-ruimte of Slack-kanaal nodig om iedereen op de hoogte te houden. Eén werkruimte regelt het plannen, schrijven, beoordelen en publiceren. Je ontwikkelaars blijven gefocust op de code. Je productmanagers krijgen direct zichtbaarheid in wat er is uitgebracht. En je gebruikers weten altijd waar ze moeten kijken.

Een eerlijke kanttekening: deze werkstroom is bedoeld voor teams die al met ClickUp werken. Als je team een andere projectmanagementtool en een aparte wiki gebruikt, is de extra inspanning die de migratie met zich meebrengt misschien niet de moeite waard, alleen al voor de release notes. Maar als je sprints en documenten al op één plek beheert, past het proces voor release notes daar vanzelf in.

5 voorbeelden van release notes die de moeite waard zijn om te bestuderen

Naast onze eigen aantekeningen zijn hier vijf voorbeelden waar je iets van kunt leren.

Slack: een eigen stijl zonder in te boeten aan duidelijkheid

De release-antekeningen van Slack
De release-antekeningen van Slack staan bekend om hun humor en scherpzinnigheid

Als we naar voorbeelden van release notes kijken, vallen de updates van Slack op door hun informele, humoristische toon.

Humor is echter nooit een vervanging voor nuttige informatie. In die aantekeningen wordt nog steeds uitgelegd wat er is veranderd, wat er is verholpen en wat gebruikers in de toekomst kunnen verwachten.

De kern: Evenwicht. Een persoonlijke stijl komt het best tot zijn recht als de structuur overzichtelijk en gemakkelijk te scannen blijft.

Gebruik deze aanpak als: je merkstem overal elders (marketingsite, antwoorden van de klantenservice, sociale media) al informeel en grappig is. Consistentie zorgt ervoor dat het aanslaat.

Het nadeel: Humor veroudert snel en laat zich slecht vertalen. Een grap die in het Engels goed overkomt, werkt niet in een gelokaliseerde aantekening, en een slimme opmerking uit 2019 komt in 2026 gênant over. Houd rekening met kosten voor bewerking, of beperk het gebruik van humor tot een minimum.

Lineair: beknopt, gericht op ontwikkelaars en overzichtelijk

Release-antekeningen van Linear
Release-antekeningen van Linear

Linear houdt release aantekeningen extreem kort. De meeste updates bestaan uit één zin en zijn gegroepeerd per categorie, zoals Functie, Verbetering of Oplossing.

Het resultaat is een overzichtelijke update voor technische gebruikers die geen behoefte hebben aan lange uitleg.

De conclusie: Als je doelgroep het product al goed kent, zijn kortere aantekeningen vaak beter.

Gebruik dit als: je je updates verstuurt naar ontwikkelaars of ervaren gebruikers die de changelog wekelijks bekijken en gewoon willen weten wat er nieuw is. Korte, bondige beschrijvingen zijn een teken van respect voor hun tijd.

Het nadeel: Aantekeningen van één regel gaan uit van context die de lezer misschien niet heeft. Nieuwe gebruikers, niet-technische kopers en incidentele gebruikers zullen afhaken. Je optimaliseert voor de gebruikers die het product al gebruiken, niet voor degenen die je probeert te overtuigen.

Notion: visueel georiënteerd met ingesloten GIF’s

Release-antekening van ClickUp met opties voor het format van rollup-nummers
Een voorbeeld van een release-aantekening uit Notion

Notion maakt in zijn ‘Wat is er nieuw’-updates veel gebruik van GIF’s en schermafbeeldingen.

In plaats van werkstroommen gedetailleerd te beschrijven, laten ze de interactie direct zien. De tekst fungeert als ondersteunende context in plaats van als de belangrijkste uitleg.

Voor een product waarbij de meeste wijzigingen visueel zijn (nieuwe blokken, bijgewerkte menu’s en drag-and-drop-gedrag), brengt dit format de boodschap sneller over dan welke alinea dan ook.

De belangrijkste les: Als de wijziging visueel is, laat deze dan zien in plaats van deze te beschrijven.

Gebruik dit als: je product veel interface-elementen bevat en de meeste updates invloed hebben op wat gebruikers zien of aanklikken. Met GIF’s kun je een hele alinea uitleg in drie seconden samenvatten.

Het nadeel: GIF’s zijn duur om te maken, laden traag en zijn nutteloos voor niet-visuele wijzigingen zoals API-updates, factureringslogica of backend-prestaties. Als je te veel op dit format leunt, worden je release-antekeningen een ontwerpproject.

GitHub: gestructureerd voor schaalbaarheid

De changelog van GitHub is zo ontworpen dat je er gemakkelijk op kunt filteren
De changelog van GitHub is zo ontworpen dat je er gemakkelijk op kunt filteren

GitHub brengt elke maand honderden updates uit. Their release notes blijven overzichtelijk omdat ze deze per productgebied ordenen, voorzien van datumstempels en uitklapbare details.

Gebruikers kunnen filteren op categorieën zoals Acties, Veiligheid of Copilot, in plaats van zich door één enorme changelog te moeten worstelen.

De kern van het verhaal: Zodra de releasegreed toeneemt, is navigatie net zo belangrijk als de kwaliteit van het geschreven tekst.

Dit is iets voor jou als: je maandelijks tientallen updates uitbrengt voor verschillende productgebieden en je gebruikers slechts in een klein deel daarvan geïnteresseerd zijn. Filteren is dan de belangrijkste functie.

De afweging: Changelogs die vooral op structuur zijn gericht, komen onpersoonlijk over en missen een verhaal. Een gebruiker die per productgebied door de changelog bladert, krijgt nooit het grotere geheel te zien van de richting waarin het product zich ontwikkelt. Combineer dit met een driemaandelijks overzicht van ‘wat er is uitgebracht’ om de rode draad te behouden.

Superhuman: Koppen die de impact op de gebruiker benadrukken

Een op voordelen gerichte aantekening van Superhuman
Een op voordelen gerichte aantekening van Superhuman

Bij Superhuman staan bij aantekeningen over releases de resultaten voor de gebruiker centraal, in plaats van technische beschrijvingen.

In plaats van te zeggen: „Ondersteuning voor nieuwe snelkoppelingen toegevoegd“, schrijven ze: „Bereik sneller Inbox Zero met nieuwe snelkoppelingen voor uitstellen.“

Voor de meeste lezers is de kop zelf al de aantekening. Alleen degenen die de details willen weten, klikken verder.

De kern: Zorg dat de kop indruk maakt.

Gebruik dit als: je product duidelijke, meetbare resultaten voor gebruikers oplevert (sneller X, minder Y, bereik Z) en je wilt dat gebruikers de waarde ervan ervaren zonder dat ze zich door de pagina hoeven te klikken.

De afweging: Resultaatgerichte koppen vereisen een daadwerkelijk resultaat. Als de wijziging incrementeel of technisch van aard is, kom je al snel in de verleiding om de voordelen te overdrijven, en dat merken gebruikers. “Bereik sneller Inbox Zero” werkt omdat de functie daadwerkelijk resultaat oplevert; “Stroomlijn je werkstroom met onze nieuwe kleurenkiezer” werkt niet.

Verhoog de acceptatie met goed opgestelde release-aantekeningen

Release notes zijn een middel om klanten te behouden, vermomd als documentatie. Zorg voor de juiste prioritering (aankondigen, integreren, verbergen), begin met de impact op de gebruiker en kies kanalen die je consistent kunt beheren. De rest is bewerking.

En wanneer je taken, documenten, feedback en AI-hulpmiddelen voor het opstellen van release notes allemaal in dezelfde werkruimte staan, wordt het hele proces veel eenvoudiger te beheren. Als je team het beu is om te jongleren met tickets, documenten en Slack-threads om release notes te publiceren, begin dan gratis met ClickUp en voer de hele werkstroom uit in één werkruimte.

Veelgestelde vragen over het schrijven van release notes

Hoe lang moet een release-antekening zijn?

Houd individuele aantekeningen tussen de 50 en 300 woorden. Voor een kleine aanpassing volstaat één zin; complexe wijzigingen verdienen 2-3 zinnen plus een schermafbeelding of link. Linear beperkt de meeste updates tot één regel, omdat hun gebruikers technisch onderlegd zijn en het product een uitgesproken karakter heeft. Notion hanteert langere teksten omdat de wijzigingen visueel zijn en GIF’s vereisen. De lengte moet aansluiten bij de complexiteit van de wijziging, niet bij de standaardinstellingen van het sjabloon.

Hoe vaak moet je release-antekeningen publiceren?

Stem je releasecadans af op je productontwikkeling, niet op een marketingkalender. Teams die dagelijks updates uitbrengen (GitHub, Linear) bundelen deze in wekelijkse overzichten, zodat gebruikers niet overweldigd raken. Teams die maandelijks updates uitbrengen, publiceren per release. Je kunt kleine updates bundelen in een overzicht in plaats van voor elke fix een notificatie te versturen. Zorg voor voldoende frequentie om aan te geven dat het product verbetert, maar niet zo vaak dat gebruikers afhaken.

Moet je voor elke wijziging die je uitbrengt een release-aantekening schrijven?

Nee. Beoordeel elke wijziging eerst. Als een wijziging geen invloed heeft op het gedrag van de gebruiker of de interface, laat deze dan achterwege. Herontwerpen van de backend en interne optimalisaties horen thuis in de engineeringlogs. Aantekeningen over „prestatieverbeteringen“ zonder meetbare impact zorgen ervoor dat gebruikers toekomstige aankondigingen gaan negeren. Bewaar aantekeningen voor klanten voor wijzigingen die gebruikers zullen zien, merken of waarop ze zullen reageren. Documenteer de rest intern.

Hebben release notes invloed op SEO en de vindbaarheid van producten?

Ja, mits gepubliceerd op een geïndexeerde pagina. Een openbaar /changelog of /whats-new zorgt voor langetermijnzichtbaarheid voor functienamen, integraties en vergelijkende zoekopdrachten. GitHub, Linear en Notion indexeren allemaal hun changelogs, en bij zoekopdrachten op functienamen verschijnen die pagina’s vaak boven marketingteksten. Optimaliseer niet te veel voor zoekmachines, maar verberg ze ook niet achter inlogschermen of widgets die alleen met JavaScript werken.

Hoe schrijf je een goede aantekening over de release?

Een goede release-aantekening begint met een kop van één regel die de impact voor de gebruiker weergeeft (“Zoekresultaten worden 3x sneller geladen”), groepeert wijzigingen in 3–5 vaste categorieën (nieuwe functies, verbeteringen, fixes, bekende problemen, ingrijpende wijzigingen) en bevat links naar uitgebreidere documenten in plaats van alles in de tekst zelf uit te leggen. Schrijf elke regel vanuit het perspectief van het voordeel dat de gebruiker eruit haalt, niet vanuit de code die is gewijzigd. Stel de aantekening op in het ticket terwijl het werk wordt uitgevoerd en voer vervolgens een cross-functionele beoordeling uit voordat je deze publiceert.