ClickUp Release Notes Template
Product Management

Cara Menulis Catatan Rilis yang Dibaca (Dengan Contoh)

Sebagian besar catatan rilis tidak dibaca, dan sebagian besar di antaranya seharusnya tidak ada.

Menulis catatan rilis yang baik lebih berkaitan dengan kedisiplinan daripada gaya penulisan. Sebuah studi Empirical Software Engineering terhadap 1.529 masalah di 1.139 repositori menunjukkan bahwa sebagian besar kegagalan dalam penulisan catatan rilis disebabkan oleh kekurangan dalam perencanaan dan otomatisasi, bukan karena penulisan yang buruk.

Tim-tim sering kali terlalu fokus pada nada penulisan, padahal masalah sebenarnya terletak pada tahap awal: menentukan topik apa yang akan dibahas dalam catatan rilis tersebut.

Panduan ini ditujukan untuk manajer produk, pemimpin tim teknik, dan siapa pun yang bertanggung jawab untuk memberi tahu pengguna tentang perubahan yang terjadi. Kami akan membahas proses, format, saluran, dan keputusan editorial yang menentukan apakah orang-orang benar-benar akan membuka apa yang Anda terbitkan.

TL;DR

  • Lakukan triase terhadap setiap perubahan sebelum menulis: umumkan, sertakan, atau abaikan. Sebagian besar tim terlalu banyak mengumumkan
  • Utamakan dampak bagi pengguna, bukan perubahan kode. “Pencarian 3 kali lebih cepat” lebih baik daripada “Telah beralih ke Elasticsearch.”
  • Buat catatan tersebut di dalam tiket saat pekerjaan sedang berlangsung, bukan lima menit sebelum deployment
  • Pilih saluran distribusi tertentu dan kuasai saluran tersebut. Berhentilah menyebar secara sembarangan
  • Judul adalah catatan rilis bagi 80% pembaca. Pastikan judul tersebut sudah cukup informatif tanpa perlu penjelasan lebih lanjut.

Apa Itu Catatan Rilis?

Catatan rilis adalah dokumen, halaman, atau pesan dalam aplikasi yang memberi tahu pengguna tentang fitur baru, perbaikan, dan perubahan dalam rilis perangkat lunak tertentu. Catatan ini berfungsi sebagai jembatan antara hasil kerja tim teknik Anda dan pengalaman pengguna.

Catatan rilis biasanya mencakup fitur baru, peningkatan, perbaikan bug, masalah yang diketahui, dan segala hal yang perlu diketahui pengguna setelah pembaruan.

Penelitian Nielsen Norman Group mengenai “change blindness ” menunjukkan bahwa pengguna sering kali tidak menyadari perubahan antarmuka kecuali nilainya jelas dan dikomunikasikan dengan baik. Meluncurkan fitur saja tidak cukup. Anda juga perlu menjelaskan mengapa hal itu penting.

Catatan rilis berbeda dengan catatan perubahan (changelog) dan catatan patch. Catatan perubahan (changelog) adalah riwayat berkelanjutan dari setiap perubahan produk di seluruh versi. Catatan rilis berfokus pada satu pembaruan perangkat lunak dan menyoroti perubahan yang paling penting bagi pengguna. Catatan patch biasanya lebih spesifik dan berfokus terutama pada perbaikan bug.

Bagi tim SaaS, catatan rilis berfungsi sebagai lapisan yang berinteraksi langsung dengan pengguna dalam pembaruan deployment atau sprint. Alih-alih menampilkan tiket teknis mentah, catatan rilis ini menjelaskan dampak aktual dari rilis tersebut dalam bahasa yang mudah dipahami.

Formatnya bervariasi tergantung pada produk. Catatan rilis perangkat lunak mungkin ditampilkan di halaman khusus di situs produk Anda, di dalam jendela pop-up dalam aplikasi, melalui email, atau sebagai deskripsi pembaruan di toko aplikasi.

Mengapa Catatan Rilis yang Baik Penting bagi Tim Produk?

Catatan rilis produk tidak hanya sekadar mendokumentasikan apa yang telah Anda luncurkan. Catatan tersebut secara langsung memengaruhi cara produk Anda dipersepsikan, diadopsi, dan didukung.

  • Adopsi fitur: Pengguna tidak dapat mengadopsi fitur yang tidak mereka ketahui keberadaannya. Catatan rilis adalah cara termudah untuk memperkenalkan fungsi baru kepada pengguna yang sudah menggunakan produk tersebut
  • Mengurangi tiket dukungan: Perubahan antarmuka pengguna yang tiba-tiba dapat membingungkan pengguna. Catatan rilis yang jelas mencegah “laporan bug” yang disebabkan oleh pembaruan yang sudah diharapkan
  • Kepercayaan dan transparansi: Mengakui masalah yang diketahui dan perbaikan bug menunjukkan bahwa tim mendengarkan dan terus mengembangkan produk, bukan menyembunyikan masalah
  • Keselarasan internal: Tim teknik, dukungan, penjualan, dan pemasaran semuanya perlu mengetahui fitur apa saja yang telah dirilis dan alasannya. Catatan rilis memastikan semua tim memiliki pemahaman yang sama
  • Sinyal umpan balik: Catatan rilis yang mendorong tanggapan (balasan, reaksi, upvote) memberikan tim produk saluran umpan balik pelanggan yang sederhana untuk mengukur sentimen

Penyaringan catatan rilis: Tidak semua perubahan perlu dicantumkan dalam catatan

Sebagian besar tim cenderung mengumumkan segala hal. Itulah sebabnya catatan rilis mereka tidak dibaca.

Pendekatan yang lebih tepat adalah mengelompokkan setiap perubahan ke dalam salah satu dari tiga kategori berikut sebelum mulai menulis apa pun:

  • Rilis dan umumkan: Perubahan tersebut memengaruhi perilaku pengguna, melanggar ekspektasi, atau memerlukan tindakan. Tulis catatan tersebut. Inilah tujuan dari catatan rilis
  • Ship-and-embed: Perubahan tersebut dapat ditemukan langsung di dalam produk itu sendiri: tombol baru, item menu yang jelas, atau tooltip. Produk tersebut menjelaskan dirinya sendiri. Lewati catatan ini
  • Ship-and-bury: Pekerjaan internal seperti migrasi infrastruktur, refaktorisasi, dan peningkatan kinerja yang tidak diumumkan. Hal ini sebaiknya dicatat dalam log teknik, bukan dalam catatan yang ditujukan kepada pelanggan

