Ang pahinang ito ay nasa ilalim ng konstruksyon!
Paki-click dito para tumulong David McMurrey bayaran ang kanyang web-hosting na bill:
Mag-donate ng anumang maliit na halaga na kaya mo!
Ang Online Technical Writing ay mananatiling libre.
Ang sumusunod na impormasyon ay inangkop na may pahintulot mula sa isang artikulo ng appcues.com (na binanggit sa ibaba).
Bakit karamihan sa mga tala ng paglaya ay hindi nababasa (at kung paano ito ayusin)
Karamihan sa mga tala ng pagpapalaya ay hindi nababasa. Hindi dahil hindi interesado ang mga gumagamit sa mga pagbabagong nagaganap sa produkto, kundi dahil ang mga tala ay isinulat para sa koponang naglabas ng tampok, hindi para sa taong kailangang maunawaan ito.
Maliban sa sigurado, nakita mo na ito dati: isang tala ng paglabas na nagbubukas ng "Naipatupad ang pinabuting antas ng data persistence para sa pinahusay na throughput" kapag ang talagang kailangan marinig ng user ay "Ang iyong mga ulat ngayon ay naglo-load ng dalawang beses na mas mabilis." Ang unang bersyon ay tinitingnan ang isang kahon. Ang pangalawa ay nag-uudyok ng paggamit.
Ang puwang na iyon ay mas mahalaga kaysa sa alam ng karamihan sa mga koponan. Ang release note ay isang pagkakataon sa komunikasyon ng produkto. Ito ang bintana sa pagitan ng pagpapadala at pag-aampon. Kung tama ang pagkakapagawa mo, susuriin ng mga gumagamit ang bagay na nilikha mo. Kung palagpasin ito, parang hindi na naipadala ang tampok.
Ang artikulong ito ay nagbibigay sa iyo ng kinakailangan upang mapuno ang puwang na iyon: 13 halimbawa ng release notes mula sa mga kumpanyang mahusay sa ito (inayos ayon sa kung ano ang nagiging dahilan upang pag-aralan ang bawat isa), isang template na maaari mong kunin at i-adapt ngayong araw, at isang hakbang-hakbang na gabay sa pagsusulat na sumasaklaw sa mga batayan. Kung ikaw ay isang product manager na nagsusulat ng iyong unang release note o isang product marketer na pinapino ang proseso, tiyak na makakalabas ka na may dala na agad mong magagamit.
Ano ang mga release notes?
Ang release note ay isang maikli, ulat na nakaharap sa gumagamit na inilathala kasama ang bagong o na-update na software. Ipinaliliwanag nito kung ano ang nagbago, bakit ito mahalaga, at sino ang apektado. Para sa mga bagong paglabas, ang mga release note ay nagbibigay sa mga gumagamit ng buod kung ano ang ginagawa ng produkto. Para sa mga pag-update sa mga umiiral na produkto, ipinaliwanag ng mga tala kung ano ang bago, ano ang pinabuti, at ano ang inayos mula sa huling bersyon.
Halimbawa ng tala ng paglaya na nagpapakita ng mga nakaraang bersyon
Mga tala ng pagpapalabas vs. talaan ng pagbabago
Ang mga termino ay ginagamit na magkakapareho, pero magkaibang bagay ang mga ito. Ang release notes ay naglalarawan ng isang tiyak na bersyon o update ng detalyado: kung ano ang nagbago, bakit ito mahalaga, at sino ang naapektuhan. Isang pagkakaiba sa changelog at release notes na dapat maunawaan: ang changelog ay ang patuloy na talaan ng lahat ng release notes sa paglipas ng panahon. Isipin ito bilang archive. Maraming produkto ang nagpapanatili ng pareho: mga indibidwal na release notes para sa bawat update, at isang changelog na pahina kung saan lahat sila ay nakatira nang sama-sama sa reverse chronological order.
Mahalaga ang pagpapanatili ng ganitong tala. Ipinapakita nito sa mga customer na ang produkto ay patuloy na umuunlad at ang mga kamakailang pagbabago ay nakabatay sa mga nakaraang bersyon. Ipinapahayag din nito na ang kumpanya ay nakikinig sa feedback at nakatuon sa karanasan ng gumagamit.
Mga Uri ng mga Tala ng Paglabas
Hindi lahat ng update ay nararapat sa parehong pagtrato. Ang format at lalim ng iyong mga tala sa paglabas ay dapat umakma sa saklaw ng pagbabago:
Mahalagang tala ng paglabas: Mga bagong tampok, makabuluhang pagbabago sa UI, mga bagong kakayahan. Karapat-dapat ito sa mas detalyadong paliwanag kasama ang mga biswal, konteksto kung bakit ginawa ang pagbabago, at malinaw na gabay kung paano ito gamitin.
Maliit na tala ng pag-upgrade: Mga unti-unting pagpapabuti, maliliit na pagbabago sa UX. Ang mas maiikli na format ay angkop dito, karaniwang isa hanggang tatlong linya bawat item.
Mga tala ng pag-aayos ng bug: Naayos ang mga isyu. - Bago: Mahirap i-access ang mga feature ng app. - Ngayon: Madali na at mabilis na ma-access ang mga feature. - Bago: Nangyaring mag-crash ang app sa tuwing naglo-log in. - Ngayon: Tumutuloy na ang app nang walang abala habang naglo-log in. - Bago: Walang mga notification na natanggap para sa mga update. - Ngayon: Nakakatanggap na ng mga abiso para sa mga bagong update. - Bago: Mabagal ang pag-load ng mga pahina. - Ngayon: Mabilis na ang pag-load ng mga pahina. - Bago: Hindi nagre-record ng mga aktibidad ang app. - Ngayon: Nagtatala na ng mga aktibidad ng maayos.
Mga tala ng seguridad: Maikli at totoo. Bigyang-priyoridad ang mga bagay na mahina at ang mga naayos nang walang teknikal na detalye na nagdudulot ng kalituhan.
Bakit mahalaga ang release notes
Sila ang tulay sa pagitan ng pagpapadala at paggamit. Ang mga gumagamit na nauunawaan kung ano ang nagbago ay mas malamang na mag-explore at tumanggap ng mga bagong tampok. Ang mga tala ng pagpapalabas ay ang sandali ng komunikasyon ng produkto kung saan isinasalin mo ang ginawa ng team ng engineering sa isang bagay na talagang nais subukan ng gumagamit. Kung wala ang pagsasaling iyon, ang mga tampok ay hindi napapansin, at ang pagtanggap sa tampok ay nahihirapan habang ang pagsisikap na inilaan ng iyong team sa pagbubuo nito ay hindi umaabot sa potensyal nito.
Binabawasan nila ang workload ng iyong support team. Ang proactive release notes ay nagpapababa ng mga katanungan kung bakit mayroong pagbabago sa hitsura o paggana. Kapag ang mga gumagamit ay nakatagpo ng isang pagbabago na hindi nila inaasahan, nagbubukas sila ng support ticket. Kapag nabasa na nila ang isang malinaw na paliwanag, hindi na nila ito ginagawa. Ang matematika ay simple: idokumento ang pagbabago bago pa man magkamali ang mga gumagamit.
Nagtatayo sila ng tiwala at panghihikayat mula sa mga customer. Ang nakikita at regular na tala ng mga paglabas ay nagpapahiwatig na ang produkto ay aktibong umuunlad. Para sa mga customer na nag-eevaluate kung mag-renew o mag-expand, ang isang malusog na changelog ay ebidensya na ang produkto ay may patutunguhan. Para sa mga customer na nagsumite ng mga hinihingi ng tampok, ang pagtingin sa kanilang feedback na nakikita sa mga tala ng paglabas ay nagpapalalim ng katapatan.
Pinapatalas nila ang panloob na pagkakatugma. Ang disiplina ng pagsulat ng magandang release notes, partikular na ang pagsagot sa "ano ang nagbago, para kanino, at bakit ito mahalaga," ay pinipilit ang mga product team na makipag-usap nang malinaw sa buong organisasyon. Ang product marketing, customer success, at sales ay lahat nakikinabang kapag ang release communications ay malinaw at pare-pareho. Ang release note ay kadalasang nagiging pinagkukunan ng katotohanan na pinagkukunan ng ibang mga team kapag nakikipag-usap sa mga customer tungkol sa mga bagong pagbabago.
Ano ang isasama sa mga tala ng paglabas
Isipin mo ito bilang anatomy ng isang release note. Ang bawat solidong release note ay sumasaklaw sa mga elementong ito, bagamat ang lalim ay nag-iiba batay sa kung ikaw ay nag-aanunsyo ng isang malaking tampok o isang pangkaraniwang pag-aayos ng bug:
Header line: Pangalan ng produkto, numero ng bersyon o petsa, at kapaligiran kung naaangkop (web, iOS, API, atbp.).
Buod ng mga pagbabago: Isang o dalawang pangungusap na naglalarawan kung ano ang tinutugunan ng release na ito at sino ang naapektuhan. Ito ang bahagi na binabasa ng mga gumagamit muna, kaya gawing mahalaga ito.
Mga bagong tampok: Naka-ngalan, na may maikling epekto sa gumagamit. Unahin ang kung ano ang maaari na ngayong gawin ng gumagamit, hindi ang teknikal na pagpapatupad.
Mga Pagpapabuti: Ano ang nagbago mula sa pananaw ng gumagamit. "Ang mga resulta ng paghahanap ay ngayon ay naglo-load ng 40% na mas mabilis" ay mas maganda kaysa sa "Pinaayos na pipeline ng pag-index ng paghahanap."
Mga pag-aayos ng bug: Simple at malinaw na paglalarawan ng karanasan ng gumagamit bago at kung ano ang nangyari ngayon. "Hindi na nagfi-freeze ang dashboard kapag nagfi-filter ayon sa saklaw ng petsa" ay nagsasabi sa gumagamit kung ano ang mali at na ito ay naayos na.
Mga kilalang isyu o limitasyon: Kung mayroong hindi ganap na nasolusyunan, sabihin ito. Mahalaga sa mga gumagamit ang pagiging bukas kaysa sa pagkunot ng noo sa hindi pagiging perpekto.
Paano sumulat ng release notes
Ang kaalaman kung ano ang isasama ay ang pundasyon. Ang paraan ng iyong pagsusulat ay nagtatakda kung babasahin ito ng sinuman. Ang pitong hakbang na ito ay nakaayos para sa daloy: simulan sa kung ano ang sasabihin, pagkatapos ay kung paano ito sasabihin, at sa huli kung paano ito ipapakita.
1. Magtuon sa gumagamit, hindi sa tampok
Ito ang pinaka-mahalagang prinsipyo sa pagsulat ng release note. Ang bawat pagbabago ay ginawa upang lutasin ang isang problema o buksan ang isang kakayahan para sa gumagamit. Simulan dito.
Ang likas na ugali ay ilarawan kung ano ang ginawa ng iyong koponan. Labanan ito. Sa halip, ilarawan kung ano ang maaari na ngayong gawin ng gumagamit (o kung ano ang hindi na niya kailangang harapin).
Bago: "Nai-implement ang batch processing para sa mga pag-export ng datos na may nako-configure na mga sukat ng chunk."
Ngayon: "Maaari mo nang i-export ang malalaking dataset nang hindi nagti-time out ang proseso. Ang mga export na dati ay bumabagsak matapos ang 10,000 na hilera ay maaari nang hawakan ang hanggang 500,000."
Ang unang bersyon ay naglalarawan ng gawain sa inhinyeriya. Ang pangalawang bersyon ay naglalarawan ng karanasan ng gumagamit. Isulat ang pangalawang bersyon.
2. Ipaalam ng maliwanag ang layunin ng pagbabago
Ang mga gumagamit na nagbabasa ng mga tala ng paglaya ay nais ng dalawang bagay: kung ano ang nagbago at kung ito ay may epekto sa kanila. Gawing maliwanag ang parehong sagot sa loob ng unang pangungusap ng bawat item.
Mahalaga ang kaliwanagan dahil ang mga gumagamit ng web ay hindi nagbabasa nang tuwid. Sila ay nag-eescan. Kaya gawing madaling i-scan ang iyong mga tala ng pagpapalabas. I-highlight ang mga mahahalagang salita. Gumamit ng bold na teksto para sa mga pangalan ng tampok at mga uri ng pagbabago. Ilagay sa unahan ang pinakamahalagang impormasyon sa bawat linya.
Bago: "Naayos ang bug at nalapatan ng mga update."
Matapos: "Nagtuwid kami ng isang bug na nagdulot ng hindi inaasahang pag-crash kapag nasa pagitan ng mga app. Ang pagpapalit ng app ay ngayon ay matatag sa lahat ng sinusuportahang mga device."
Ang unang bersyon ay maikli ngunit hindi nagbibigay ng impormasyon sa gumagamit. Ang pangalawa ay nananatiling maikli ngunit tinutugunan ang mga tanong na talagang mayroon ang gumagamit.
3. Gumamit ng simpleng wika
Ang mga tala ng paglabas ay maaaring magsilbing iba't ibang layunin: nagtataguyod ng mga bagong tampok, nagtutulungan sa pagbuo ng relasyon sa gumagamit, tumutulong sa mga tao na makahanap ng solusyon. Ngunit wala sa mga iyon ang gumagana kapag ang mga tala ay puno ng teknikal na jargon na tanging ang iyong engineering team lamang ang nakakaintindi.
Maliban na lamang kung alam mong madali nitong mauunawaan ng iyong audience ang espesyalisadong wika, iwasan ang jargon. Gumamit ng tuwirang, madaling maunawaan na mga pahayag. Isang magandang pagsubok: basahin ang tala ng paglabas nang malakas sa isang tao na walang teknikal na kaalaman. Kung mauunawaan nila, mauunawaan din ito ng iyong mga gumagamit.
Bago: "Naipatupad namin ang kakayahang gumamit ng Graphics Interchange Format na mga bitmap na imahe na kinabibilangan ng compression ng file, transparency, interlacing at pag-iimbak ng maraming imahe sa isang file para sa aming serbisyo sa mensaheng."
Pagkatapos: "Maaari mo nang gamitin ang mga GIF sa aming serbisyo sa pagmemensahe."
Ang simpleng wika ay hindi ang pagpapababa ng mga bagay. Ito ay paggalang sa oras ng iyong gumagamit.
4. Magdagdag ng mga biswal para sa mga kumplikadong pagbabago
Kung ang iyong release note ay nangangailangan ng mahabang nakasulat na paliwanag, iyon ay isang senyas na magdagdag ng biswal. Ang isang maiikling GIF o annotated screenshot na nagpapakita ng isang tampok sa aksyon ay nakakapaghatid ng higit pa kaysa sa dalawang talata ng paglalarawan para sa anumang pagbabago sa UI.
Ito ay lalo na kapaki-pakinabang para sa:
Mga bagong elemento ng UI o pagbabago sa layout (ipakita ang bago at pagkatapos)
Mga bagong daloy ng trabaho o multi-step na mga tampok (isang 15-segundong pagrekord ng screen)
Mga tampok ng biswal na datos (isang screenshot ng aktwal na output)
Ang mga visual ay nagpapagaan ng pasanin sa mambabasa at ginagawang mas alaala ang iyong release notes. Kapag ang isang pagbabago ay likas na biswal, ipakita ito sa paraang biswal.
5. Ayusin para sa pag-scan
Nawawalan ng gana ang mga gumagamit kapag hiningiang basahin ang isang pader ng teksto. Panatilihing maayos at nakahanay gamit ang mga subheading, kategorya, bullet points, at mga paghihiwalay ng talata. Ang paghahati-hati ng malalaking bloke ng teksto ay tumutulong sa mga gumagamit na mahanap kung aling mga pagbabago ang naaangkop sa kanila nang hindi kinakailangang basahin ang lahat.
Magandang mga pattern ng organisasyon ay kinabibilangan ng:
Pag-uuri ng mga pagbabago ayon sa uri: mga bagong tampok, mga pagpapabuti, mga pag-aayos ng bug
Gumagamit ng mga label o tag (tulad ng "Bago," "Pinabuti," "Naayos") para sa mabilis na pag-scan
Magdagdag ng maikling buod sa itaas para sa mga gumagamit na nais lamang ang mga pangunahing punto.
Gumamit ng mga collapsible na seksyon para sa detalyadong teknikal na tala na tanging ilang mga gumagamit ang kailangan.
6. Gumamit ng isang template at manatili dito
Ang pagkakapare-pareho ay isang katangian, hindi isang limitasyon. Kapag ang iyong mga tala ng paglabas ay sumusunod sa isang nakatakdang istruktura, natututo ang mga gumagamit kung saan hahanapin ang impormasyong mahalaga sa kanila. Maglalaan sila ng mas kaunting oras sa pag-unawa at mas maraming oras sa pag-intindi.
Pumili ng isang template (may isa sa susunod na seksyon na maaari mong kopyahin), i-customize ito para sa iyong produkto, at gamitin ito sa tuwina. Pabilisin din nito ang proseso ng pagsulat para sa iyong koponan, dahil nakatakda na ang estruktura.
7. Iayon ang boses ng iyong tatak, hindi ang boses ng iyong inhinyeriya.
Ang iyong mga tala ng paglabas ay dapat na umuukit sa iyong tatak, hindi parang mensahe ng commit. Kung ang iyong tatak ay mainit at madaling lapitan, dapat ganun din ang iyong mga tala ng paglabas. Kung ang iyong tatak ay tiyak at propesyonal, tumugma dito.
Ang susi ay maging totoo nang hindi sobra-sobra. Maaari kang magdagdag ng personalidad nang hindi isinasakripisyo ang kalinawan. Ang kaunting init ay malaking tulong, ngunit ang labis na pag-papa-promote sa sarili ay nagwawasak ng tiwala. Isang kapaki-pakinabang na alituntunin: 80% ng nilalaman ay dapat talagang kapaki-pakinabang na impormasyon, at 20% lamang ang dapat sumasalamin sa posisyon o boses ng brand.
Ano ang dapat iwasan: "Narito kami upang rebolusyonin ang iyong daloy ng trabaho, isang bagay na matagumpay naming nagawa sa bawat update. Walang anuman. Ang aming bagong hotfix ay may kasamang 50% na mas kaunting konsumo ng enerhiya."
Mas mahusay: "Pag-aayos ng bug: Ngayon ay nagbabawas ang software ng pagkonsumo ng enerhiya ng end-user ng 50%. Isa ito sa maraming paraan kung paano kami nagtatrabaho patungo sa isang mas napapanatiling hinaharap."
Ang unang bersyon ay nagpapalaki ng pangalan ng tatak at labis na nangako bago banggitin ang pagbabago. Ang pangalawa ay sinasabi ang solusyon, at saka idinadagdag ang anggulo ng tatak nang natural.
Template ng mga tala sa pagpapalabas
Narito ang isang template para sa tala ng paglabas na maaari mong kopyahin at iangkop. Saklaw nito ang mga pangunahing detalye para sa karamihan ng mga update. Ayusin ang lalim batay sa lawak ng iyong paglabas: ang mga pangunahing paglabas ay nagkakaroon ng mas maraming detalye sa bawat tampok, ang mga menor na paglabas ay maaaring pahabain ang mga seksyon, at ang mga paglabas na may bug-fix lamang ay maaaring laktawan ang bahagi ng "Ano ang bago."
[Mga tala ng paglaya ng produkto] - [Bilang ng bersyon o petsa]
Buod: [1-2 pangungusap na naglalarawan kung ano ang tinutukoy ng paglabas na ito at sino ang naapektuhan nito]
Ano ang bago
- [Pangalan ng tampok]: [Ano ang ginagawa nito at bakit ito mahalaga para sa gumagamit]
- [Pangalan ng tampok]: [Ano ang ginagawa nito at bakit ito mahalaga sa gumagamit]
Mga Pagsasaayos
- [Ano ang nagbago] - [Paano ito nakakaapekto sa karanasan ng gumagamit]
Mga pag-aayos ng bug
- [Ano ang naranasan ng gumagamit noon] - [Ano ang nangyayari ngayon]
Mga kilalang isyu
- [Paglalarawan ng isyu] - [Solusyon o timeline kung available]
Mga Tanong? [Link sa mga dokumento ng tulong o contact ng suporta]
Paano iangkop ang template: Para sa isang pangunahing release na may tatlong bagong tampok, palawakin ang seksyong "Ano ang Bago" ng isang talata para sa bawat tampok. Para sa isang maliit na release na may limang maliliit na pagpapabuti, maaari mong pagsamahin ang "Ano ang Bago" at "Mga Pagpapabuti" sa isang nag-iisang listahan. Para sa isang release na naglalaman lamang ng mga pag-aayos ng bug, iuna ang mga pag-aayos at tanggalin ang mga seksyon ng tampok. Ang istruktura ay dapat maglingkod sa nilalaman, hindi ang kabaligtaran.
13 halimbawa ng tala ng paglabas, na inayos ayon sa kanilang pinakamahusay na nagagawa
Ang mga halimbawa sa ibaba ay nakaayos sa limang kategorya batay sa kung ano ang partikular na mahusay sa release notes ng bawat kumpanya. Para sa bawat halimbawa, makikita mo: kung ano ang ginagawa ng kumpanya, kung ano ang tama sa kanilang release notes, at isang tiyak na aral na maaari mong ilapat sa iyo mismo.
Kaugnay na Impormasyon
https://learn.microsoft.com/en-us/microsoft-365/copilot/release-notes?tabs=all ISANG TUNAY NA HALIMBAWA! https://learn.microsoft.com/en-us/sharepoint/dev/spfx/release-1.23.0 ISANG TUNAY NA HALIMBAWA! 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 halimbawa ng tala ng paglabas (at kung ano ang nagpapagana sa mga ito). appcues.comImpormasyon at mga programang ibinibigay ng admin@mcmassociates.io.