DESIGN.md nedir?
Bir yazılım projesinin mimari kararlarını ve tasarım mantığını açıklayan dokümantasyon dosyasıdır.
Tanım
Yazılım geliştirme süreçlerinde, projenin temel yapısını ve neden bu şekilde kurgulandığını anlatan bir rehberdir. Genellikle proje klasörünün en üstünde yer alır. Geliştiricilerin projenin neden bu mimariyi seçtiğini anlamasını sağlar.
Nasıl çalışır?
Proje klasörüne 'DESIGN.md' adında bir dosya oluşturun. İçerisine projenin amacını, seçilen teknolojileri ve tasarım ilkelerini yazın. Ekip arkadaşlarınızın bu dosyayı okuyarak projeye hızlıca uyum sağlamasına yardımcı olun.
Nerede kullanılır?
GitHub veya GitLab gibi platformlardaki açık kaynaklı projelerde veya kurumsal yazılım depolarında sıkça karşılaşırsınız.
Sık karıştırılanlar
README.md dosyasıyla karıştırılabilir; README projeyi nasıl çalıştıracağınızı anlatırken, DESIGN.md projenin neden öyle tasarlandığını anlatır.
Sıkça sorulanlar
Neden ayrı bir tasarım dosyasına ihtiyacım var?
Kod karmaşıklaştıkça, alınan kararların mantığını unutmamak ve yeni gelenlerin sistemi anlamasını kolaylaştırmak için gereklidir.
İlgili terimler
İlgili araçlar
Bu açıklama TreScout için sade dille hazırlandı · yanlış ya da eksik gördüğünüz bir şey olursa hello@trescout.com. TreScout her gün GitHub, Hacker News ve HuggingFace trendlerini Türkçe özetler.