Kuncinya bukanlah menulis catatan rilis yang lebih baik. Melainkan mengetahui perubahan mana yang tidak memerlukan catatan rilis. Catatan yang lebih sedikit namun lebih tajam justru lebih sering dibaca. Ringkasan bulanan berisi “12 perbaikan kecil” justru sering diabaikan.

Siapa yang Harus Menulis Catatan Rilis?

Tim teknik sering kali secara otomatis menulis catatan rilis karena merekalah yang merilis kode tersebut. Masalahnya adalah, tim teknis secara alami menjelaskan apa yang telah mereka bangun, bukan manfaat yang diperoleh pengguna.

Hasilnya adalah catatan yang dipenuhi dengan istilah teknis internal serta referensi mengenai migrasi basis data dan perubahan titik akhir. Hal-hal ini tidak berarti apa-apa bagi pelanggan pada umumnya.

Model yang lebih baik adalah kepemilikan bersama. Manajer produk atau manajer pemasaran produk harus bertanggung jawab atas draf akhir karena mereka berada paling dekat dengan strategi produk dan pelanggan. Tim teknik menyediakan bahan mentah melalui pull request, tiket, dan ringkasan sprint. Tim dukungan dan keberhasilan pelanggan meninjau catatan tersebut untuk memastikan kejelasan dan mengidentifikasi potensi kebingungan.

Dalam tim kecil, orang yang menggabungkan PR (Pull Request) juga bisa menulis catatan tersebut. Hal ini tidak masalah, asalkan mereka menyusun ulang catatan tersebut dari sudut pandang pengguna sebelum dipublikasikan. Di tim yang lebih besar yang merilis pembaruan setiap minggu atau setiap hari, seorang manajer atau koordinator rilis yang khusus ditugaskan sering kali mengelola proses ini agar tetap berjalan lancar.

Seringkali, catatan rilis yang sama dibuat dalam dua versi. Catatan rilis internal mungkin mencakup perubahan basis data, pembaruan infrastruktur, atau detail API. Sedangkan catatan rilis yang ditujukan kepada pelanggan sebaiknya berfokus hanya pada dampak bagi pengguna dan penjelasan dalam bahasa yang mudah dipahami.

Apa Saja yang Harus Termasuk dalam Setiap Catatan Rilis?

Format catatan rilis yang konsisten membantu pengguna mengetahui bagian mana yang harus diperhatikan dan membantu penulis mengetahui hal-hal apa saja yang perlu dicakup. Berikut adalah daftar periksa untuk setiap rilis:

  • Nomor versi atau tanggal rilis: Menandai catatan tersebut pada waktu tertentu sehingga pengguna dan tim dukungan dapat merujuknya di kemudian hari
  • Judul ringkasan: Satu kalimat yang merangkum perubahan terpenting dalam bahasa yang mudah dipahami
  • Fitur baru: Apa saja yang ditambahkan, dijelaskan berdasarkan hal-hal yang kini dapat dilakukan oleh pengguna
  • Peningkatan: Penyempurnaan pada fungsi yang sudah ada, termasuk peningkatan kinerja, pengalaman pengguna (UX), atau perubahan alur kerja
  • Perbaikan bug: Apa yang sebelumnya bermasalah dan apa yang sekarang dapat diharapkan oleh pengguna, tanpa menggunakan bahasa yang menakutkan
  • Masalah yang diketahui: Segala hal yang sudah diketahui oleh tim tetapi belum diselesaikan. Menyertakan hal ini akan meningkatkan kredibilitas
  • Fitur yang dihentikan atau perubahan yang memengaruhi kompatibilitas: Segala hal yang dihapus atau diubah sedemikian rupa sehingga memerlukan tindakan dari pengguna
  • Tautan ke dokumentasi teknis: Arahkan pembaca ke artikel bantuan atau panduan untuk konteks yang lebih mendalam mengenai perubahan-perubahan utama

Tidak setiap rilis akan mencakup semua hal ini. Sebuah patch minor mungkin hanya mencakup perbaikan bug dan nomor versi. Anggaplah daftar periksa ini sebagai batas atas, bukan batas bawah.

Pemimpin produk Shreyas Doshi mempopulerkan Kerangka Kerja LNO, yang mendorong tim produk untuk mengidentifikasi tugas-tugas ‘Leverage’ yang memberikan dampak 10 kali lipat dibandingkan dengan tugas-tugas ‘Overhead’ yang hanya bersifat administratif. Terlalu banyak perusahaan yang memperlakukan catatan rilis sebagai Overhead (tugas membosankan yang harus diselesaikan) alih-alih sebagai peluang Leverage untuk memasarkan nilai baru kepada pengguna.

Cara Menulis Catatan Rilis: Proses Langkah demi Langkah

Catatan rilis yang baik memiliki satu fungsi utama: membantu pengguna memahami apa yang telah berubah, mengapa hal itu penting, dan apa yang harus mereka lakukan selanjutnya. Kesalahan yang paling sering dilakukan oleh tim adalah menganggap catatan rilis sebagai hal yang sekunder, yang ditulis lima menit sebelum peluncuran.

Proses yang lebih baik dimulai jauh lebih awal. Berikut adalah pendekatan yang disetujui para ahli dalam menulis catatan rilis.

Langkah 1: Tentukan untuk siapa catatan rilis Anda ditujukan

Sebelum menulis satu baris pun, tentukan siapa audiens utamanya. Biasanya, catatan rilis Anda ditujukan kepada satu atau lebih dari kelompok-kelompok berikut:

  • Pengguna akhir
  • Admin atau tim TI
  • Pengembang dan pengguna API
  • Tim internal seperti tim dukungan, penjualan, atau keberhasilan pelanggan

