Effektív termékkiadási jegyzetek írása (+valódi példák és sablonok)

Mindenki, aki termékkiadási jegyzetek írásával foglalkozik, unalmasnak, unalmasnak és időigényesnek találja azokat. Gyakran látni, hogy az emberek szó szerint menekülnek előlük. De ne feledje, hogy fontos a termékkiadási jegyzetek közzététele és a changelog naprakészen tartása az üzleti növekedése érdekében. Ebben a cikkben a kiadási jegyzetek sablonjait is megvizsgáljuk.

A changelog szolgáltatás működtetése mellett mi is gyakran foglalkozunk kiadási jegyzetekkel. Folyamatosan tájékoztatjuk felhasználóinkat a legutóbbi változtatásokkal kapcsolatos fejlesztésekről, amelyeket a termékünkön végeztünk. Ezért olyan technikákat fejlesztettünk ki, amelyekkel az egész folyamatot elviselhetőbbé és hatékonyabbá tehetjük.

Mi is az a kiadási jegyzet?

A kiadási jegyzet egy felsorolásszerű dokumentum, amely egy szoftver kiadása mellé kerül, hogy elmondja a felhasználóknak, mi változott. Bár nincs univerzális formátum, a tipikus kiadási jegyzetek tartalmaznak információkat a hibajavításokról, új funkciókról és néha ismert problémákról. A kiadási megjegyzések unalmas technikai dokumentumok lehetnek, amelyeket senki sem szeret olvasni és írni. Termékmenedzserként azonban az a feladatunk, hogy ezeket a jegyzeteket vonzóbbá, érdekesebbé és informatívabbá tegyük.

Mi a probléma velük?

A kiadási jegyzetekkel kapcsolatos három fő probléma a
– menedzsment,
– a megszakadt kommunikáció,
– és a terjesztési csatorna.

A legnagyobb probléma a csapaton belüli kommunikáció hiánya. Még a kis cégeknél is nehézséget okoz a technikai csapatnak elmagyarázni, hogy mi változott. Gyakran kijavítanak valamit, és néhány héttel később azt is elfelejtik, hogy mit csináltak ebben a hónapban.
Hát, és a release notes feladatot a fejlesztői csapatra hagyni szintén hiba. Hajlamosak nagyon technikai kiadási jegyzeteket írni az informatikából doktorált emberek számára.
Az olvasókat nem érdekli, hogyan javítottak valamit; csak a végeredmény érdekli őket. Hogyan profitálhatnak a frissítésből?

Tippek a kiadási jegyzetek megírásához (sablonokkal)

A kiadási jegyzetek humorának témáját későbbre félretéve, a kiadási jegyzetek információinak többsége érthető formába hozható sablonokkal. Így legközelebb, amikor egy fejlesztő jegyzeteket küld neked egy kijavított hibáról vagy egy új funkcióról, mindketten időt takaríthattok meg.
Ahelyett tehát, hogy olyan megjegyzést kapnál egy fejlesztőtől, aminek semmi értelme. Mélyebben meg fogod érteni, hogy mi változott, és hogyan tudod azt jobban kommunikálni a végfelhasználók felé.
Szóval, itt jön az én személyes tippjeim és trükkjeim listája, amelyeket a nagyszerű kiadási jegyzetek elkészítéséhez használok! Inspirálódjon, és írja meg saját termékkiadási jegyzet sablonjait!. A szoftver termékkiadási jegyzet sablonok nagyszerű módja annak, hogy időt takarítson meg.

1. Ők > Mi

Ne kezdje azzal, hogy “ezt már megtettük”. A felhasználókat nem érdekli, hogy TE mit tettél, őket csak az érdekli, hogy ŐK mit kapnak abból, amit te tettél.

Most .
Újonnan megjelent az Ön használatára. Mostantól képes leszel

2. Koncentrálj a felhasználóra

Használd gyakrabban a “TE” szót. Ez egy olyan szövegírói trükk, amely azonnal átalakítja a szöveges információ érzékelését. Tudat alatt nagyobb valószínűséggel fogják elolvasni a szöveget, ha az “Ön”-t látják.

Nagyszerű hír az Ön számára! lehetővé teszi, hogy összegyűjtse a felhasználók visszajelzéseit.
Boldog bejelentés, amely segít elkerülni az adatvesztést.
Takarítson meg időt az

3. Kövesse az egyszerű kiadási jegyzetek sablonjait

Készítsen ilyen sablonokat, és kérje meg Önt, a fejlesztőket, hogy csak ebben a formátumban írják meg a jegyzeteket. Így elkerülhetitek a félreértéseket, és pontosan tudni fogjátok, hogy mi változott, hogyan működik, és milyen célokat próbál elérni. Csak ez a 4 sablon lefedi a kiadási jegyzetek 90%-át.

• A korábbi X most már Y
• Most már X helyett Y
• Az X már nem X, Y ha Z, Q, W
• Az X már nem Y. Ez azt jelenti, hogy többé nem kell Z-t tennie

4. Kerülje a túlzott formalitást

Ez persze a vállalat márkájától függ. A hivatalos írás azonban általában hosszú és nem egyenesen a lényegre törő. Így megnehezíti az olvasók számára a szöveg átolvasását. Próbáljon következetes nyelvezetet használni, és kerülje a túlságosan formális megfogalmazást a kiadási jegyzetek dokumentumsablonjaiban.

5. Bővítse, majd egyszerűsítse

A jó kiadási jegyzet rövid és tömör. Ahhoz azonban, hogy ezt elérd, bővítsd ki a szöveget, győződj meg róla, hogy az tükrözi mindazt, amiről egy új funkció, egy hibajavítás szól. Emellett a kiadási jegyzetek megírásának nagy része abból áll, hogy nagy mennyiségű információt veszünk, és rövid bekezdésekbe sűrítjük. Győződjön meg róla, hogy minden egyes kiadási jegyzetet nem ragad ki a szövegkörnyezetéből.

Nézzük meg a legjobb kiadási jegyzet példákat. 3 vállalat nagyszerű Release Notes oldalakkal és hogyan tanulhatsz tőlük?

👉Kapcsolódó cikk: Minden, amit a SaaS legfontosabb mérőszámairól tudni kell

Release Notes példák

Salesforce Release Notes példák

A Salesforce egy CRM platform, amelynek égisze alatt számos termék található. Így az ügyfelek naprakészen tartása az új funkciókról és termékváltozásokról a technikai írók, termékmenedzserek és fejlesztők számára maga a pokol.
Feltételezem, hogy a vállalat negyedévente készít kiadási jegyzeteket, és a “Salesforce Summer ’19 Release Notes” nevet viseli, ami egy nagyon átfogó kiadási jegyzet oldal a kategóriáival és alkategóriáival.
A Salesforce kiadási jegyzetek a rendszeres kiadási jegyzetek, valamint a terméktérkép keveréke. Ez egy részletes magyarázat arról, hogy az egyes funkciók hogyan fognak működni, és konkrétan mely felhasználók számára lesznek elérhetőek.

Az ilyen átfogó release notes oldalak nyilvánvaló előnye, hogy leveszik a munkát a támogatási részlegek válláról. Például, ha egy adott témával kapcsolatban ügyfélkérdést kapnak. Könnyedén átirányíthatják őket arra az oldalra, ahol a felhasználók megtalálják a választ.

Főbb profi tippek, amelyeket ki kell venni:

1. Hogyan használjuk a kiadási megjegyzések részt

2. Részletes, vizuálisan érthető táblázatok a termék útitervével

3. Hogyan használjuk a kiadási megjegyzések részt? Szűrő szakasz

4. Általános magyarázat, általános magyarázat, majd ezt követi az új funkció működésének részletes leírása.

A Salesforce is követi a kiadási jegyzetek sablonjait.

1. lépés: Magyarázza el, miről szól az új funkció.
Nem kell többé a Salesforce Classic szolgáltatásra váltania, hogy a fiókoldalon kezelje a területi hozzárendeléseket. Mostantól a Lightning Experience-ben szerkesztheti a Hozzárendelt területek kapcsolódó listát. Korábban a kapcsolódó lista csak olvasható volt a Lightning Experience-ben.

Nem kell többé . Mostantól elvégezheti a . Korábban csak .

2. lépés: Magyarázat a funkció engedélyezéséről vagy eléréséről
Hol: Ez a változás a Lightning Experience teljesítmény- és fejlesztői kiadásokban, valamint az Enterprise és Unlimited kiadásokban az értékesítési felhővel rendelkező Lightning Experience-re vonatkozik.

3. lépés: Magyarázza el, hogyan használja a funkciót
Hogyan: Ha a fiókoldal elrendezése tartalmazza a hozzárendelt területek kapcsolódó listát, nincs szükség beállításra. Kattintson a Területek hozzárendelése és a hozzárendelésre a hozzárendelések kezeléséhez.

