Ekipte Bilgi Aktarımı: Kod İncelemesi ve Belgeleme

Ekipte Bilgi Aktarımı: Kod İncelemesi ve Belgeleme

3 dakika okuma

Yazılım ekiplerinde en pahalı bağımlılık, belirli bir sistemi yalnızca tek kişinin biliyor olmasıdır. O kişi izne ayrıldığında ya da işten ayrıldığında, sistemin bakımı durur. Bu risk kod kalitesiyle ilgili değildir; en temiz kod bile bağlamı bilinmediğinde yavaş ilerletilir.

Bilgi aktarımı, ayrı bir eğitim faaliyeti olarak değil, günlük iş akışının içine yerleştirildiğinde sürdürülebilir olur.

Bilgi neden tek kişide birikir?

Genellikle bilinçli bir tercih değildir. Bir modülü ilk yazan kişi, sonraki değişiklikleri de en hızlı o yapacağı için işler doğal olarak aynı adrese gider. Kısa vadede verimli görünen bu dağılım, birkaç ay içinde ekibin geri kalanını o alandan tamamen uzaklaştırır.

İkinci neden, bağlamın yazılı olmamasıdır. Kod ne yaptığını gösterir ama neden o şekilde yazıldığını göstermez. Alternatiflerin neden elendiği yazılı değilse, sonradan bakan kişi aynı tartışmayı baştan yapmak zorunda kalır.

Kod incelemesini öğretici kullanmak

İnceleme yalnızca hata bulma aracı olarak görüldüğünde, yorumlar kısa düzeltmelere indirgenir. Aktarım amacı eklendiğinde ise inceleme, ekibin ortak bilgi tabanını genişleten bir araca dönüşür.

  • Yorumda yalnızca ne değiştirileceği değil, nedeni de yazılır.
  • Soru sormak eleştiri sayılmaz; anlaşılmayan bölüm sorulduğunda çoğu zaman kodun kendisi netleşir.
  • Aynı alanın incelemesi sürekli aynı kişiye verilmez.
  • Büyük değişiklikler küçük parçalara bölünür; yüz dosyalık bir inceleme hiçbir şey öğretmez.

Karmaşık bir bölüm iki kişi tarafından birlikte yazıldığında aktarım en hızlı biçimde gerçekleşir. Bu yöntemin tüm işlere uygulanması gerekmez; kritik ve yeni alanlarda kullanılması yeterlidir.

Neyi belgelemek gerekir?

Her şeyin belgelenmesi sürdürülebilir değildir; güncellenmeyen belge yanlış bilgiden daha zararlıdır. Belgelenmesi gereken, kodun kendisinden okunamayanlardır: kararlar, kısıtlar ve dış bağımlılıkların davranışı.

Karar kayıtları bunun için basit ve etkili bir biçimdir. Her önemli teknik karar için tek sayfalık bir not tutulur:

PHP14 satır
# 004: Oturum verisi veritabanında tutulacak

Durum: kabul edildi (12.03.2026)

## Bağlam
Uygulama iki sunucuya dağıtıldı. Dosya tabanlı oturumlarda
kullanıcı ikinci sunucuya düştüğünde oturumu kayboluyor.

## Karar
Oturum verisi ortak veritabanında saklanacak.

## Sonuçlar
Her istekte bir sorgu daha çalışacak. Yük artarsa
bellek içi bir depo değerlendirilecek.

Bu notlar kod deposunda tutulduğunda değişiklikle birlikte gözden geçirilir ve güncel kalma olasılığı artar. Ayrı bir belge sisteminde tutulan notlar birkaç ay içinde eskir.

Yeni katılan geliştiricinin ilk haftası

Yeni katılan kişinin ilk gün karşılaştığı en sık engel, çalışan bir ortam kuramamaktır. Kurulum adımları yazılı değilse bu süreç günlere yayılır ve aktarımın tamamı sözlü hale gelir.

  • Kurulum adımları tek dosyada ve çalıştırılabilir biçimde tutulur.
  • İlk hafta için küçük ama gerçek bir görev seçilir.
  • Sistemin genel akışı bir şema ile anlatılır; kod okumaya bu şemadan sonra geçilir.
  • Sorulan soruların cevapları belgeye eklenir; aynı soru ikinci kez sorulduğunda eksik olan belgedir.

Anlatarak doğrulamak

Bir konuyu başkasına anlatmak, o konudaki boşlukları hızla ortaya çıkarır. Anlatım sırasında takılınan nokta, çoğu zaman gerçekten anlaşılmamış olan noktadır. Bu yöntem ekip içi kısa sunumlarda ya da yazılı özetlerde uygulanabilir.

Aynı etki yazarken de görülür. Bir çözümü yazıya dökmek, eksik varsayımları görünür kılar. Ekip içinde tutulan kısa teknik notlar hem yazanı hem sonradan okuyanı hızlandırır.

Bu pratiğin ölçülebilir bir çıktısı da vardır: bir konuyu anlatmak için hazırlanan kısa not, aynı konuyu sonradan öğrenecek kişinin başlangıç noktası olur. Zamanla biriken bu notlar, ekibin ortak hafızasını oluşturur ve sözlü aktarıma olan bağımlılığı azaltır.

Kontrol listesi

  • Hiçbir modül tek kişinin bilgisine bırakılmaz.
  • İnceleme yorumlarında gerekçe yazılır.
  • Aynı alanın incelemesi dönüşümlü yapılır.
  • Önemli teknik kararlar kısa notlarla kayda geçer.
  • Kurulum adımları yazılı ve çalıştırılabilir tutulur.
  • Tekrarlanan sorular belgeye eklenir.

İlgili yazılar

Yorumlar

Bu form reCAPTCHA ile korunur; Google Gizlilik Politikası ve Hizmet Şartları geçerlidir.

İlk yorumu sen yap.

İlgili Yazılar