Kaynak kod düzenleme ve dokümantasyon nasıl yapılır? Ağrı rehberi

01Adımlar

1. Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak

Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.

2. Riskleri ve öncelikleri listelemek

Bu adımın çıktısı kısa bir notla paylaşılır.

3. Test ortamı ve sürüm kontrolünü düzene sokmak

Bu adımda yapılan her değişiklik kayıt altına alınır.

4. Kritik hataları ve güvenlik açıklarını gidermek

Bu adımın çıktısı kısa bir notla paylaşılır.

5. Testleri ve dokümantasyonu tamamlamak

Bu adımda yapılan her değişiklik kayıt altına alınır.

6. Düzenli bakım ve geliştirme planına geçmek

Gerekirse bu adım test ortamında önceden denenir.

02Dikkat noktaları

• Kaçınılması gereken: yapılan değişiklikleri belgelememek
• Kaçınılması gereken: test ortamı olmadan canlıda düzeltme yapmak
• Kaçınılması gereken: sürüm kontrolü kullanmamak

03Belirti, neden ve çözüm

04Ağrı için çalışma düzeni

Ağrı, Doğu Anadolu Bölgesi'nde yer alan, plaka kodu 04 olan bir ildir; PTT verisine göre 8 ilçe ve 959 mahalle ve köy kaydından oluşur.

Ağrı'da bulunan bir işletmeyle çalışırken toplantılar görüntülü yapılır, her aşama test ortamında paylaşılır ve geri bildirimler ortak panoda toplanır; yerinde bulunmak gereken kurulum ve eğitim adımları ayrıca planlanır.

Aynı bölgedeki Iğdır, Bitlis ve Tunceli illeri için de kaynak kod düzenleme ve dokümantasyon projeleri aynı düzenle yürütülür.

05Kapsamı ve maliyeti etkileyenler

• aylık bakım mı olay bazlı iş mi
• erişimlerin hazır olup olmadığı
• kod tabanının büyüklüğü ve durumu
• dokümantasyon ve test kapsamı

06İşletim ve bakım ipuçları

• Her değişiklik sürüm kontrolünde kaydedilir ve test ortamında denenir.
• Hata kayıtları önceliğe göre sınıflandırılır.
• Aylık bakım raporunda yapılan işler ve açık riskler paylaşılır.

07Örnek kapsam hesabı

SSSSık sorulan sorular

→İlgili sayfalar

Bu sayfada geçen kavramlar

• README
• mimari şema
• kurulum kılavuzu
• bakım sözleşmesi
• dokümantasyon
• Git
• otomatik test
• refactoring
• hata kaydı
• Ağrı