Langkah ini lebih penting daripada yang disadari oleh kebanyakan tim. Jika catatan rilis Anda mencampurkan istilah teknis, bahasa pemasaran, dan petunjuk pengaturan, kebanyakan orang akan berhenti membacanya.

Gunakan aturan sederhana ini:

  • Tulis untuk orang yang terkena dampak perubahan tersebut
  • Jelaskan dampaknya terlebih dahulu
  • Sertakan detail teknis hanya jika diperlukan

Jika menulis bukanlah keahlian Anda, jangan khawatir. Sebagian besar alat manajemen proyek saat ini menawarkan fitur AI untuk membantu Anda membuat draf pertama dengan mudah.

Langkah 2: Kumpulkan pembaruan sepanjang siklus rilis

Waktu terburuk untuk menulis catatan rilis adalah tepat sebelum peluncuran. Pada saat itulah tim sering kali melupakan perbaikan penting, mengabaikan kasus-kasus khusus, atau menulis ringkasan yang tidak jelas karena tidak ada yang mengingat konteks lengkapnya lagi.

Catatan rilis yang baik disusun secara bertahap selama proses pengembangan. Bukan di akhir.

Cara termudah untuk melakukannya adalah dengan mencatat ringkasan yang siap dijadikan catatan rilis di dalam tiket, permintaan pull, atau pembaruan tugas saat pekerjaan sedang berlangsung. Beberapa tim bahkan menjadikan kolom “catatan rilis” sebagai kolom wajib di setiap tiket.

Sebuah kebiasaan sederhana dapat membantu:

  • Tulis ringkasan yang ditujukan kepada pengguna saat tiket dibuat
  • Perbarui catatan rilis tersebut jika cakupannya berubah
  • Gunakan kembali bahasa tersebut di bagian selanjutnya dalam catatan rilis

Saat ini, banyak tim yang menyusun draf pertama catatan rilis langsung dari tiket dan pull request yang telah digabungkan.

Inilah yang kami pelajari dari seorang pengguna Reddit di r/SaaS

Tulis tiket fitur dengan bahasa yang mudah dipahami pengguna sejak awal. Jika tiket tersebut sudah menjelaskan dampak bagi pengguna dengan jelas, membuat catatan rilis dari tugas-tugas yang telah digabungkan menjadi jauh lebih sederhana dan lebih mudah diotomatisasi.

Hal ini juga meningkatkan akurasi. Sebagian besar perubahan produk bermula dari permintaan pelanggan, sehingga tiket asli biasanya berisi penjelasan paling jelas mengenai masalah dan manfaat dari perbaikan tersebut.

Jika tiket Anda terhubung ke portal dukungan, Anda bahkan dapat memberi tahu pengguna yang meminta fitur tersebut begitu pembaruan diluncurkan.

Tujuannya sederhana: jadikan pembuatan catatan rilis sebagai bagian dari alur kerja, bukan sekadar tugas menulis di menit-menit terakhir.

Langkah 3: Kelompokkan perubahan ke dalam kategori yang jelas

Sebagian besar pengguna tidak membaca catatan rilis dari awal hingga akhir; mereka hanya membacanya secara sekilas. Jika pembaruan Anda ditampilkan sebagai satu blok teks, pembaca akan melewatkan perubahan-perubahan penting. Kategori yang jelas dapat mengatasi hal tersebut.

Setelah Anda mengumpulkan semua materi untuk catatan rilis Anda, kelompokkan ke dalam bagian-bagian besar. Beberapa kategori yang umum digunakan dalam catatan rilis adalah:

  • Fitur baru
  • Peningkatan
  • Perbaikan bug
  • Pembaruan keamanan
  • Perubahan API
  • Integrasi
  • Masalah yang diketahui
  • Fungsi yang tidak lagi didukung

Misalnya, jika filter dasbor Anda kini dimuat lebih cepat, masukkan di bawah bagian ‘Peningkatan’. Meluncurkan fitur untuk menjadwalkan pengingat faktur berulang? Kategorikan di bawah bagian ‘Fitur baru’.

Hal ini membantu pembaca menemukan informasi yang penting bagi mereka dengan cepat. Selain itu, hal ini juga mengurangi kebingungan antar tim. Tim dukungan dapat fokus pada perbaikan. Pengembang dapat meninjau perubahan API. Pelanggan dapat mencari fitur baru.

Berikut beberapa tips praktis yang dapat membantu:

  • Tempatkan pembaruan yang paling penting di bagian awal
  • Pastikan nama kategori tetap konsisten di seluruh rilis
  • Gunakan poin-poin, bukan paragraf yang padat
  • Hindari mencampurkan pembaruan yang tidak terkait satu sama lain
  • Untuk rilis besar, tambahkan bagian TL;DR singkat di bagian atas yang berisi satu atau dua pembaruan terpenting

Memberi label pada perubahan berdasarkan area produk (misalnya, “Dashboard,” “Mobile,” “API”) menambahkan lapisan navigasi kedua sehingga pengguna dapat langsung menuju bagian produk yang mereka minati. Hal ini sangat berguna terutama untuk produk platform dengan berbagai jenis pengguna.

Langkah 4: Jelaskan dengan jelas segala hal yang harus dilakukan pengguna

Satu instruksi yang terlewatkan saja bisa menimbulkan ratusan tiket dukungan. Itulah mengapa poin-poin tindakan layak mendapat bagian tersendiri dalam catatan rilis.

Jika pengguna perlu mengubah sesuatu, sampaikan dengan jelas dan sedini mungkin. Jangan menyembunyikannya di dalam paragraf.

Ini mencakup hal-hal seperti:

  • Migrasi yang diperlukan
  • Pengaturan ulang kata sandi
  • Perubahan izin
  • Penghentian dukungan API
  • Persyaratan konfigurasi baru
  • Waktu henti terjadwal
  • Pembaruan penagihan
Apa yang sebaiknya tidak ditulisApa yang sebaiknya ditulis sebagai gantinya
Pembaruan otentikasi telah diterapkan untuk integrasi HubSpotKami telah memperbarui proses otentikasi untuk integrasi HubSpot. Admin harus melakukan otorisasi ulang integrasi HubSpot sebelum 1 Juni untuk menghindari kegagalan koneksi
Dukungan otentikasi lama telah dihapusKami telah menghentikan dukungan untuk otentikasi lama. Aplikasi yang menggunakan metode ini akan berhenti berfungsi setelah 15 Juli kecuali telah ditingkatkan ke OAuth 2.0

