Yazılım tasarım dokümanı hazırlama rehberi yayımlandı

Eski Google ve Microsoft mühendisi Michael Lynch, karmaşık projelerde geliştirme süresini kısaltan ve ekipler arası koordinasyonu sağlayan yazılım tasarım dokümanı hazırlama rehberini yayımladı. Rehber, kodlama öncesinde kritik kararların netleştirilmesinin gereksiz iş gücü kaybını engellediğini ortaya koyuyor. Özellikle birden fazla ekibin dahil olduğu, üç aydan uzun sürecek ve üretim ortamında yıllarca çalışacak projelerde kapsamlı bir tasarım dokümanının zorunlu olduğu belirtiliyor.

Tasarım dokümanına hangi unsurların dahil edilmesi gerektiğini değerlendirirken hatalı kararların maliyetine odaklanmak gerekiyor. Rehbere göre programlama dili veya veri depolama katmanı gibi değiştirilmesi zor kararlar dokümanda ayrıntılandırılmalı, arayüz butonunun işleyişi gibi kolayca düzeltilebilecek kararlar tasarım seviyesinde tartışılmamalıdır. Böylece mühendisler detaylarda kaybolmadan projenin asıl mimari sorunlarını ve sistem sınırlarını görünür kılıyor.

Rehberde iyi yapılandırılmış bir tasarım dokümanının temel bölümleri de somut örneklerle ele alınıyor. Başlık, amaç, arka plan, hedefler ve kapsam dışı bırakılan unsurların yanı sıra servis seviyesi hedefleri (SLO), izleme mekanizmaları, bağımlılıklar, güvenlik sınırları ve veri gizliliği gibi katmanlar şablon olarak sunuluyor. Mimarinin diğer ekiplerce rahat anlaşılması için şemaların ve arayüz sözleşmelerinin ilk taslakta açıkça tanımlanması öneriliyor.