Uitgaveopmerkingen

Uitgaveopmerkingen, release notes of versie-informatie is een term die door softwareontwikkelaars gebruikt wordt om aan te geven welke wijzigingen er zijn doorgevoerd in een bepaalde versie (release) van de software. Het begrip is verwant aan de term changelog, maar waar een changelog een levend document is dat permanent aangepast kan (en zal) worden, zijn release notes een afgerond document dat van toepassing is op een bepaalde versie van een programma of firmware.

Release notes hebben als doel de gebruikers van de betreffende software/applicatie op de hoogte te brengen van de (belangrijkste) wijzigingen in een bepaalde versie van die software. Ook andere belangrijke mededelingen met betrekking tot een bepaalde release kunnen deel uitmaken van de release notes. Release notes worden vaak meegestuurd met de betreffende software: als iemand bijvoorbeeld een bepaalde versie van firmware downloadt van de website van ene fabrikant, dan zijn de release notes soms opgenomen in het archiefbestand^[1] en daarnaast worden betreffende releasenotes ook los gepubliceerd.^[2]

Vaste onderdelen

Hoewel er geen vaste standaard is hoe release notes er uit moeten zien, bevatten ze vaak ten minste de volgende onderdelen:

1. reikwijdte of toepassing: waarop hebben deze release notes betrekking
2. afhankelijkheden of randvoorwaarden
3. nieuwe functionaliteiten toegevoegd in betreffende release
4. herstelde fouten uit eerdere releases
5. bekende tekortkomingen in deze release

Punt 3 en 4 zullen binnen de release notes voor elke (uitgegeven) tussenrelease herhaald worden, terwijl punt 5 normaliter alleen gegeven wordt voor zover van toepassing na deze release en zal dus slechts één keer in het document staan.

Versienummering

Afhankelijk van de manier waarop ontwikkelaars hun versiebeheer doen, geven release notes meestal een overzicht van alle bovenstaande punten die zijn doorgevoerd in alle versies die zijn uitgebracht in deze major release: als een softwarepakket of andere software een gelaagde versienummering heeft dan worden alle wijzigingen die binnen betreffende major release zijn doorgevoerd, opgenomen in de release notes en begint men opnieuw bij het uitbrengen van de volgende major release.

Bijvoorbeeld: een softwarefabrikant brengt een programma uit met als versienummer 4.3.14.a5 : hierbij is 4 het major release-nummer, het volgende karakter is de nummering die gebruikt wordt voor periodieke of geplande versies en de laatste twee velden vormen een laatste versieaanduiding van ongeplande versie (naar aanleiding van een bugfix en het buildnummer).

In bovenstaand voorbeeld zullen de release notes worden meegestuurd met elke tussenrelease. Bij de major release van een bepaald softwareproduct wordt normaliter een (eigen) handleiding geschreven, waarin alle functionaliteiten van de software beschreven staan. Normaliter zal er voor de volgende releases binnen dezelfde major release géén nieuwe handleiding gemaakt worden en alle wijzigingen ten opzichte van wat er in de handleiding staat beschreven worden daartoe in de release notes vermeld.^[3]