Berikut adalah contoh catatan rilis dari Salesforce yang membuat semua orang jelas memahami apa yang harus mereka lakukan.

Catatan rilis Salesforce
Catatan rilis dari Salesforce yang menjelaskan langkah-langkah selanjutnya dengan jelas bagi para Admin

Catatan rilis seharusnya menjelaskan perubahan yang terjadi. Catatan tersebut tidak boleh menjadi manual produk yang lengkap.

Mencoba menjelaskan setiap kasus khusus, langkah pengaturan, dan alur kerja di dalam catatan rilis menimbulkan dua masalah:

  • Dokumen tersebut menjadi terlalu panjang
  • Pembaruan penting menjadi lebih sulit untuk dikenali

Sebaliknya, tulislah catatan rilis Anda seperti ringkasan yang dipandu. Berikan pembaruan utama terlebih dahulu kepada pembaca, lalu sertakan tautan ke dokumentasi terperinci jika mereka ingin mengetahui konteks lebih lanjut.

Anda dapat menyertakan tautan ke artikel bantuan, catatan perubahan, dokumentasi API, tutorial video, dan konten relevan lainnya. Contohnya:

” Telah ditambahkan dukungan untuk single sign-on berbasis SAML. Tonton video ini untuk mempelajari cara mengonfigurasi SSO untuk ruang kerja Anda. ”

“Telah ditambahkan dukungan untuk single sign-on berbasis SAML. Tonton video ini untuk mempelajari cara mengonfigurasi SSO untuk ruang kerja Anda.”

Pendekatan ini efektif karena pengguna yang berbeda membutuhkan tingkat detail yang berbeda pula. Seorang manajer produk mungkin hanya membutuhkan ringkasan. Seorang admin yang mengonfigurasi fitur tersebut mungkin membutuhkan panduan konfigurasi 20 langkah.

Langkah 6: Tinjau catatan rilis di seluruh tim

Catatan rilis yang ditulis oleh satu tim saja biasanya kurang mencakup hal penting.

Tim teknik mungkin terlalu fokus pada detail implementasi. Tim pemasaran mungkin terlalu membesar-besarkan perubahan tersebut. Tim produk mungkin melupakan kasus-kasus khusus. Tim dukungan mungkin langsung menemukan kata-kata yang membingungkan.

Itulah sebabnya catatan rilis yang baik harus melalui tinjauan lintas fungsi sebelum dipublikasikan.

Setidaknya, libatkan perwakilan dari tim produk, teknik, dan dukungan pelanggan. Libatkan juga penulis teknis atau pengelola dokumentasi, jika tersedia.

Berikan daftar periksa sederhana kepada setiap peninjau:

  • Apakah tanggal rilisnya akurat?
  • Apakah bahasanya jelas?
  • Apakah ada hal yang menyesatkan?
  • Apakah daftar tindakan sudah terlihat?
  • Apakah tautan-tautan tersebut sudah benar?
  • Apakah masalah yang diketahui telah didokumentasikan?

Langkah 7: Publikasikan catatan rilis di tempat yang benar-benar akan dilihat oleh pengguna

Bahkan catatan rilis yang bagus pun akan sia-sia jika tidak ada yang membacanya. Kesalahan umum yang sering terjadi adalah menyembunyikan pembaruan di halaman catatan perubahan yang terlupakan dan jarang dikunjungi pengguna.

Sebaliknya, sebarkan catatan rilis melalui saluran yang sudah digunakan oleh audiens Anda. Saluran tersebut antara lain:

  • Pemberitahuan dalam aplikasi
  • Pembaruan melalui email
  • Blog produk
  • Pusat Bantuan
  • Portal pengembang
  • Forum komunitas
  • Catatan perubahan GitHub

Saluran yang tepat juga bergantung pada jenis rilis dan dampaknya. Misalnya, perubahan besar layak diumumkan melalui email dan pengumuman dalam aplikasi, sedangkan perbaikan kecil tidak.

Waktu juga penting. Jika pengguna harus mengambil tindakan sebelum batas waktu, publikasikan catatan rilis cukup awal agar mereka dapat merespons.

Berikut ini adalah video singkat yang mendemonstrasikan proses praktis penulisan catatan rilis yang efektif dari awal hingga akhir.

Praktik Terbaik dalam Menulis Catatan Rilis yang Benar-Benar Bermanfaat

Ikuti tips berikut ini untuk memastikan catatan rilis Anda mudah ditulis sekaligus bermanfaat bagi pengguna Anda.

Mulailah dengan templat yang dapat digunakan kembali

Template menghilangkan bagian tersulit dalam menulis catatan rilis: memulai dari halaman kosong. Template ini juga memastikan konsistensi setiap rilis, yang sangat penting bagi tim yang merilis pembaruan setiap minggu atau setiap hari.

Template catatan rilis yang sederhana sebaiknya mencakup:

  • Bagian umpan balik
  • Nomor versi atau tanggal rilis
  • Fitur baru
  • Peningkatan
  • Perbaikan bug
  • Masalah yang diketahui

Simpan templat tersebut di tempat mana pun yang sudah biasa digunakan oleh tim. Bisa berupa wiki, alat dokumentasi, atau ruang kerja manajemen proyek. Semakin mudah diakses, semakin besar kemungkinan orang-orang akan menggunakannya secara konsisten.

Banyak alat manajemen proyek menyediakan templat catatan rilis yang secara otomatis mengambil tugas-tugas terkait dan detail versi, sehingga mengurangi pekerjaan manual selama minggu rilis.

Misalnya, Template Catatan Rilis ClickUp membantu Anda mencatat dan membagikan perubahan penting dalam setiap rilis produk. Anda dapat:

  • Buat tugas dengan berbagai status khusus untuk memantau kemajuan setiap rilis
  • Kategorikan dan tambahkan atribut untuk mengelola catatan rilis dan permintaan fitur Anda dengan Bidang Kustom
  • Tingkatkan pelacakan rilis dengan reaksi komentar, subtugas bersarang, beberapa penugas, dan prioritas
  • Dapatkan alat penulisan berbasis AI terintegrasi dari ClickUp Brain untuk meningkatkan kualitas tulisan Anda
