Hata ayıklamayı adım adım nasıl kaydediyorum
Belirti, yeniden üretme adımları, hipotez ve sonuç. Bir hatayla uğraşırken tuttuğum kaydın iskeletini ve bunun neden işe yaradığını anlatıyorum.
Bir hatayla uğraşırken kafamda tuttuğum şey sandığımdan çok daha kırılgan. Yarım saat sonra neyi gerçekten denediğimi, neyi yalnızca denediğimi sandığımı ayırt edemiyorum. Aynı denemeyi ikinci kez yapıp aynı sonucu görmek, hata ayıklamanın en sinir bozucu kısmı. Bu yüzden bir süredir takıldığım her hatada küçük bir kayıt tutuyorum. Bu yazıda o kaydın nasıl göründüğünü anlatıyorum.
Kayıt nerede duruyor
Özel bir araç kullanmıyorum. Projenin içinde, sürüm kontrolüne eklemediğim bir notlar klasörü var ve her hata için tarihli bir markdown dosyası açıyorum. Önemli olan aracın kendisi değil, kaydı hatayla uğraşmaya başladığım anda açmak. "Sonra yazarım" dediğim kayıt hiçbir zaman yazılmıyor.
Dosyanın iskeleti
Her dosya aynı başlıklarla başlıyor:
# Kısa başlık
## Belirti
## Beklenen
## Yeniden üretme adımları
## Ortam
## Hipotezler ve denemeler
## Sonuç
Belirti kısmına gördüğüm şeyi yorum katmadan yazıyorum. "Kayıt bozuk" değil, "listeyi yeniledikten sonra son eklenen öğe görünmüyor" gibi. Hata mesajı varsa olduğu gibi kopyalıyorum; kendi cümlelerimle özetlemek önemli bir ayrıntıyı atlamama neden olabiliyor.
Beklenen kısmı kısa ama gerekli. Bazen bunu yazarken, aslında neyin doğru davranış olduğundan emin olmadığımı fark ediyorum. Bu da başlı başına bir bulgu.
Yeniden üretme adımları en çok zaman harcadığım bölüm. Hatayı güvenilir şekilde tekrar oluşturamıyorsam, düzeltip düzeltmediğimi de bilemem. Adımları numaralı yazıyor ve her seferinde sonucun aynı olup olmadığını not ediyorum. Hata bazen çıkıp bazen çıkmıyorsa bunu da açıkça yazıyorum; çünkü bu durum zamanlama, önbellek ya da sıralama gibi bir şeye işaret ediyor olabilir.
Ortam kısmına tarayıcıyı, işletim sistemini, ilgili kütüphanelerin sürümlerini ve son yaptığım değişikliği yazıyorum. Hatanın hangi commit'ten sonra başladığını biliyorsam onu da ekliyorum.
Hipotez, deneme, sonuç
Asıl iş "Hipotezler ve denemeler" bölümünde dönüyor. Her deneme için üç satır yazıyorum:
- Hipotez: Ne olduğunu düşünüyorum?
- Deneme: Bunu sınamak için tam olarak ne yaptım?
- Sonuç: Ne gördüm? Hipotez güçlendi mi, zayıfladı mı?
Bu düzen beni iki şeye zorluyor. Birincisi, rastgele bir şeyleri değiştirip ne olacağına bakmak yerine önce bir tahminde bulunmaya. İkincisi, her denemede tek bir şeyi değiştirmeye. Aynı anda üç şeyi değiştirdiğimde hata kaybolsa bile hangisinin işe yaradığını bilemiyorum.
Hipotezin yanlış çıkması da değerli. "Önbellekle ilgili değil, önbelleği tamamen kapattığımda da oluyor" gibi bir satır sonraki adımları ciddi şekilde daraltıyor. Yanlış çıkan hipotezleri silmiyorum, üstlerini de çizmiyorum; yalnızca sonuçlarını yazıyorum.
Takıldığımda
Bazen denemeler tükeniyor ve ne yapacağımı bilemiyorum. Bu durumda kayda dönüp baştan okuyorum. Her şeyi yazılı görmek aradaki boşlukları fark etmemi kolaylaştırıyor: hiç sorgulamadığım bir varsayım, kontrol etmediğim bir sürüm, yalnızca bir kez denediğim bir adım. Kaydı birine anlatır gibi okumak çoğu zaman tek başına yetiyor.
Hâlâ çözemiyorsam sorunu küçültmeye çalışıyorum. Hatayı yeniden üreten en küçük örneği ayrı bir dosyada kurmak zaman alıyor, ama genellikle sorunun nerede olduğunu ortaya çıkarıyor.
Sonuç bölümü
Hata çözüldüğünde kök nedeni ve düzeltmeyi iki üç cümleyle yazıyorum. Mümkünse aynı hatanın tekrar etmesini engelleyecek bir test ekliyor ve onu da not ediyorum. Commit mesajına da kısa bir özet bırakıyorum.
Bu kayıtların en büyük faydası, aylar sonra benzer bir belirtiyle karşılaştığımda ortaya çıkıyor. Klasörde arama yapıp geçmişteki kendimin nerelere baktığını görmek, aynı yolu yeniden yürümekten çok daha hızlı.