Neden yama notlarındaki hata kimliklerini belirtmek kötü bir uygulama olarak kabul edilebilir?

Bir yorum ve daha sonra Bug yeniden açılışı ile yeniden daha sonraki oylamalara dayanarak :

Yama notlarında hata kimliklerini kullanmak sadece .. çok düşmanca. - Krelp

En azından bazı insanlar, hata notlarını yama notlarında referans almanın iyi bir fikir olmadığını düşünüyor. Oldukça deneyimsiz bir geliştiriciyim, bu yüzden neden böyle olduğunu merak ediyorum.

Bence, kullanıcılarınızın böcek veritabanınıza okuma erişimi olduğunu varsaymak iyi bir uygulamadır. İnsanların ne zaman yükseltme yapacaklarına karar vermek için düzeltilecek belirli bir hatayı beklerken birçok kez vardır.

Sanırım kaşlarını çattığın sadece böcek kimliğini ve başka hiçbir şeyi göstermediğini gösteriyor. Hata izleyiciye gitmeden her zaman anlaşılabilir bir tanım da sağlamalısınız. Bu ayrıca, önceki sürüm notlarınızı tamamen geçersiz kılmadan gelecekte hata izleyicileri değiştirmenize olanak sağlar.

Alıntı yapılan yorumda da belirtildiği gibi ... düşmanca.

Düşmanca kendinle

Aşağıdaki senaryoyu hayal edin. Günlükleri kaynak kontrolünde görüntülüyorsunuz. Bir taahhüdün ne şekilde değiştiğini merak ediyorsunuz. Düz İngilizce olarak açıklamak yerine, size söyler:

Çözüldü # 1307

Yararlı bir şeyler olmasını umarak böcek takip sistemini çalıştırıyorsunuz. Hata # 1307'nin çözüldüğü bildirildi. Tanımda, görüyorsunuz:

# 1284 ile aynı hata

Teşekkürler, çok yardımcı oldu. Şimdi, # 1112, # 1065 ve # 1067 hatalarına atıfta bulunan # 1113 numaralı hatanın bir kopyası olduğunu okumak için # 1284 numaralı hata raporuna gitmeniz gerekiyor.

Beş dakika sonra, başlangıçta ne aradığınızı bilmiyorsunuz.

Bir çok daha yararlı sürüm kontrolü günlüğü iletisi şöyle olur:

