Iedereen die te maken heeft met het schrijven van product release notities vindt ze vervelend, saai, en tijdrovend. Je ziet vaak dat mensen er letterlijk voor weglopen. Maar vergeet niet dat het belangrijk is om product release notes te publiceren en je changelog up-to-date te houden voor de groei van je bedrijf. In dit artikel zullen we ook kijken naar release notes templates.
Naast het runnen van een changelog service, hebben we ook heel vaak te maken met release notes. We houden onze gebruikers op de hoogte van recente wijzigingen verbeteringen die we hebben aangebracht aan ons product. Daarom hebben we technieken ontwikkeld om het hele proces draaglijker en effectiever te maken.
- Wat zijn Release Notes?
- Wat is het probleem ermee?
- Tips voor het schrijven van release notes (met sjablonen)
- 1. Zij > Wij
- 2. Focus op de gebruiker
- 3. Volg eenvoudige release notes sjablonen
- 4. Vermijd te formeel
- 5. Expand then simplify
- Release notes voorbeelden
- Salesforce Release Notes Voorbeelden
- Key pro tips om eruit te halen:
- Salesforce volgt ook release notes templates.
- Sketch Release Notes Examples
- Getpostman Release Notes Examples
- Humor in release notes
Wat zijn Release Notes?
Release notes zijn een document in een opsommingsteken dat bij een software release wordt geleverd om gebruikers te vertellen wat er is veranderd. Hoewel er geen universeel formaat is, bevatten typische release notes informatie over bug fixes, nieuwe functies, en soms bekende problemen. Release notes kunnen een saai technisch document zijn dat niemand graag leest en schrijft. Maar onze missie als product manager, is om deze notities aantrekkelijker, interessanter en informatiever te maken.
Wat is het probleem ermee?
Drie belangrijke problemen met release notes zijn
– management,
– gebrekkige communicatie,
– en een distributiekanaal.
Het grootste probleem waar we mee te maken hebben is gebrekkige communicatie binnen het team. Zelfs in kleine bedrijven, vindt het technische team het moeilijk om uit te leggen wat er veranderd is. Vaak repareren ze iets, en een paar weken later zijn ze ook vergeten wat er deze maand is gedaan.
Wel, en de release notes taak overlaten aan het ontwikkelingsteam is ook een fout. Zij hebben de neiging om zeer technische release notes te schrijven voor mensen met een Ph.D. in computerwetenschappen.
Lezers interesseert het niet hoe iets is opgelost; ze geven alleen om het eindresultaat. Hoe kunnen ze profiteren van de update?
Tips voor het schrijven van release notes (met sjablonen)
Het onderwerp humor in release notes even buiten beschouwing latend voor later, kan het merendeel van de informatie in release notes worden gesjabloneerd in een begrijpelijke vorm. Dus, de volgende keer dat een ontwikkelaar u notities stuurt over een opgeloste bug of een nieuwe functie, zult u beiden tijd besparen.
Dus, in plaats van een opmerking van een ontwikkelaar te ontvangen die nergens op slaat. Je zult een dieper begrip hebben van wat er is veranderd en hoe je dit beter kunt communiceren naar de eindgebruikers.
Dus, hier komen we bij mijn persoonlijke lijst met tips en trucs die ik gebruik om geweldige release notes te maken! Laat je inspireren en schrijf je eigen product release notes templates! Software product release notes sjablonen zijn geweldige manier om tijd te besparen.
1. Zij > Wij
Begin niet met “Wij hebben dit gedaan”. Gebruikers geven er niet om wat JIJ hebt gedaan, ze geven alleen om wat ZIJ krijgen van wat jij hebt gedaan.
Je kunt nu .
Nieuw uitgebracht is beschikbaar voor uw gebruik. Nu zult u in staat zijn om
2. Focus op de gebruiker
Gebruik vaker “U”. Het is een copywriting-truc die de manier waarop de tekstuele informatie wordt waargenomen, onmiddellijk verandert. Ze zullen onbewust eerder geneigd zijn de tekst te lezen als ze “u” zien.
Groot nieuws voor u! laat u feedback van uw gebruikers verzamelen.
Gelukkig om aan te kondigen dat u helpt om data verlies te voorkomen.
Bespaar uw tijd met
3. Volg eenvoudige release notes sjablonen
Maak deze sjablonen en vraag u, ontwikkelaars, om uw notities alleen in dit formaat te schrijven. Op deze manier vermijd je misverstanden en weet je precies wat er veranderd is en hoe het werkt, en welke doelen het probeert te bereiken. Deze 4 sjablonen alleen al dekken 90% van alle release notes.
- Vorige X is nu Y
- Je kunt nu X doen in plaats van Y
- X doet niet langer X, Y als Z, Q, W
- X doet niet langer Y. Dit betekent dat u niet langer Z hoeft te doen
4. Vermijd te formeel
Het hangt natuurlijk af van de branding van uw bedrijf. Maar formele teksten zijn meestal lang en niet direct to the point. Dat maakt het voor lezers moeilijker om de tekst te scannen. Probeer consistent taalgebruik te hanteren en vermijd al te formele templates voor uw release notes-documenten.
5. Expand then simplify
Een goede release note is kort en bondig. Echter, om daar te komen uit te breiden van de tekst, zorg ervoor dat het weerspiegelt alles wat een nieuwe functie, een bug fix is alles over. Ook is veel van het schrijven van een release note het nemen van een grote hoeveelheid informatie en die in korte paragrafen persen. Zorg ervoor dat elke release notes niet uit zijn verband wordt gerukt.
Laten we eens kijken naar de beste Release notes voorbeelden. 3 bedrijven met geweldige Release Notes pagina’s en hoe kun je van hen leren?
👉Gerelateerd artikel: Alles wat u moet weten over belangrijke metrics in SaaS
Release notes voorbeelden
Salesforce Release Notes Voorbeelden
Salesforce is een CRM-platform met veel producten onder hun paraplu. Dus klanten op de hoogte houden van nieuwe functies en productwijzigingen is een hel voor technische schrijvers, productmanagers en ontwikkelaars.
Ik neem aan dat het bedrijf elk kwartaal release notes opstelt en dat deze “Salesforce Summer ’19 Release Notes” worden genoemd, een zeer uitgebreide pagina met release notes met categorieën en subcategorieën.
Salesforce release notes is een mix van reguliere release notes en productkaart. Het is een gedetailleerde uitleg van hoe elke functie gaat werken, en specifiek voor welke gebruikers ze beschikbaar zullen zijn.
Het voor de hand liggende voordeel van dergelijke uitgebreide release notes-pagina’s is het wegnemen van werk van de schouders van ondersteunende afdelingen. Bijvoorbeeld, als ze een vraag van een klant krijgen met betrekking tot een specifiek onderwerp. Zij kunnen hen eenvoudig doorverwijzen naar de pagina, waar gebruikers het antwoord kunnen vinden.
Key pro tips om eruit te halen:
1. Hoe de Release Notes-sectie te gebruiken
2. Gedetailleerde, visueel begrijpelijke tabellen met een product roadmap
3. Filtersectie
4. Gegeneraliseerde uitleg, gegeneraliseerde uitleg en dan gevolgd door een gedetailleerde beschrijving van hoe een nieuwe functie werkt.
Salesforce volgt ook release notes templates.
Stap 1: Leg uit wat de nieuwe functie inhoudt.
U hoeft niet langer over te schakelen naar Salesforce Classic om gebiedstoewijzingen te beheren op de pagina Account. U kunt nu de gerelateerde lijst Toegewezen territoria bewerken in Lightning Experience. Voorheen was de gerelateerde lijst alleen-lezen in Lightning Experience.
U hoeft niet langer uit te voeren . U kunt nu . Voorheen kon u alleen .
Stap 2: Leg uit hoe u de functie kunt inschakelen of openen
Waar: Deze wijziging is van toepassing op Lightning Experience in Performance- en Developer-edities en Enterprise- en Unlimited-edities met de Sales Cloud.
Stap 3: Leg uit hoe u de functie kunt gebruiken
Hoe: Als de lay-out van uw Account-pagina de gerelateerde lijst Toegewezen territoria bevat, is er geen setup vereist. Klik op Territoria toewijzen en wijs toe om toewijzingen te beheren.
Sketch Release Notes Examples
Als uw product niet zo ingewikkeld is en geen platform is met een grote paraplu aan subtools, kijk dan eens naar Sketch company.
De lay-out is interessant. Aan de rechterkant heb je een gedetailleerde beschrijving van alle nieuwe functies en bug fixes en aan de linkerkant, zijn er de belangrijkste grote functies beschrijvingen. En CTA.
Smart Distribute Upgrades
U kunt nu Smart Distribute gebruiken om de spatiëring in rasters te regelen. U kunt eenvoudig de verticale afstand tussen rijen van lagen aanpassen, evenals de horizontale afstand tussen elke laag in een rij. We hebben ook een nieuwe knop ‘Opgeruimd’ toegevoegd aan de Inspector. Hiermee wordt een selectie van meerdere lagen snel uitgelijnd in een net raster, waardoor het nog eenvoudiger wordt om complexe lay-outs te maken en te beheren.
Opnieuw zien we een eenvoudig sjabloon:
U kunt nu . U kunt eenvoudig . We hebben ook een nieuw .
In verbeteringen:
We hebben een nieuwe opdracht Alles selecteren op artboard toegevoegd aan het menu Bewerken, zodat u snel alle lagen op een artboard kunt pakken die u hebt geselecteerd. We hebben ook de verschillende opdrachten Alles selecteren een eigen submenu gegeven.
- We hebben , toegevoegd zodat je nu .
- Een crash is verholpen die kon optreden wanneer je probeert te slepen om te selecteren met het gereedschap Toverstaf.
- Een bug is verholpen waarbij niet het juiste typegewicht werd weergegeven voor lettertypen met dezelfde naam.
– Een bug in de lijsten Pagina’s en Lagen verholpen waarbij selecties niet correct werden gemarkeerd wanneer deze waren aangesloten op een extern beeldscherm.
Dus, terugkomend op gebruikersgerichte release notes, we moeten begrijpen dat we onze release notes schrijven voor ons doelpubliek. Salesforce schrijft hun releases voor mensen zonder technische achtergrond, voor verkoopafdelingen en marketeers, ondernemers, oprichters, enz.
Sketch wordt gebruikt door grafisch ontwerpers en kunstenaars. Zowel Salesforce als Sketch gebruiken dus een generieke toon, zeer gebruiksvriendelijk, gericht op echte mensen.
Getpostman Release Notes Examples
Als je product technisch is en je gebruikers zijn ontwikkelaars, dan is het omgekeerde een vuistregel. Hoe korter, technischer en niet visueel aantrekkelijker, hoe beter.
Zo is Getpostman een technisch product voor ontwikkelaars.
Release notes kunnen snel worden doorgebladerd om een algemeen idee te krijgen van wat er nieuw is. En het volgt een zeer simplistisch formaat.
Update nummer, datum, en informatie in één zin over elke update zonder details over wat het betekent voor een gebruiker, hoe het te gebruiken of hoe het te openen.
Hoe eenvoudiger hoe beter. Ze zullen het begrijpen.
Humor in release notes
We hebben het al gehad over voorbeelden van in-app release notes die hilarisch en vermakelijk zijn om te lezen. De tone of voice is echter niet geschikt voor de meerderheid van de tech-bedrijven. En zij hebben een stijlgids nodig voor Release Notes. Bovendien heeft niet elk software product een mobiele versie en de meerderheid van de bedrijven publiceren hun release notes op een aparte pagina ergens onder support of help sectie. (Bedrijven begraven hun release notes strategisch en klagen vervolgens dat niemand ze leest.)
Er zijn veel slimme manieren om productupdates aan te kondigen. Bijvoorbeeld door een mooie e-mail te schrijven om productupdates te introduceren of een aparte blogpost te maken.
👉 Gerelateerd artikel: De beste en de slechtste app Release Notes die je zullen inspireren
Zoals bij alles in het leven, door structuur en organisatie aan te brengen, evenals moderne technologieën, creëren we een eenvoudigere oplossing, die niet zo saai en onnodig is.
Hopefully our sample software release notes templates
and examples helped you.