Hasilkan Catatan Rilis untuk Pelanggan

Zero membaca commit dan PR yang di-merge, mengelompokkan perubahan berdasarkan dampak ke pelanggan, dan menyusun catatan rilis yang jelas, spesifik, dan siap terbit.

Zero terhubung ke:

Apa yang Zero berikan

Hasilkan Catatan Rilis untuk Pelanggan — sample output from Zero — screenshot 1

Apa masalahnya

Catatan rilis selalu menjadi hal terakhir yang ditulis dan hal pertama yang dipangkas saat rilis terlambat. Masalahnya ada di bahan sumber: pesan commit yang ditulis untuk engineer, judul PR yang mengasumsikan pengetahuan internal, dan 30 PR yang di-merge yang sebagian besar tidak dipedulikan pengguna secara individual. Release Notes Generator membalik alur kerjanya. Zero membaca commit dan deskripsi PR, menyaring perubahan yang terlihat pelanggan, mengelompokkannya berdasarkan tema (fitur baru, perbaikan, perbaikan bug), dan menulis catatan dengan gaya bahasa yang benar-benar dibaca pelanggan Anda. Anda meninjau, dan rilis berikutnya terkirim dengan catatan alih-alih kebisuan.

Bagaimana Zero memperbaikinya

Langkah 1: Hubungkan alat Anda

GitHub

Wajib

GitHub. Zero membaca PR yang di-merge, pesan commit, label, dan tag rilis. Akses baca ke repo diperlukan.

Hubungkan

Slack

Wajib

Slack. Zero menyampaikan draf ke kanal tinjauan dan memposting catatan akhir setelah disetujui. Akses tulis kanal diperlukan.

Hubungkan

Langkah 2: Tanya Zero

@Zero untuk rilis yang kami kirim hari ini, baca semua PR yang di-merge sejak tag rilis terakhir. Kelompokkan berdasarkan dampak ke pelanggan: fitur baru, perbaikan, perbaikan bug. Lewati refactor internal dan perubahan tes. Susun catatan untuk pelanggan dengan gaya bahasa produk kami.

coba

Zero membaca setiap PR yang di-merge dalam jendela rilis

Zero menarik PR yang di-merge sejak tag rilis terakhir, termasuk judul, deskripsi, dan label. Perubahan internal saja (refactor, tes, perubahan CI) disaring keluar berdasarkan konvensi label Anda.

Zero mengelompokkan perubahan berdasarkan dampak ke pelanggan

Zero mengelompokkan PR yang tersisa ke dalam tema: fitur baru, perbaikan, dan perbaikan bug. Setiap perubahan ditulis ulang dari deskripsi PR menjadi baris yang berorientasi pelanggan: cukup spesifik untuk berguna, bebas dari jargon internal.

Zero menyusun catatan dengan gaya bahasa produk Anda

Draf akhir mendarat di alat dokumentasi atau Slack Anda dengan bagian yang mengikuti template catatan rilis Anda. Anda menyunting untuk gaya bahasa dan nuansa, lalu menerbitkan.

Langkah 3: Lanjutkan lebih jauh

Perhalus gaya bahasa

Perbarui panduan yang Zero pakai untuk nada dan format.

@Zero mulai sekarang, lewati header Markdown di catatan rilis. Prosa biasa saja.

coba

Rangkai dengan publikasi

Dorong catatan yang disetujui langsung ke dokumentasi atau blog Anda.

@Zero begitu saya menyetujui catatannya, terbitkan ke bagian Releases di dokumentasi kami dan posting tautannya di #announcements.

coba

Terjemahkan

Hasilkan catatan dalam setiap locale yang Anda dukung.

@Zero terjemahkan catatan rilis yang disetujui ke bahasa Jerman, Jepang, dan Spanyol. Pertahankan struktur bagiannya.

coba

Tips untuk hasil yang lebih baik

●Tandai PR internal saja dengan label konsisten (seperti `internal` atau `no-release-notes`). Zero hanya bisa melewati yang Anda tandai.

●Simpan panduan gaya singkat untuk catatan rilis di dokumentasi Anda. Gaya bahasa pelanggan, kata kerja aktif, tanpa jargon internal. Zero menangkapnya dan menerapkannya setiap rilis.

●Susun catatan sebelum rilis terkirim, bukan setelahnya. Meninjau draf selagi pekerjaan masih segar lebih cepat daripada merekonstruksi konteks sepekan kemudian.