Kaynak kod düzenleme ve dokümantasyon: kendin yap mı, uzman mı? (Yakutiye)

01Kendiniz yapabilecekleriniz

• tüm erişim bilgilerini tek listede toplamak
• hataları ekran görüntüsü ve adımlarıyla kaydetmek
• kritik iş akışlarını yazılı hale getirmek

02Uzman gerektirenler

• kod denetimi ve teknik borç analizi
• regresyon testleriyle güvenli düzeltme
• sürüm yükseltme ve mimari iyileştirme

03Belirti, neden ve çözüm

04Yanlış uygulamanın riskleri

• Yapılan değişiklikleri belgelememek
• Tüm sistemi aynı anda yeniden yazmaya kalkmak
• Test ortamı olmadan canlıda düzeltme yapmak

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

• Hata kayıtları önceliğe göre sınıflandırılır.
• Bağımlılık güvenlik uyarıları düzenli taranır.
• Aylık bakım raporunda yapılan işler ve açık riskler paylaşılır.

06Hangi durumlarda gündeme gelir?

README gerektiğinde

README, kaynak kod düzenleme ve dokümantasyon projesinde kapsamın başında konuşulan başlıklardandır; analizde kimin kullanacağı ve nasıl çalışacağı netleştirilir.

Yeni özellik eklemek her seferinde riskli olduğunda

Kod iyileştirme ve test otomasyonu ile değişiklik maliyeti düşürülür.

07Kaynak kod düzenleme ve dokümantasyon hangi işletmelerde kullanılır?

• Özel yazılımlar
• Yarım kalan projeler
• Web siteleri
• Eski (legacy) sistemler

08Planlama notları

• Değişiklikler sürüm kontrolüyle (Git) ve test ortamında yapılır.
• Önce kritik hatalar ve güvenlik güncellemeleri, sonra yeni özellikler.
• Kaynak kod ve sunucu erişimi işletmede olmalıdır; değilse önce bu çözülür.

09Kapsamı ve maliyeti etkileyenler

• kullanılan teknolojilerin güncelliği
• erişimlerin hazır olup olmadığı
• dokümantasyon ve test kapsamı
• aylık bakım mı olay bazlı iş mi

10Yakutiye'de uzman desteği

Yakutiye, Erzurum iline bağlı bir ilçedir ve PTT adres verisine göre 44 mahalleden oluşur.

Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Yakutiye'deki işletmelerle ekran paylaşımlı demolar ve ortak bir proje panosu üzerinden çalışılır. Donanım kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.

Aynı ildeki Çat, Karayazı ve Tekman ilçeleri için de kaynak kod düzenleme ve dokümantasyon talepleri değerlendirilir; toplantılar uzaktan yapılır.

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
• teknik borç
• refactoring
• hata kaydı
• test ortamı
• Erzurum
• Yakutiye