Release notes in de praktijk
Hoe teams release notes schrijven die mensen echt lezen.
Begin hier: Hoe schrijf je release notes die mensen echt lezen, Wat is een changelog? Definitie en voorbeeldentry, Changelog vs release notes: wat is het verschil?
-
Software release notes: wat ze zijn en wat erin hoort
Software release notes vertellen wat er in een versie veranderde, wie het raakt en wat je moet doen. De vier soorten, wat erin hoort en een voorbeeld.
Release notes in de praktijk5 min lezen
-
Bugfix release notes schrijven die mensen gebruiken
Bugfix release notes werken als elke entry het symptoom, de getroffenen en de volgende stap noemt. Voor-en-na-herschrijvingen en regels voor beveiliging.
Release notes in de praktijk7 min lezen
-
Release notes voorbeelden voor elk soort wijziging
Release notes voorbeelden voor een feature, fix, breaking change, beveiligingsfix, deprecatie, app-storenote en interne note, met telkens waarom het werkt.
Release notes in de praktijk7 min lezen
-
Noodrelease notes: schrijven onder echte tijdsdruk
Een door een incident gedreven release heeft notes nodig in minuten, niet dagen, en het gebruikelijke schrijfproces gaat uit van tijd die je niet hebt.
Release notes in de praktijk5 min lezen
-
Interne release notes: wie het nog meer moet weten
Support en sales horen over een lancering meestal van een verwarde klant. Interne release notes lossen dat op, in een andere vorm dan de klantgerichte.
Release notes in de praktijk5 min lezen
-
Mobiele app release notes: limieten App Store, Google Play
App Store-notes mogen 4.000 tekens, Google Play 500, en beide tonen een paar regels zonder links. Wat de limiet wegsnijdt, en hoe je bewust snijdt.
Release notes in de praktijk4 min lezen
-
Nieuwe feature aankondigen: templates en hoe je schrijft
De meeste featureaankondigingen sterven in een kanaal dat niemand twee keer leest. Waar je aankondigt, wat je eerst zegt, wie je moet bereiken.
Release notes in de praktijk5 min lezen
-
Enterprise release notes: wat verandert voor één account
Enterprise release notes voor een klant op een private build moeten bij zijn instantie passen. Verkeerd afstemmen lekt de roadmap of verwart de support.
Release notes in de praktijk5 min lezen
-
Wat is een changelog? Definitie en voorbeeldentry
Een changelog is het gedateerde overzicht van wat er in een product veranderde, voor gebruikers. Definitie, voorbeeldentry en een sjabloon om te kopiëren.
Release notes in de praktijk6 min lezen
-
De product-update e-mailtemplate die gelezen wordt
De product-update e-mail die gelezen wordt, ging naar iemand die erom vroeg. Een template, de vier soorten e-mail, werkende onderwerpregels en toestemming.
Release notes in de praktijk6 min lezen
-
Changelog vs release notes: wat is het verschil?
Een changelog is een doorlopend register voor wie iets opzoekt. Release notes zijn een gecureerd bericht voor wie beslist of het telt. Wat het verschil is.
Release notes in de praktijk5 min lezen
-
Hoe schrijf je release notes die mensen echt lezen
«Bugfixes en prestatieverbeteringen» is geen release note. De vraag die elke entry moet beantwoorden, plus het herschrijven van een echte release note.
Release notes in de praktijk7 min lezen
-
Beste practices voor release notes die het waard zijn
De meeste lijsten met beste practices zijn stijladvies. Deze veranderen wat de lezer doet, plus drie populaire regels die pure cargocultus zijn.
Release notes in de praktijk6 min lezen