Buat catatan rilis yang bagus dan bagikan kepada pemangku kepentingan menggunakan Template Catatan Rilis ClickUp

Mulailah dengan dampak bagi pengguna, bukan perubahan kode

Inilah kesalahan terbesar yang sering dilakukan oleh sebagian besar tim.

Pengguna tidak peduli apakah tim Anda telah memigrasikan layanan, memperbarui kerangka kerja, atau mengoptimalkan pengindeksan basis data. Yang mereka pedulikan adalah apa yang berubah bagi mereka.

Bandingkan dua versi perubahan yang sama ini:

Apa yang sebaiknya tidak ditulisApa yang sebaiknya ditulis
Endpoint lama tidak lagi didukungVersi API lama (v1) telah dihapus. Lakukan migrasi ke v2 paling lambat pada [tanggal]
Telah memperbaiki kondisi race di layanan notifikasiMemperbaiki bug yang terkadang menyebabkan notifikasi ganda
Menerapkan alur PKCE OAuth 2.0Menambahkan metode masuk yang lebih aman untuk aplikasi seluler
Indeks pencarian telah dipindahkan ke Elasticsearch untuk meningkatkan kinerja kueriHasil pencarian kini dimuat hingga 3 kali lebih cepat di semua jenis paket
Modul izin telah direfaktori untuk mendukung kontrol akses berbasis peranKini Anda dapat menetapkan peran khusus untuk mengontrol siapa yang dapat melihat apa di ruang kerja Anda

Ada aturan sederhana yang bisa diterapkan di sini: jika catatan rilis mencantumkan nama-nama teknologi yang belum pernah didengar oleh sebagian besar pengguna, tulis ulanglah. Tugas Anda adalah menerjemahkan “apa yang kami bangun” menjadi “apa yang Anda dapatkan.”

Gunakan bahasa yang sederhana dan hindari istilah teknis

Catatan rilis yang baik terdengar sederhana karena ditulis untuk dibaca sekilas, bukan untuk dibaca secara mendalam.

Hindari penggunaan akronim kecuali jika audiensnya sangat paham teknis. Tuliskan istilah secara lengkap saat pertama kali muncul. Gantilah istilah teknis dengan bahasa sehari-hari jika memungkinkan.

Bahasa yang sederhana bukanlah merendahkan; melainkan menghilangkan kesenjangan antara apa yang Anda tulis dan apa yang dipahami pengguna.

Catatan rilis internal untuk tim teknik dapat dan sebaiknya tetap bersifat teknis. Langkah ini berlaku untuk catatan yang ditujukan kepada pelanggan.

Usahakan menggunakan bahasa yang jelas dan sederhana sehingga sebagian besar pembaca dapat membacanya dengan cepat. Produk konsumen akan lebih diuntungkan dengan kalimat yang lebih pendek dan kosakata umum. Dalam B2B SaaS, pembaca Anda mungkin lebih toleran terhadap istilah teknis, tetapi kejelasan selalu menjadi prioritas utama.

Berhati-hatilah dengan kata “peningkatan.” Tim sering menggunakannya sebagai kategori umum yang tidak jelas. Sebaliknya, bangun kredibilitas dengan bahasa yang spesifik. Misalnya, “Proses backend yang ditingkatkan” tidak akan terdengar sebaik “Hasil pencarian kini muncul hingga 40% lebih cepat.”

Tambahkan tangkapan layar atau GIF untuk menunjukkan apa saja yang berubah

Perubahan visual sulit dijelaskan melalui teks. Tangkapan layar yang dilengkapi panah atau sorotan biasanya menyampaikan perubahan desain lebih cepat daripada satu paragraf. GIF pendek bahkan lebih efektif untuk alur kerja atau interaksi baru karena pengguna dapat langsung melihat fitur tersebut beraksi.

Beberapa praktik terbaik:

  • Gunakan tangkapan layar beranotasi untuk pembaruan antarmuka
  • Pastikan durasi GIF tidak lebih dari 15 detik
  • Tambahkan teks alternatif untuk tangkapan layar dan gambar
  • Tambahkan keterangan untuk animasi atau GIF

Kami sangat menyukai cara tim di Blender menggunakan visual untuk membuat perubahan produk mereka begitu mudah dipahami. Silakan lihat.

Perbandingan catatan rilis Blender antara versi 5.0 dan 5.1 mengenai kontrol antarmuka
Gunakan elemen visual agar catatan rilis Anda lebih mudah dipahami, seperti yang dilakukan Blender

Ada satu kebiasaan praktis yang sangat membantu di sini. Buatlah folder tangkapan layar bersama setiap sprint. Jika tidak, penulis catatan rilis akan kewalahan mencari gambar pada menit-menit terakhir.

Sesuaikan dengan gaya bahasa merek Anda tanpa nada promosi

Catatan rilis adalah titik kontak komunikasi, bukan saluran pemasaran produk. Pengguna dapat menerima sentuhan personal; namun, mereka tidak menyukai promosi.

Beberapa perusahaan terkenal karena catatan rilisnya yang jenaka dan mencerminkan kepribadian merek. Pembaruan di toko aplikasi Slack (“Kami memperbaiki beberapa bug dan memberi mereka teguran keras”) berhasil karena nada santai tersebut selaras dengan citra merek mereka di semua aspek lainnya. Jika gaya bahasa merek Anda formal dan tepat, jangan tiba-tiba melontarkan lelucon di catatan perubahan.

Salah satu cara yang berguna: Bacalah catatan rilis tersebut dengan suara keras.

Jika terdengar seperti sesuatu yang biasanya dikatakan oleh seorang insinyur dukungan kepada pelanggan, nada bahasanya kemungkinan sudah tepat. Jika terdengar seperti siaran pers, tulis ulang.

Minta umpan balik dari pengguna dan selesaikan siklusnya

Akhiri setiap catatan rilis dengan cara sederhana untuk mengumpulkan umpan balik: tautan balasan, opsi reaksi, pertanyaan “Apakah ini bermanfaat?”, atau tautan ke papan umpan balik.