Kullanıcıların 25 karakterden daha uzun bir şifre ile oturum açamaması (bkz. # 1307), aynı şifre uzunluğu politikasını web sitesinde kullanılan veri erişim katmanına uygulayarak çıkarmalarıyla ilgili bir sorunu çözdü.

Aynı şekilde, hata izleme sisteminde, 1307 numaralı rapor, # 1284 numaralı hata raporunun ne olduğunu ve yenisinin eskisinden farklı olduğunu hatırlatan daha açıklayıcı olabilir .

Müşterileri ile düşmanca

Bu sadece samimiyeti meselesi değil.

İkincisi, ek bilgi olmadan çok fazla başvuru yaparak, yama notlarını / sürüm kontrol kayıtlarını / hata izleme sistemi raporlarını bu sistemlere aşina olmayan birine kullanılamaz hale getirmiş olmanızdır . Her gün bir hata izleme sistemi ile uğraşırken, raporlar arasında nasıl hızlı bir şekilde gezinebileceğinizi, birden fazla raporu yan yana görüntüleyebileceğinizi vb. Bilirsiniz. Teknik geçmişi olmayan bir müşteriyseniz, kolayca kaybolabilirsiniz.

Burada yine, daha ayrıntılı mesajlar sadece referanstan çok yardımcıdır. Hala referansları tutmak istediğinizi unutmayın: hiçbir şey iki hafta önce karşılaştığınız hata ile aynı olan bir hatadan daha yanlış değildir, ancak kimliğini hatırlamayın.

Bir not olarak, aynı mesele birçok yargı alanında bulunmaktadır. Örneğin Fransa'da, bir mevzuatın bu arada değişebilecek olan birden fazla kaynağa gönderme yapması olağandışı değildir. Bunun anlamı, onu tamamen anlayabilmek için, bir kütüphanede bazen birkaç saat harcamak, her bir metnin kendilerine referansları olan düzinelerce yönlendirilmiş metni aramak zorundasınız demektir.

Kullanıcıların atıfta bulunulan sorunu okuyabilmeleri koşuluyla, yama notlarında sayıları bildirmede yanlış bir şey yoktur. Hata veritabanınız herkesin okumasına izin veriyorsa, hata numarasını söylemek gerçekten yararlı olabilir. (Daha iyisi, ek notlarınız bağlantılara izin verecek bir biçimde ise, bu sorun kimliklerini söz konusu konuya bağlar yapın.) Bu, tüm sorunları genel halka göstermeniz gerektiği anlamına gelmez; Örtülmüş olanlara sahip olmak hala faydalı olabilir (ör. canlı şifreleri girdikleri yer!)

Okuyan kişinin gidemediği ve böceğin ayrıntılarına ve geçmişine bakamadığı bir sayıya atıfta bulunmak, bu oldukça dostça değil. Sorun kimliği olmadan bu tür atıflar bu kadar dostça değil ki.

Belli ki yama notlarını okuyacak kişilerin kim olduğu ve yazılımın hedef kullanıcıları olduğu açıktır.

Ancak çoğu durumda, kullanıcılarınızın büyük çoğunluğu sadece hata kimliğinin ne olduğu ile ilgilenmez . Neden kırıldığını, düzeltmenin ne olduğunu veya başka bir şeyi umursamıyorlar - yalnızca her bir değişiklik için başka bir sayfaya gitmeden çok kısa ve özlü bir metin açıklamasıyla nelerin değiştiğini bilmek istiyorlar.

Hata kimliklerini kullanmak beni durdurarak düşünmeme neden olur ve ben - bir kullanıcı olarak - düşünmek istemiyorum. Bir çeşit kullanılabilirlik sorunu.

Örneğin, Visual Assist X'in değişiklik günlüğüne bir göz atın . Bütün bu bağlantılı hata kimlikleri, beni neyin değiştiğini anlamaktan alıkoyan gürültüdür. Ve bu, programcıları hedef alan bir Visual Studio eklentisidir. Ve ben bir programcıyım. Bu beni rahatsız ediyorsa, bir hata izleyicinin ne olduğunu bile bilmeyen ortalama bir kullanıcıyı hayal edin.

Not: Ben soruyu başlatan yorum yazarıydım

Bir referans noktası için bir hata kimliği zorunludur . Nedenler:

• Belirsizliği önleme: İki veya daha fazla hatanın benzer tanımları olabilir. Böylece, aralarında ayrım yapmak için bir çapa gerekir.
• Kolaylık : Bir müşteriyle veya şirket içinde bir hatayı tartışırken, hata kimliği genellikle kısa bir form olarak kullanılır. Kimlik notlarından çıkarılacaksa, onlar hakkında tartışmak zor olacaktır:

3052 zaten düzeltildi, hala 3077 üzerinde çalışıyordu

şundan daha uygundur:

"Uygulama düğmesindeki uygulama çökmesi" sorunu giderildi, hala "Kullanıcı değiştir butonuna tıklandığında NullReferenceException" üzerinde çalışıyordu

Sisteminize bağlı olduğunu söyleyebilirim: Kullandığım birinin otomatik olarak mesaj göndermede bu tür referansları algıladığı ve hata izleyicide depolanan bilete bir bağlantı eklediği için çok şanslıyım .

Ancak, müsait olmadığı bir sistemde olsaydım, yine de hatanın ne olduğunun kısa bir açıklamasının yanı sıra , bilet kimliğinden ( bilet kimliğine göre günlüklerde hızlıca arama yapabilirsiniz) bahsederdim .