Bu hafta deneyin: kod deponuzda küçük bir düzen turu

Yazılımla uğraşan herkes bilir: proje büyümez, yavaşça dağılır. Bir deneme dosyası kalır, bir not kopyalanır, bir ayar yalnızca sizin makinenizde çalışır. Sonbaharın ortasında işler biraz sakinleşirken bu dağınıklığa bakmak için iyi bir zaman.

Bu yazıda büyük bir yeniden yapılandırmadan söz etmiyorum. Hedef, bu hafta içinde yarım saatlik iki üç oturumla bitirebileceğiniz küçük işler. Bir kişilik bir yazılım işi de yapsanız, küçük bir ekibin parçası da olsanız aynı sıra geçerli.

Her adımı bitirdiğinizde projeyi bir kez çalıştırıp açıldığından emin olun. Böylece düzen adına yanlışlıkla bir şeyi bozmazsınız ve yaptığınız işin gerçekten fark yarattığını görürsünüz.

Deponuzu ya da proje klasörünüzü açıp dosya listesine baştan sona bakın. Adı belirsiz olanlar, tarihi eski kalanlar ve artık hiçbir yerden çağrılmayanlar adaydır. Hemen silmek yerine önce bir kenara taşıyın, birkaç gün sonra hâlâ ihtiyaç duyulmadıysa kaldırın.

Sürüm kontrolü kullanıyorsanız silmekten çekinmeyin, çünkü geçmiş kayıtlı kalır. Kullanmıyorsanız bu, işe başlamak için iyi bir neden: tek bir klasörü bile olsa sürüm kaydına almak ileride çok iş kurtarır.

Ayıklarken kendinize şu soruyu sorun: bu dosya olmadan proje bir ay sonra yine açılır mı? Cevap evetse yeri artık burası değildir.

• Adı belirsiz deneme dosyalarını not alarak ayırın
• Silmeden önce bir kopyasını ayrı klasöre taşıyın
• Sürüm kaydı yoksa ilk kaydı bugün oluşturun

Projenin kök klasöründe, kendi cümlelerinizle yazılmış kısa bir açıklama dosyası bulunsun. Projenin ne yaptığını, nasıl çalıştırıldığını ve hangi araçlara ihtiyaç duyduğunu anlatan birkaç satır yeter. Uzun ve süslü olması gerekmez.

Bu dosya aslında gelecekteki kendinize yazılmış bir nottur. Üç ay sonra projeye döndüğünüzde hangi komutla başlatmanız gerektiğini hatırlamak zorunda kalmazsınız. Ekipte çalışıyorsanız yeni gelen kişinin sorularının yarısı baştan yanıtlanmış olur.

Yazarken hep aynı şablonu izleyin: amaç, kurulum, çalıştırma, bilinen sorunlar. Dört başlık ve her birinin altında iki üç cümle çoğu küçük proje için yeterli.

• Amaç: proje ne işe yarıyor
• Kurulum: hangi araçlar ve sürümler gerekiyor
• Çalıştırma: tek komutla nasıl başlatılır

Parola, adres ve anahtar gibi değerlerin kodun içinde durması hem güvenlik hem düzen açısından sorun yaratır. Bunları ayrı bir ayar dosyasına taşıyın ve bu dosyanın sürüm kaydına girmediğinden emin olun.

Yanına, içi boşaltılmış bir örnek ayar dosyası koymak iyi bir alışkanlıktır. Böylece başkası ya da gelecekteki siz hangi değerlerin doldurulması gerektiğini görür, gerçek değerler ise paylaşılmaz.

Bu adım biraz dikkat ister: taşıma sırasında bir değeri unutursanız proje açılmayabilir. Hata mesajlarını okuyarak eksik değeri bulmak genellikle on dakikayı geçmez.

Üç işi aynı akşam bitirmek zorunda değilsiniz. Bir akşam ayıklama, bir akşam açıklama dosyası, bir akşam ayarlar. Her biri yarım saati geçmezse sürdürmek kolay olur ve yarım kalan iş de bırakmazsınız.

İş yoğunsa en az değerli görünen ama en çok iş görenden başlayın: açıklama dosyası. Çünkü dosyaları ayıklamak ve ayarları taşımak, projenin ne yaptığını yazıya döktüğünüzde zaten daha net görünür hale gelir.

Her adımdan sonra değişikliği kısa bir mesajla kaydedin. Mesajda ne yaptığınızı bir cümleyle yazın; birkaç hafta sonra geçmişe bakarken bu satırlar size yol gösterecek.

• Her oturumu yarım saatle sınırlayın
• Her adımdan sonra projeyi bir kez çalıştırın
• Değişiklikleri kısa mesajlarla kaydedin

Bir kez düzen kurmak kolay, korumak zor. Bunun için yeni bir dosya eklerken aynı soruları kendinize sorun: adı anlaşılır mı, yeri doğru mu, açıklamada geçmesi gerekir mi. Üç saniyelik bu kontrol büyük dağınıklığı önler.

Ayda bir kez, takvime not düşerek, aynı küçük turu tekrarlayın. Bu sefer işiniz çok daha kısa sürecek, çünkü yalnızca son bir ayda birikenlere bakacaksınız.

Düzen tutkusu gerekmez; yalnızca projeyi bir sonraki açışınızda kendinize kolaylık sağlamak yeter.