6 tips bij het schrijven van release notes

Het product is de deur uit en nu komen de verbeteringen. Nou ja, er zijn ook links en rechts nogal wat foutjes opgelost. En van de product manager moest die nieuwe functionaliteit er echt in. De testers gebruiken gelukkig een applicatie die de bugs en hun status moeiteloos uitspuwt. En de functionaliteit wordt net op tijd ingebouwd. Nu nog even de release notes en dan is deze sprint ook weer tot een goed einde gebracht.

release notes

Ja, ja, even snel wat release notes over de schutting gooien. Dat is om meerdere redenen niet goed.  Want wat wil je met die release notes bereiken?

  • Laten zien dat je trots bent op het product.
  • Laten zien dat alles onder controle is.
  • De gebruiker laten delen in het gemak van nieuwe functionaliteit.
  • De gebruiker blij maken met opgeloste bugs.

Dit rijtje kan nog veel langer, maar dat is niet nodig. Uiteindelijk gaat het in release notes om een goede representatie van:

  • Nieuwe functionaliteit
  • Opgeloste bugs
  • Verbeteringen

Op al deze items kun je punten scoren bij je klanten.

  1. Publiek: voor wie schrijf je? De eindgebruiker, de product manager, de ontwikkelaar? Pas je taal op de doelgroep aan en ga uit van feitelijk en eenvoudig. Weet ook dat release notes voor ontwikkelaars en eindgebruikers vanaf kennisniveau en invalshoek niet in hetzelfde document kunnen.
  2. Timing: De informatie voor release notes komt uit verschillende hoeken om moet door een redacteur tot een fraai geheel worden gevormd. Zorg dat hier tijd voor is. En weet wanneer de release notes verstuurd moeten worden.
  3. Redactie: Gooi geen rijstebrijberg over de schutting, maar verdeel de release notes in nieuwe functionaliteit, opgeloste bugs en verbeteringen. Zorg voor een strak opgezet document. Dit geeft de lezer een beter overzicht. Hij weet waar hij moet zoeken.
  4. Blijf feitelijk: Het is niet erg om de release notes de lof te laten zingen van je product. Verkoop echter geen loze praat. Overdrijf niet. De lezer wil in de eerste plaats de feiten.
  5. Vertel een verhaal: Bij verbeteringen en nieuwe functionaliteit kun je de context schetsen. Dus niet alleen het ‘wat’, maar ook het ‘waarom’. Op deze manier betrek je de klant bij je product en kun je ook aan klantenbinding doen.
  6. Verspreiding: de release notes staan niet op zichzelf. Onderdelen eruit kun je gebruiken voor een nieuwsbrief, een blog of een product tour. Ook belandt dit document op de bureaus van de helpdeskmedewerkers. Als documentalist gebruik je onderdelen voor de volgende versie van de product documentatie.

 

Geef een reactie

Vul je gegevens in of klik op een icoon om in te loggen.

WordPress.com logo

Je reageert onder je WordPress.com account. Log uit /  Bijwerken )

Google photo

Je reageert onder je Google account. Log uit /  Bijwerken )

Twitter-afbeelding

Je reageert onder je Twitter account. Log uit /  Bijwerken )

Facebook foto

Je reageert onder je Facebook account. Log uit /  Bijwerken )

Verbinden met %s

Blog op WordPress.com.

Omhoog ↑

%d bloggers liken dit: