Ez az oldal teljesen fejlesztés alatt áll!
Az Online Műszaki Írás ingyenes marad.Az alábbi információ engedéllyel lett átvéve az appcues.com egyik cikkéből (lásd alább).
Miért nem olvassák el a legtöbb kiadási megjegyzést (és hogyan lehet ezt orvosolni)
A legtöbb kiadási megjegyzés olvashatatlan. Nem azért, mert a felhasználók nem törődnek azzal, mi változik a termékben, hanem mert a megjegyzéseket azoknak a csapatoknak írták, akik a funkciót kiadták, nem pedig annak a személynek, aki értelmezni szeretné.
Valószínűleg már láttál ilyet: egy kiadási megjegyzést, ami azzal kezdődik, hogy "Fejlesztettük az adatmegőrzési réteget a nagyobb áteresztőképesség érdekében", miközben a felhasználónak valójában azt kellett volna hallania, hogy "A jelentéseid most kétszer annyira gyorsan töltődnek be." Az első verzió kipipál egy négyzetet. A második serkenti a használatot.
Az a rés sokkal fontosabb, mint a legtöbb csapat észreveszi. A kiadási megjegyzés egy termék kommunikációs pillanat. Ez az ablak a szállítás és az elfogadás között. Ha jól csinálod, a felhasználók felfedezik azt, amit építettél. Ha elmulasztod, a funkció akár el sem készült volna.
Ez a cikk megadja, amire szükséged van a rés áthidalásához: 13 kiadási megjegyzés példa olyan cégektől, akik ezt jól csinálják (rendezve aszerint, hogy miért érdemes tanulmányozni őket), egy sablon, amelyet átvehetsz és ma adaptálhatsz, valamint egy lépésről lépésre írási útmutató, amely lefedi az alapokat. Akár termékmenedzser vagy, aki az első kiadási megjegyzését írja, akár termékmarketinges, aki finomítja a folyamatot, olyan dolgot viszel haza, amit azonnal használhatsz.
Mik azok a kiadási megjegyzések?
A kiadási megjegyzés egy rövid, felhasználók számára készült jelentés, amelyet új vagy frissített szoftverekkel együtt tesznek közzé. Elmagyarázza, mi változott, miért fontos, és kit érint. Az új kiadások esetében a kiadási megjegyzések összefoglalják, mit tud a termék. A meglévő termékek frissítésekor a megjegyzések ismertetik, mi az új, mi javult, és mi lett javítva az utolsó verzió óta.
Kibocsátási megjegyzések példa a korábbi kiadásokra
Kiadási megjegyzések vs. változásnapló
A kifejezéseket felcserélhetően használják, de különböző dolgokról van szó. A kiadási megjegyzések részletesen leírják a konkrét verziót vagy frissítést: mi változott, miért fontos, kit érint. Érdemes megérteni a changelog és a kiadási megjegyzések közötti különbséget: a changelog az összes kiadási megjegyzés folyamatos nyilvántartása az időben. Gondolj rá, mint az archívumra. Sok termék fenntartja mindkettőt: egyedi kiadási megjegyzéseket minden frissítéshez, és egy changelog oldalt, ahol ezek mind együtt élnek fordított időrendben.
A folyamatos nyilvántartás vezetése fontos. Ez megmutatja az ügyfeleknek, hogy a termék folyamatosan fejlődik, és a legújabb változások az előzőekre építenek. Ezenkívül jelzi, hogy a cég figyelembe veszi a visszajelzéseket, és elkötelezett a felhasználói élmény iránt.
Kiadási megjegyzések típusai
Nem minden frissítés érdemel ugyanakkora figyelmet. A kiadási megjegyzések formátuma és mélysége megfelelően kell tükrözze a változás terjedelmét:
Főbb kiadási megjegyzések: Új funkciók, jelentős felhasználói felület változások, új lehetőségek. Ezek alaposabb tárgyalást érdemelnek vizuális elemekkel, a változás okának kontextusával és világos útmutatással arról, hogyan kell használni őket.
Kisebb frissítési megjegyzések: Fokozatos fejlesztések, apró UX módosítások. A rövidebb formátum itt működik, jellemzően egytől három vonalig terjedő elemenként.
Hibajavítási megjegyzések: Megoldott problémák. Lista formátumban, egyszerű nyelven, a felhasználói tapasztalatok hangsúlyozásával, ami korábban történt, és ami most történik.
Biztonsági javítási értesítők: Rövid és tényszerű. Prioritásban a sebezhető elemek és a javított problémák álljanak, technikai részletek nélkül, amelyek zavarodottságot okozhatnak.
Miért fontosak a kiadási megjegyzések
Ők a híd a szállítás és a használat között. Azok a felhasználók, akik értik, mi változott, nagyobb valószínűséggel fedezik fel és fogadják el az új funkciókat. A kiadási megjegyzések a termék kommunikációs pillanata, ahol lefordítod, amit a mérnöki csapat épített, olyasmire, amit a felhasználó valóban ki szeretne próbálni. Enélkül a fordítás nélkül a funkciók észrevétlenek maradnak, és a funkciók elfogadása szenved, mivel a csapatod által befektetett erőfeszítés nem éri el a potenciálját.
Csökkentik a támogató csapatod munkaterhét. A proaktív kiadási megjegyzések csökkentik a beérkező kérdéseket arról, hogy miért néz ki valami másképp vagy miért működik másképp. Amikor a felhasználók olyan változással találkoznak, amire nem számítottak, támogatási jegyet nyitnak. Amikor már olvastak egy világos magyarázatot, nem teszik. A matematika egyszerű: dokumentáld a változást, mielőtt a felhasználók véletlenül belefutnának.
Bizalmat és megtartást építenek a vásárlók között. A látható, rendszeres kiadási megjegyzések azt jelzik, hogy a termék folyamatosan fejlődik. Azok számára, akik azt mérlegelik, hogy megújítsák vagy bővítsék, egy egészséges változásnapló bizonyíték arra, hogy a termék fejlődik. Azok számára, akik funkciókérésüket benyújtották, a visszajelzésük kiadási megjegyzésekben való tükröződése mélyíti a hűséget.
Élesítik a belső összhangot. A jó kiadási megjegyzések írásának tudománya, amely kifejezetten arra válaszol, hogy "mi változott, kinek, és miért fontos ez," arra kényszeríti a termékcsapatokat, hogy világosan kommunikáljanak a szervezeten belül. A termékmarketing, az ügyfélsiker és az értékesítés mind előnyére válik, amikor a kiadási kommunikációk tömörek és következetesek. A kiadási megjegyzés gyakran az az igazság forrásává válik, amelyre más csapatok hivatkoznak, amikor az ügyfelekkel beszélnek az újdonságokról.
Mit kell belefoglalni a kiadási megjegyzésekbe
Gondolj erre a kiadási megjegyzés anatómiájaként. Minden jó kiadási megjegyzés lefedi ezeket az elemeket, bár a részletesség változik attól függően, hogy egy jelentős funkciót vagy egy rutinszerű hibajavítást jelentesz be:
Fejléc sor: Termék neve, verziószám vagy dátum, és környezet, ha releváns (web, iOS, API stb.).
A változások összefoglalása: Egy vagy két mondat arról, hogy ez a kiadás mit érint és kire van hatással. Ez a rész az, amit a felhasználók először olvasnak, ezért legyen figyelemfelkeltő.
Új funkciók: Nevesített, rövid felhasználói hatással. Azzal kezdj, hogy mit tehet most a felhasználó, ne a technikai megvalósítással.
Fejlesztések: Mi változott a felhasználó szempontjából. "A keresési eredmények most 40%-kal gyorsabban töltődnek be" jobb, mint "Optimalizált keresési indexelési folyamat."
Hibajavítások: Egyszerű nyelvű leírás arról, amit a felhasználó korábban tapasztalt, és arról, hogy mi történik most. "A műszerfal már nem fagy le dátumtartomány szerinti szűréskor" pontosan elmondja a felhasználónak, mi volt a probléma, és hogy ez megoldódott.
Ismert problémák vagy korlátozások: Ha valami nincs teljesen megoldva, jelezd ezt. A felhasználók jobban tisztelik az átláthatóságot, mint ahogy neheztelnének a tökéletlenségre.
Hogyan írjunk kiadási jegyzeteket
Amit bele kell foglalni, az alap. Az, ahogyan írod, meghatározza, hogy valaki valóban elolvassa-e. Ezeket a hét lépést sorrendbe állítottuk a folyamatosság érdekében: kezdj azzal, hogy mit mondj, utána hogyan mondd el, végül pedig hogyan mutasd be.
1. A felhasználóra összpontosíts, ne a funkcióra
Ez a legfontosabb elv a kiadási megjegyzések írásában. Minden változást egy probléma megoldására vagy a felhasználó számára egy képesség felszabadítására építettek. Ezzel kezdj!
Az ösztön azt diktálja, hogy írd le, mit épített a csapatod. Ellenállj ennek. Inkább írd le, mit tud most tenni a felhasználó (vagy mivel már nem kell foglalkoznia).
Előtte: "Csoportos feldolgozást valósítottunk meg az adatexportok számára, konfigurálható darabméretekkel."
Mostantól nagy adatállományokat exportálhatsz anélkül, hogy a folyamat időtúllépne. Az exportok, amelyek korábban 10 000 sor után meghiúsultak, most akár 500 000 sort is kezelnek.
Az első verzió a mérnöki munkát írja le. A második a felhasználói élményt írja le. Írd meg a második verziót.
2. Tegye világossá a változás szándékát.
A felhasználók, akik a kiadási megjegyzéseket átnézik, két dolgot szeretnének: mi változott, és hogy ez őket érinti-e. Az első mondatban egyértelműen tüntessük fel mindkét választ.
A világosság fontos, mert a webfelhasználók nem lineárisan olvasnak. Átnézik. Tehát tedd a kiadási megjegyzéseidet átnézhetővé. Emeld ki a fontos kulcsszavakat. Használj félkövér szöveget a funkciónevekhez és a változtatások típusaihoz. Helyezd a legfontosabb információt minden sor elejére.
Előtte: "Hiba javítva és frissítések alkalmazva."
A következőket javítottuk: „Javítottunk egy hibát, amely váratlan összeomlásokat okozott az alkalmazások közötti váltáskor. Az alkalmazásváltás mostantól stabil minden támogatott eszközön.”
Az első verzió rövid, de nem mond semmit a felhasználónak. A második még mindig tömör, de válaszol a felhasználó valódi kérdéseire.
3. Használj egyszerű nyelvet
A kiadási jegyzetek különböző célokat szolgálhatnak: új funkciók népszerűsítése, kapcsolatépítés a felhasználóval, segítségnyújtás az embereknek a megoldások megtalálásában. De egyik sem működik, ha a jegyzetek tele vannak olyan szakmai zsargonnal, amit csak a mérnöki csapatod ért.
Hacsak nem tudod, hogy a közönséged könnyen megérti a szakszótárt, ne használj túl sok zsargont. Használj egyszerű, érthető megfogalmazásokat. Egy jó teszt: olvasd fel a kiadási megjegyzéseket valakinek, aki nem ismeri a technikai hátteret. Ha ő megérti, a felhasználóid is fogják.
"Megvalósítottuk a Graphics Interchange Format bitmap képek használatának képességét, amely magában foglalja a fájltömörítést, az átlátszóságot, a képek interlace-elését és több kép tárolását egyetlen fájlban üzenetküldő szolgáltatásunkhoz."
Mostantól GIF-eket használhatsz üzenetküldő szolgáltatásunkban.
A világos nyelv nem a dolgok leegyszerűsítéséről szól. Ez a felhasználód idejének tiszteletben tartása.
4. Adj hozzá vizuális elemeket a bonyolult változásokhoz.
Ha a kiadási megjegyzésedhez hosszú írásos magyarázat szükséges, az jelzi, hogy inkább egy vizuális elemet kellene hozzáadni. Egy rövid GIF vagy annotált képernyőkép, amely bemutat egy funkciót működés közben, többet közöl, mint két bekezdésnyi leírás bármilyen UI változásról.
Ez különösen hasznos:
Új UI elemek vagy elrendezési változások (mutassa az előtte és utána)
Új munkafolyamatok vagy többlépcsős funkciók (egy 15 másodperces képernyőfelvétel)
Adatvizualizációs funkciók (a tényleges kimenet képernyőképe)
A vizuális elemek csökkentik az olvasó terheit, és emlékezetesebbé teszik a kiadási jegyzeteket. Amikor egy változás természeténél fogva vizuális, mutasd meg vizuálisan.
5. Szervezd meg a beolvasást
A felhasználók eltompulnak, amikor egy szövegtömeget kell elolvasniuk. Tartsuk a dolgokat rendezetten és szegmentálva alcímekkel, kategóriákkal, felsorolásokkal és bekezdés törésekkel. A nagy szövegtömegek darabolása segít a felhasználóknak megtalálni, hogy mely változtatások vonatkoznak rájuk anélkül, hogy mindent el kellene olvasniuk.
A jó szervezési minták közé tartozik:
Változások csoportosítása típus szerint: új funkciók, fejlesztések, hibajavítások
Címkék vagy jelölések használata (mint például "Új", "Fejlesztett", "Javított") a gyors átnézéshez
Rövid összefoglaló hozzáadása a felhasználók számára, akik csak a lényegre kíváncsiak.
Összehajtható szakaszok használata a részletes technikai megjegyzésekhez, amelyekre csak néhány felhasználónak van szüksége.
6. Használj egy sablont és tartsd magad hozzá.
A következetesség egy jellemző, nem egy korlátozás. Amikor a kiadási megjegyzéseid egy előrelátható struktúrát követnek, a felhasználók megtanulják, hol keressék a számukra fontos információkat. Kevesebb időt töltenek a szöveg értelmezésével, és több időt a megértéssel.
Válassz egy sablont (az alábbi részben van egy, amit másolhatsz), testreszabhatod a termékedhez, és használd minden alkalommal. Ez felgyorsítja a csapatod írási folyamatát is, mivel a struktúra már eldöntött.
7. Igazítsd a márkád hangját, ne a műszaki hangot.
A kiadásjegyzeteidnek a márkád hangzását kell tükrözniük, nem pedig egy commit üzenetet. Ha a márkád meleg és barátságos, akkor a kiadásjegyzeteidnek is ilyennek kell lenniük. Ha a márkád pontos és professzionális, akkor azt tükrözd.
A kulcs az, hogy hiteles legyél anélkül, hogy túllőnél a célon. Hozzáadhatsz személyiséget anélkül, hogy feláldoznád a világosságot. Egy kis melegség sokat segít, de a túlsúlyos önreklámozás aláássa a bizalmat. Egy hasznos irányelv: a tartalom 80%-ának valóban hasznos információnak kell lennie, és csak 20%-ának kell visszatükröznie a márkán pozicionálását vagy hangját.
Mit kerülni kell: "Itt vagyunk, hogy forradalmasítsuk a munkafolyamatodat, amit minden frissítéssel sikeresen megvalósítottunk. Szívesen. Az új hibajavításunk 50%-kal kevesebb energiafogyasztást tartalmaz."
Javítás: A szoftver most 50%-kal csökkenti a végfelhasználók energiafogyasztását. Ez csak egyik módja annak, ahogyan a fenntartható jövő felé törekszünk.
Az első verzió felnagyítja a márkát és túlzott ígéreteket tesz, mielőtt említené a változást. A második elmondja a megoldást, majd természetesen hozzáadja a márkát.
Kiadási megjegyzések sablon
Itt van egy kiadási megjegyzések sablon, amelyet másolhatsz és alkalmazhatsz. Tartalmazza a legfontosabb elemeket a legtöbb frissítéshez. Állítsd be a részletességet a kiadás terjedelme alapján: a nagyobb kiadásokhoz több részletet érdemes adni egyes funkciókhoz, a kisebb kiadásoknál tömörítheted a szakaszokat, míg a csak hibajavításokat tartalmazó kiadások esetén teljesen kihagyhatod az "Újdonságok" blokkot.
[Termék neve] kiadási megjegyzések - [Verzió szám vagy dátum]
Összefoglaló: [1-2 mondatos áttekintés arról, hogy mit érint ez a kiadás és kit érint.]
Mi újság?
- [Funkció neve]: [Mit csinál és miért fontos a felhasználó számára]
- [Funkció neve]: [Mit csinál és miért fontos ez a felhasználó számára]
Fejlesztések
- [Mi változott] - [Hogyan befolyásolja a felhasználói élményt]
Hibajavítások
- [Ami a felhasználó tapasztalt korábban] - [Ami most történik]
Ismert problémák
- [Hiba leírása] - [Körülményes megoldás vagy idővonal, ha elérhető]
Kérdések? [Link a súgó dokumentumokhoz vagy a támogatási kapcsolathoz]
Hogyan alkalmazzuk a sablont: Egy nagyobb kiadás esetén, három új funkcióval, bővítsük a "Mi újság" szakaszt egy bekezdéssel funkciónként. Egy kisebb kiadás esetén, öt apró fejlesztéssel, egyesíthetjük a "Mi újság" és a "Fejlesztések" szakaszokat egyetlen listává. Hibajavításokra fókuszáló kiadás esetén a javításokkal kell kezdeni, és teljesen el kell hagyni a funkció szakaszokat. A struktúrának a tartalmat kell szolgálnia, nem pedig fordítva.
13 kiadási jegyzet példa, rendezve aszerint, hogy mit csinálnak a legjobban
Az alábbi példák öt kategóriába vannak rendezve, attól függően, hogy az egyes cégek kiadási jegyzetei miben teljesítenek különösen jól. Minden példánál megtalálható: mit csinál a cég, mit csinálnak jól a kiadási jegyzeteik, és egy konkrét, átvitelre alkalmas tanulság, amelyet te is alkalmazhatsz.
Kapcsolódó információk
https://learn.microsoft.com/en-us/microsoft-365/copilot/release-notes?tabs=all EGY VALÓDI PÉLDA! https://learn.microsoft.com/en-us/sharepoint/dev/spfx/release-1.23.0 EGY VALÓDI PÉLDA! https://slite.com/learn/release-notes https://documentero.com/templates/it-engineering/document/release-notes/ https://projectmanagers.net/7-free-release-notes-templates/ https://www.smartsheet.com/content/release-note-examples https://clickup.com/blog/how-to-write-release-notes/ https://www.releasenotes.io/ https://clickup.com/blog/release-notes-software/ https://www.launchnotes.com/blog/release-notes-examples https://www.geeksforgeeks.org/software-engineering/overview-of-software-release-note/ 13 kiadási megjegyzés példa (és miért működnek). appcues.comInformációk és programok, amelyeket a admin@mcmassociates.io.