Catatan rilis adalah salah satu dari sedikit momen di mana pengguna secara aktif memperhatikan perubahan pada produk. Hal itu menjadikannya indikator yang kuat untuk mengetahui sentimen pengguna.

Hal yang penting adalah menutup lingkaran tersebut di kemudian hari. Jika pengguna meminta perubahan dan tim Anda mengimplementasikannya, sebutkan hal itu dalam catatan rilis berikutnya. Kalimat sederhana seperti “Anda meminta, kami mengimplementasikannya” dapat membangun kepercayaan dengan sangat cepat.

Bagaimana Cara yang Tepat untuk Mendistribusikan Catatan Rilis?

Pilih saluran yang sesuai dengan audiens target Anda dan utamakan konsistensi daripada cakupan yang luas.

  • Pemberitahuan dalam aplikasi atau jendela pop-up: Cocok untuk rilis besar karena tingkat visibilitasnya tinggi. Gunakan secukupnya untuk menghindari kelelahan akibat pemberitahuan
  • Halaman catatan perubahan khusus: Membuat arsip yang dapat dicari dan dapat diakses kembali oleh pengguna kapan saja. Ini adalah halaman utama resmi untuk semua catatan rilis aplikasi Anda
  • Email: Cocok untuk pengguna yang aktif dan telah memilih untuk menerima pembaruan. Buat email yang singkat dan sertakan tautan ke catatan rilis lengkap
  • Deskripsi pembaruan di toko aplikasi: Diperlukan untuk aplikasi seluler. Deskripsi ini memiliki batasan jumlah karakter, jadi prioritaskan dua atau tiga perubahan teratas dalam catatan rilis toko aplikasi Anda
  • Saluran internal (Slack, Teams, ClickUp Chat, atau dokumen bersama): Untuk catatan rilis internal yang ditujukan kepada tim dukungan, penjualan, dan layanan pelanggan. Posting sebelum catatan rilis eksternal dipublikasikan, agar tim-tim ini tidak terkejut.
  • Media sosial atau blog: Opsional, sebaiknya disimpan untuk peluncuran besar atau fitur yang menarik minat luas

Pilih dua atau tiga saluran yang sesuai dengan audiens Anda dan publikasikan konten secara konsisten di saluran-saluran tersebut. Menyebar ke semua saluran dengan kualitas yang tidak konsisten lebih buruk daripada mengelola dua saluran dengan baik.

Misalnya, di ClickUp, kami menerbitkan pembaruan mingguan ke catatan perubahan publik kami, yang disusun berdasarkan kuartal di ClickUp Docs. Dari sana, pembaruan tersebut disebarkan melalui email, notifikasi dalam aplikasi, media sosial, postingan blog, dan video YouTube untuk peluncuran besar. Catatan perubahan adalah sumber informasi yang paling dapat diandalkan; semua saluran lainnya berfungsi untuk memperluas jangkauannya.

Di Balik Layar: Cara Kami Menyusun Catatan Rilis di ClickUp

Setiap minggu, tim produk kami merilis pembaruan. Pembaruan tersebut harus sampai ke jutaan pengguna dengan cara yang jelas, tepat waktu, dan mudah ditemukan. Berikut cara kami melakukannya tanpa harus keluar dari ClickUp.

Semuanya dimulai dengan sebuah tugas. Ketika sebuah fitur atau perbaikan siap dirilis, tim teknik akan mengubah status tugas tersebut menjadi “tutup” di ClickUp Tasks. Tindakan tunggal itulah yang memicu alur kerja catatan rilis. Tidak ada yang perlu menepuk pundak seorang pengembang dan bertanya, “Hei, apa fungsi fitur ini?”

Super Agent AI menyusun draf versi pertama. Begitu sebuah tugas ditutup, Super Agent ClickUp yang memantau tugas tersebut secara otomatis menghasilkan draf catatan rilis. Draf tersebut mengambil konteks dari deskripsi tugas, epic induk, dan item yang tertaut. Draf tersebut muncul sebagai komentar pada tugas, sehingga seluruh tim dapat melihatnya. Tim tetap meninjau dan mengedit hasilnya, tetapi hal ini mempercepat proses pembuatan draf pertama secara signifikan untuk rilis mingguan.

Versi finalnya ada di ClickUp Docs. Catatan rilis kami disimpan di ClickUp Docs, yang disusun berdasarkan kuartal. Setiap halaman dokumen mencakup satu rilis mingguan dengan judul yang jelas, deskripsi singkat, GIF atau tangkapan layar, serta tautan ke artikel bantuan. Pemilik dokumen dan kontributor tercantum di bagian atas untuk memastikan akuntabilitas.

Karena ClickUp Docs mendukung kolaborasi real-time, tim teknik dan pemasaran produk dapat meninjau dan memberikan komentar di tempat yang sama, alih-alih saling bertukar tautan Google Docs.

Tim akan mendapat pemberitahuan secara otomatis. ClickUp Automations (atau seorang Super Agent khusus) akan bertindak ketika status catatan rilis di ClickUp Docs berubah menjadi “Diterbitkan.” Pemberitahuan changelog akan dikirim ke saluran dukungan dan layanan pelanggan. Tim internal akan diberi tahu sebelum pelanggan melihat pembaruan tersebut.

Distribusi dilakukan melalui berbagai saluran. Setelah catatan rilis disetujui, catatan tersebut akan disebarkan melalui:

  • Catatan perubahan publik kami (sumber informasi yang terpercaya)
  • Pemberitahuan dalam aplikasi untuk pengguna aktif
  • Pembaruan melalui email kepada basis pengguna kami
  • Postingan blog untuk peluncuran fitur utama
  • Media sosial dan video YouTube untuk rilis yang lebih besar
Halaman Catatan Rilis ClickUp 4.04 dengan video yang disematkan
Contoh catatan rilis dari Changelog ClickUp