Sketch kiadási jegyzetek példái

Ha az Ön terméke nem olyan bonyolult és nem egy platform, amely aleszközök nagy ernyőjével rendelkezik, nézze meg a Sketch céget.
Az elrendezés érdekes. A jobb oldalon van egy részletes leírás az összes új funkcióról és hibajavításról, a bal oldalon pedig a főbb nagy funkciók leírása. És CTA.

Smart Distribute Upgrades

A Smart Distribute segítségével mostantól szabályozhatja a rácsok távolságát. Könnyedén beállíthatja a rétegsorok közötti függőleges távolságot, valamint az egyes rétegek közötti vízszintes távolságot egy sorban. Az Ellenőrbe egy új ‘Rendezés’ gombot is bevezettünk. Ez gyorsan rendezett rácsba igazítja a több rétegből álló kijelölést, így még egyszerűbbé teszi az összetett elrendezések létrehozását és kezelését.

Ismét egy egyszerű sablont látunk:
Most . Könnyedén megteheti . Bevezettünk egy új .

A fejlesztések:
Elhelyeztünk egy új Mindent kijelölni a műtáblán parancsot a Szerkesztés menübe, így gyorsan megragadhatja az összes réteget bármelyik kijelölt műtáblán. A különböző Mindent kijelölés parancsoknak is saját almenüvel láttuk el.

• Elhelyeztük a , így mostantól a .
• Kijavítottuk azt az összeomlást, amely akkor fordulhatott elő, ha a varázspálca eszközzel próbáltunk húzni a kijelöléshez.
• Kijavítottuk azt a hibát, amikor az azonos nevű betűtípusok esetében nem a megfelelő betűsúly jelent meg.

– Kijavított egy hibát az Oldalak és réteglistákban, ahol a kijelölések nem voltak megfelelően kiemelve, ha külső kijelzőhöz csatlakoztattuk őket.

Szóval, visszatérve a felhasználó-orientált kiadási jegyzetekhez, meg kell értenünk, hogy a kiadási jegyzeteinket a célközönségünknek írjuk. A Salesforce a kiadványait a technikai háttérrel nem rendelkező emberek számára írja, az értékesítési osztályoknak és marketingeseknek, vállalkozóknak, alapítóknak stb.

A vázlatot grafikusok és művészek használják. Így mind a Salesforce, mind a Sketch általános hangnemet használ, nagyon felhasználóbarát, valós emberekhez igazodva.

Getpostman Release Notes példák

Ha a terméked technikai jellegű, a felhasználóid pedig fejlesztők, akkor az ellenkezője az ökölszabály. A rövidebb, technikai jellegű, vizuálisan nem vonzó jobb.

A Getpostman például egy technikai termék fejlesztőknek.

A kiadási jegyzeteket gyorsan át lehet lapozni, hogy általános képet kapjunk az újdonságokról. És nagyon leegyszerűsített formátumot követ.

Frissítés száma, dátuma és egy mondatban információ minden egyes frissítésről, anélkül, hogy részleteznénk, mit jelent ez a felhasználó számára, hogyan kell használni, vagy hogyan lehet hozzáférni.

Minél egyszerűbb, annál jobb. Meg fogják érteni.”

Humor a kiadási megjegyzésekben

Már beszéltünk olyan alkalmazáson belüli kiadási megjegyzésekre vonatkozó példákról, amelyeket vicces és szórakoztató olvasni. A hangnem azonban a technológiai cégek többségének nem megfelelő. Pedig szükségük lenne egy stílusirányzatra a kiadási jegyzetekhez. Ráadásul nem minden szoftverterméknek van mobilverziója, és a cégek többsége külön oldalon teszi közzé a kiadási jegyzeteket valahol a support vagy a help részleg alatt. (A cégek stratégiailag eltemetik a kiadási jegyzeteiket, majd panaszkodnak, hogy miért nem olvassa őket senki.)

A termékfrissítések bejelentésének számos okos módja van. Például írj egy nagyszerű e-mailt a termékfrissítések bemutatására, vagy készíts külön blogbejegyzést.

👉 Kapcsolódó cikk:

Mint mindenben az életben, a struktúra és a szervezettség, valamint a modern technológiák bevonásával könnyebb megoldást hozunk létre, ami nem olyan unalmas és felesleges.

Mintás szoftverkiadási jegyzet sablonjaink
és példáink remélhetőleg segítettek neked.

Mintás szoftverkiadási jegyzet sablonjaink
és példáink.