Praktik Baik menulis catatan rilis


Jawaban:


21

Saya pikir mengikuti akan memberikan cara untuk praktik yang baik

// Tanggal Terkait

  • Tanggal rilis

// Fitur terkait

  • Fitur ditambahkan
  • Unggulan Dihapus
  • Fitur Berubah

// Bug terkait

  • Bug terselesaikan
  • Bug yang Tidak Terpecahkan

// Ketergantungan terkait

  • Daftar ketergantungan

// Terkait pengujian

  • Hasil Tes Unit
  • Hasil Tes Penerimaan

// Pengendalian versi terkait

  • Tag Note
  • Nomor revisi

Juga beberapa kali layak menyoroti hal-hal yang mungkin ingin diubah oleh pengguna akhir dalam konfigurasi atau alur kerjanya.

Sebagian besar pengguna akhir tidak peduli dengan hasil tes. Mereka mengharapkannya memiliki kualitas tinggi tidak peduli apa kata catatan rilis.

Yang paling penting tentang catatan rilis adalah untuk menyadari bahwa setiap kalimat tambahan kehilangan 10% dari pembaca. Jadi, Anda harus memprioritaskan dengan ketat apa yang perlu diketahui pengguna saat ini tentang rilis tersebut.


1
itu juga beberapa kali layak menyoroti hal-hal yang mungkin ingin diubah oleh pengguna akhir dalam konfigurasi atau alur
kerjanya

@jk. Ya kamu benar. Saya telah mengedit jawaban saya sebagai komentar baik Anda.
Md Mahbubur Rahman

Sebagian besar pengguna akhir tidak peduli dengan hasil tes. Mereka mengharapkannya memiliki kualitas tinggi tidak peduli apa kata catatan rilis.
Henrik

Catatan rilis @Henrik mungkin berguna untuk orang selain pengguna akhir
jk.

5

Yang paling penting tentang catatan rilis adalah untuk menyadari bahwa setiap kalimat tambahan kehilangan 10% dari pembaca. Jadi, Anda harus memprioritaskan dengan ketat apa yang perlu diketahui pengguna saat ini tentang rilis tersebut.


4
setiap baris mungkin kehilangan 10% pembaca biasa, tidak tertarik (atau malas). Pembaca itu adalah yang tidak ditulis untuk rilis Anda. Orang-orang yang peduli dengan apa yang telah Anda lakukan akan membaca semuanya dan berterima kasih untuk setiap baris yang relevan - Anda hanya perlu berhati-hati dalam memasukkan bulu yang benar-benar perlu masuk ke dokumentasi yang tepat.
gbjbaanb
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.