Mengapa hal ini penting bagi tim Anda. Anda tidak perlu wiki terpisah, halaman Notion, ruang Confluence, dan saluran Slack untuk memastikan semua orang tetap mendapat informasi terbaru. Satu ruang kerja saja sudah cukup untuk menangani perencanaan, penulisan, peninjauan, dan penerbitan. Para pengembang Anda tetap fokus pada kode. Manajer proyek Anda mendapatkan gambaran instan mengenai apa yang telah dirilis. Dan pengguna Anda selalu tahu di mana harus mencari informasinya.

Satu catatan penting: Alur kerja ini dirancang untuk tim yang sudah menggunakan ClickUp. Jika tim Anda menggunakan alat manajemen proyek lain dan wiki terpisah, beban kerja yang diperlukan untuk migrasi mungkin tidak sebanding dengan manfaatnya hanya untuk catatan rilis. Namun, jika Anda sudah mengelola sprint dan dokumen di satu tempat, proses pembuatan catatan rilis akan berjalan dengan lancar.

5 Contoh Catatan Rilis yang Layak Dipelajari

Selain catatan rilis kami sendiri, berikut adalah lima contoh catatan rilis yang dapat Anda jadikan referensi.

Slack: Menonjolkan kepribadian tanpa mengorbankan kejelasan

Catatan rilis Slack
Catatan rilis Slack terkenal karena humor dan kecerdasannya

Saat melihat contoh catatan rilis, pembaruan dari Slack terkenal karena nada bahasanya yang santai dan jenaka.

Namun, humor tidak pernah menggantikan informasi yang bermanfaat. Catatan mereka tetap menjelaskan apa yang berubah, apa yang telah diperbaiki, dan apa yang harus diharapkan pengguna selanjutnya.

Intinya: Keseimbangan. Gaya penulisan yang personal akan bekerja paling baik jika strukturnya tetap terorganisir dan mudah dibaca sekilas.

Gunakan ini jika: Gaya bahasa merek Anda sudah santai dan jenaka di semua platform lainnya (situs pemasaran, balasan dukungan, media sosial). Konsistensi adalah kunci keberhasilannya.

Pertimbangannya: Humor cepat ketinggalan zaman dan sulit diterjemahkan. Lelucon yang berhasil dalam bahasa Inggris bisa gagal dalam catatan rilis yang dilokalkan, dan kalimat cerdas dari tahun 2019 bisa terasa canggung pada tahun 2026. Siapkan anggaran untuk penyuntingan, atau batasi penggunaan humor seminimal mungkin.

Linear: Ringkas, berfokus pada pengembang, dan mudah dibaca sekilas

Catatan rilis dari Linear
Catatan rilis dari Linear

Linear membuat catatan rilis yang sangat singkat. Sebagian besar pembaruan hanya terdiri dari satu kalimat dan dikelompokkan berdasarkan kategori, seperti Fitur, Peningkatan, atau Perbaikan.

Hasilnya adalah pembaruan yang mudah dipahami bagi pengguna teknis yang tidak menginginkan penjelasan panjang lebar.

Kesimpulannya: Jika audiens Anda sudah memahami produk tersebut dengan baik, catatan yang lebih singkat seringkali lebih baik.

Gunakan ini jika: Anda mengirimkan pembaruan kepada pengembang atau pengguna tingkat lanjut yang membuka catatan perubahan setiap minggu dan hanya ingin tahu apa saja yang baru. Catatan satu baris menghargai waktu mereka.

Komprominya: Catatan satu baris mengasumsikan konteks yang mungkin tidak dimiliki pembaca. Pengguna baru, pembeli non-teknis, dan pengguna kasual akan meninggalkan halaman tersebut. Anda mengoptimalkan untuk orang-orang yang sudah menggunakan produk, bukan mereka yang sedang Anda coba ajak bergabung.

Notion: Berfokus pada visual dengan GIF yang disematkan

Catatan rilis ClickUp yang menampilkan opsi format nomor rollup
Contoh catatan rilis dari Notion

Notion sangat mengandalkan GIF dan tangkapan layar dalam pembaruan “Apa yang Baru” miliknya.

Alih-alih menjelaskan alur kerja secara terperinci, catatan rilis ini langsung menunjukkan interaksinya. Teks tersebut berfungsi sebagai konteks pendukung, bukan penjelasan utama.

Untuk produk yang sebagian besar perubahannya bersifat visual (blok baru, menu yang diperbarui, dan perilaku seret dan lepas), format ini menyampaikan informasi lebih cepat daripada paragraf mana pun.

Intinya: Jika perubahannya bersifat visual, tunjukkan saja daripada menjelaskannya.

Gunakan ini jika: Produk Anda sangat bergantung pada antarmuka dan sebagian besar pembaruan mengubah apa yang dilihat atau diklik pengguna. GIF dapat meringkas satu paragraf penjelasan menjadi tiga detik.

Komprominya: GIF mahal untuk diproduksi, lambat dimuat, dan tidak berguna untuk perubahan non-visual seperti pembaruan API, logika penagihan, atau kinerja backend. Jika terlalu mengandalkan format ini, catatan rilis Anda akan berubah menjadi proyek desain.

GitHub: Dirancang untuk skalabilitas

Catatan perubahan GitHub dirancang agar mudah disaring
Catatan perubahan GitHub dirancang agar mudah disaring

GitHub merilis ratusan pembaruan setiap bulan. Catatan rilis mereka tetap mudah dikelola karena mereka mengelompokkannya berdasarkan area produk dengan cap tanggal dan detail yang dapat diperluas.

Pengguna dapat menyaring berdasarkan kategori seperti Actions, Security, atau Copilot, alih-alih harus menelusuri satu changelog yang sangat panjang.

Kesimpulannya: Saat kecepatan rilis meningkat, navigasi menjadi sama pentingnya dengan kualitas penulisan.

Gunakan panduan ini jika: Anda merilis puluhan pembaruan setiap bulan di berbagai bidang produk, dan pengguna Anda hanya peduli pada sebagian kecil dari keseluruhan fitur. Penyaringan adalah kuncinya.

Komprominya: Catatan rilis yang mengutamakan struktur terasa impersonal dan kehilangan unsur naratif. Pengguna yang menelusuri berdasarkan area produk tidak akan pernah melihat gambaran besar mengenai arah perkembangan produk tersebut. Padukan dengan ringkasan triwulanan “fitur yang telah dirilis” untuk menjaga kesinambungan cerita.

