Seperti yang dikatakan dalam komentar yang dikutip ... tidak ramah.
Tidak bersahabat dengan diri sendiri
Bayangkan skenario berikut. Anda melihat log dalam kontrol sumber. Anda bertanya-tanya apa komit berubah. Alih-alih menjelaskannya dalam bahasa Inggris biasa, ini memberi tahu Anda:
Dipecahkan # 1307
Anda menjalankan sistem pelacakan bug, berharap memiliki sesuatu yang bermanfaat. Bug # 1307 dilaporkan telah terpecahkan. Dalam deskripsi, Anda melihat:
Bug yang sama dengan # 1284
Terima kasih, ini sangat membantu. Anda sekarang harus menavigasi ke laporan bug # 1284 untuk membaca bahwa itu adalah duplikat bug # 1113 yang mengacu pada bug # 1112, # 1065 dan # 1067.
Lima menit kemudian, Anda tidak tahu apa yang Anda cari di awal.
Sebuah kontrol versi pesan log jauh lebih bermanfaat akan menjadi:
Mengatasi masalah dengan pengguna yang tidak dapat masuk dengan kata sandi lebih dari 25 karakter (lihat # 1307), dengan menghapus penerapan kebijakan panjang kata sandi yang sama ke lapisan akses data seperti yang digunakan di situs web itu sendiri.
Dengan cara yang sama, dalam sistem pelacakan bug, laporan # 1307 bisa lebih jelas , mengingat apa yang dimaksud dengan laporan bug # 1284, dan bagaimana yang baru berbeda dari yang lama.
Tidak bersahabat dengan pelanggan
Ini bukan satu-satunya masalah keramahan.
Yang kedua adalah bahwa dengan terlalu banyak merujuk tanpa info tambahan, Anda membuat catatan tempel / log kontrol versi / laporan sistem pelacakan bug tidak dapat digunakan oleh seseorang yang tidak terlalu mengenal sistem tersebut . Ketika Anda berurusan dengan sistem pelacakan bug setiap hari, Anda tahu cara cepat menavigasi melalui laporan, melihat beberapa laporan berdampingan, dll. Ketika Anda seorang pelanggan tanpa latar belakang teknis, Anda dapat dengan mudah hilang.
Sekali lagi, pesan yang lebih terperinci sangat membantu daripada sekadar referensi. Perhatikan bahwa Anda masih ingin menyimpan referensi: tidak ada yang lebih salah daripada bug yang sama dengan bug yang Anda temui dua minggu lalu, tetapi jangan ingat ID-nya.
Sebagai catatan, masalah yang sama ada di banyak yurisdiksi. Di Prancis misalnya, tidak jarang undang-undang merujuk ke banyak sumber, yang dapat berubah sementara itu. Ini berarti bahwa untuk benar-benar memahaminya, Anda harus menghabiskan waktu berjam-jam di perpustakaan, mencari lusinan teks yang dirujuk, masing-masing teks memiliki referensi sendiri kepada orang lain.