Generator catatan rilis gratis

Apa itu catatan rilis?

Catatan rilis adalah ringkasan singkat tentang apa yang berubah dalam versi baru suatu produk: fitur baru, peningkatan, dan perbaikan, yang ditulis agar pembaca tahu apa yang bisa mereka lakukan sekarang. Generator catatan rilis mengubah daftar mentah yang sudah dimiliki tim Anda, seperti commit atau tiket, menjadi ringkasan tersebut, sehingga catatan dirilis bersamaan dengan peluncuran alih-alih seminggu kemudian.

Catatan rilis yang baik memberi tahu pelanggan mengapa pembaruan itu penting bagi mereka. Pesan commit memberi tahu pengembang kode apa yang berubah. Pekerjaannya adalah menerjemahkan satu ke yang lain.

Catatan rilis atau changelog?

Orang menggunakan istilah ini secara longgar. Pembagian yang berguna:

Alat ini juga berfungsi sebagai generator changelog: buat catatan untuk setiap rilis dan tambahkan ke bagian atas halaman changelog Anda.

Apa yang harus disertakan dalam catatan rilis

• Judul dengan produk dan versi: “Catatan rilis Acme Analytics 3.2”.
• Ringkasan satu baris: satu atau dua perubahan yang paling diperhatikan pembaca.
• Baru, Ditingkatkan, Diperbaiki: dalam urutan tersebut, hilangkan bagian yang kosong.
• Poin-poin yang mengutamakan manfaat: apa yang bisa dilakukan pengguna sekarang, bukan apa yang dilakukan kode.
• Perubahan yang merusak: apa yang harus dilakukan seseorang, disebutkan dengan jelas.
• Tautan: ke artikel bantuan atau video untuk apa pun yang perlu dijelaskan.

Contoh catatan rilis singkat

Tiga commit, “feat: export reports to CSV”, “fix: dashboard timezone off by one hour” dan “chore: bump dependencies”, bisa menjadi:

Acme Analytics 3.2
Anda sekarang dapat membawa laporan Anda ke mana saja, dan dasbor menampilkan waktu yang tepat.

Baru

• Ekspor CSV: unduh laporan apa pun sebagai file CSV untuk membukanya di Excel atau Google Sheets.

Diperbaiki

• Waktu dasbor: grafik sekarang menggunakan zona waktu Anda dengan benar.

Pembaruan dependensi ditinggalkan dari versi pelanggan, karena pengguna tidak akan menyadarinya. Versi internal tetap menyimpannya.

Cara menyiapkan perubahan Anda untuk generator

Anda tidak perlu merapikan daftar Anda terlebih dahulu, tetapi beberapa kebiasaan akan memberikan catatan yang lebih baik. Tempel satu perubahan per baris, baik itu pesan commit, judul tiket, atau kalimat. Pertahankan awalan konvensional seperti “feat:” dan “fix:” jika Anda menggunakannya; itu membantu mengurutkan perubahan menjadi baru dan diperbaiki. Tambahkan kata konteks ke item yang samar, misalnya “fix: export (CSV was empty for large reports)”. Isi nama produk dan versi agar judul siap dipublikasikan. Kemudian jalankan dua kali jika Anda memerlukan kedua versi: satu untuk pelanggan, satu untuk tim internal.

Praktik terbaik untuk catatan rilis

Tulis untuk orang yang menggunakan produk

“Laporan dimuat lebih cepat” lebih baik daripada “Optimized query planner”. Beri nama fitur seperti yang muncul di antarmuka.

Utamakan apa yang paling penting

Letakkan perubahan yang paling banyak diperhatikan orang di urutan pertama. Perbaikan kecil bisa berupa satu baris di akhir.

Tunjukkan fitur baru

Tangkapan layar atau video singkat tentang fitur baru lebih efektif daripada satu paragraf. Tautkan artikel bantuan yang menjelaskannya.

Publikasikan sesuai jadwal yang dapat ditemukan orang

Simpan setiap rilis di satu halaman changelog, yang terbaru di atas, agar pelanggan dan tim dukungan Anda selalu tahu ke mana harus mencari.

Kesalahan umum catatan rilis

• Menempel log commit apa adanya, dengan nomor tiket dan jargon.
• Menyembunyikan perubahan yang merusak di tengah daftar.
• Mencantumkan setiap perubahan internal dalam catatan pelanggan.
• Menjanjikan tanggal atau fitur yang tidak ada dalam rilis.

Generator hanya menyertakan perubahan dari daftar Anda dan tidak akan menambahkan tanggal yang tidak Anda berikan, tetapi periksa setiap item sebelum Anda mempublikasikannya.