Superhuman: Judul yang menekankan dampak bagi pengguna

Catatan rilis yang berfokus pada manfaat dari Superhuman
Catatan rilis yang berfokus pada manfaat dari Superhuman

Superhuman menyusun catatan rilis dengan mengutamakan hasil bagi pengguna, bukan deskripsi teknis.

Alih-alih menulis, “Menambahkan dukungan pintasan keyboard baru,” mereka menulis, “Capai Inbox Zero lebih cepat dengan pintasan snooze baru.”

Judul itu sendiri sudah menjadi catatan rilis bagi sebagian besar pembaca. Hanya mereka yang ingin mengetahui detailnya yang akan mengklik tautan tersebut.

Intinya: Pastikan judulnya menarik.

Terapkan ini jika: Produk Anda memiliki hasil yang jelas dan terukur bagi pengguna (X lebih cepat, Y lebih sedikit, mencapai Z) dan Anda ingin pengguna merasakan nilainya tanpa perlu mengklik tautan.

Kompromi yang harus diambil: Judul yang berfokus pada hasil memerlukan hasil yang nyata. Jika perubahannya bersifat incremental atau teknis, Anda akan tergoda untuk melebih-lebihkan, dan pengguna akan menyadarinya. “Capai Inbox Zero lebih cepat” berhasil karena fitur tersebut benar-benar memberikan hasil; “Sederhanakan alur kerja Anda dengan pemilih warna baru kami” tidak.

Tingkatkan Adopsi dengan Catatan Rilis yang Disusun dengan Baik

Catatan rilis adalah alat retensi yang disamarkan sebagai dokumentasi. Lakukan penyaringan dengan tepat (umumkan, sertakan, sembunyikan), utamakan dampak bagi pengguna, dan pilih saluran yang dapat Anda kelola secara konsisten. Sisanya hanyalah penyuntingan.

Dan ketika tugas, dokumen, umpan balik, serta alat bantu penulisan berbasis AI Anda berada dalam ruang kerja yang sama, seluruh proses menjadi jauh lebih mudah dikelola. Jika tim Anda sudah lelah harus bolak-balik antara tiket, dokumen, dan utas Slack untuk merilis catatan rilis, mulailah secara gratis dengan ClickUp dan jalankan seluruh alur kerja dalam satu ruang kerja.

Pertanyaan yang Sering Diajukan tentang Penulisan Catatan Rilis

Berapa panjang catatan rilis yang ideal?

Pastikan setiap catatan memiliki panjang antara 50 hingga 300 kata. Satu kalimat sudah cukup untuk perbaikan kecil; perubahan yang kompleks memerlukan 2–3 kalimat ditambah tangkapan layar atau tautan. Linear membatasi sebagian besar pembaruan hanya dalam satu baris karena penggunanya memiliki latar belakang teknis dan produknya memiliki karakteristik yang khas. Notion menggunakan catatan yang lebih panjang karena perubahannya bersifat visual dan memerlukan GIF. Panjang catatan harus disesuaikan dengan kompleksitas perubahan, bukan berdasarkan pengaturan default templat.

Seberapa sering sebaiknya Anda menerbitkan catatan rilis?

Sesuaikan dengan frekuensi rilis Anda, bukan kalender pemasaran. Tim yang merilis pembaruan setiap hari (seperti GitHub dan Linear) menggabungkan pembaruan tersebut ke dalam ringkasan mingguan agar pengguna tidak kewalahan. Tim yang merilis setiap bulan mempublikasikan pembaruan per rilis. Anda dapat menggabungkan pembaruan minor ke dalam ringkasan daripada mengirim notifikasi terpisah untuk setiap perbaikan. Frekuensi yang cukup untuk menunjukkan bahwa produk terus berkembang, namun tidak terlalu sering hingga pengguna menjadi bosan.

Apakah Anda perlu menulis catatan rilis untuk setiap perubahan yang Anda luncurkan?

Tidak. Lakukan triase terhadap setiap perubahan terlebih dahulu. Jika suatu perubahan tidak memengaruhi perilaku pengguna atau antarmuka, abaikan saja. Refaktorisasi backend dan optimasi internal sebaiknya dicatat dalam log teknik. Catatan tentang “peningkatan kinerja” yang tidak memiliki dampak terukur hanya akan membuat pengguna mengabaikan pengumuman di masa mendatang. Sediakan catatan yang ditujukan kepada pelanggan hanya untuk perubahan yang akan dilihat, dirasakan, atau ditindaklanjuti oleh pengguna. Dokumentasikan sisanya secara internal.

Apakah catatan rilis memengaruhi SEO dan keterlihatan produk?

Ya, jika dipublikasikan di halaman yang diindeks. Halaman /changelog atau /whats-new yang terbuka untuk umum akan meningkatkan cakupan pencarian jangka panjang untuk nama fitur, integrasi, dan pencarian perbandingan. GitHub, Linear, dan Notion semuanya mengindeks catatan perubahannya, dan kueri nama fitur sering menampilkan halaman-halaman tersebut di atas konten pemasaran. Jangan terlalu berlebihan dalam mengoptimalkan untuk mesin pencari, tetapi jangan juga menyembunyikannya di balik dinding login atau widget yang hanya berfungsi dengan JavaScript.

Bagaimana cara menulis catatan rilis yang baik?

Catatan rilis yang baik diawali dengan judul satu baris yang menggambarkan dampak bagi pengguna (“Hasil pencarian dimuat 3 kali lebih cepat”), mengelompokkan perubahan ke dalam 3–5 kategori tetap (fitur baru, peningkatan, perbaikan, masalah yang diketahui, perubahan yang memengaruhi kompatibilitas), dan menyertakan tautan ke dokumentasi yang lebih mendalam alih-alih menjelaskan semuanya secara langsung di dalam teks. Tulis setiap baris sebagai manfaat yang diperoleh pengguna, bukan kode yang diubah. Buat catatan tersebut di dalam tiket saat pekerjaan sedang berlangsung, lalu lakukan tinjauan lintas fungsi sebelum dipublikasikan.