Kaynak kod düzenleme ve dokümantasyon nasıl yapılır? Şabanözü 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

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

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

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

5. Testleri ve dokümantasyonu tamamlamak

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

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

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

02Dikkat noktaları

• Kaçınılması gereken: yapılan değişiklikleri belgelememek
• Kaçınılması gereken: hatayı yeniden üretmeden kod değiştirmek
• Kaçınılması gereken: sürüm kontrolü kullanmamak

03Belirti, neden ve çözüm

04Şabanözü için çalışma düzeni

Şabanözü, Çankırı iline bağlı bir ilçedir ve PTT adres verisine göre 33 mahalle ve köy kaydından oluşur. Bu kayıtlardan 1 tanesi organize sanayi veya serbest bölge kaydıdır.

Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Şabanözü'ndeki 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.

Çankırı genelinde Çankırı Merkez, Ilgaz ve Orta gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.

05Planlama notları

• Bakım kapsamı yazılı tanımlanır: izleme, güncelleme, hata düzeltme, küçük geliştirme.
• Önce kritik hatalar ve güvenlik güncellemeleri, sonra yeni özellikler.
• İşe kod ve altyapı incelemesiyle başlanır: kaynak kod, erişimler, sürümler, dokümantasyon.

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.

Yazılımı geliştiren firma artık ulaşılamaz olduğunda

Kaynak kod düzenleme ve dokümantasyon kapsamında kod ve erişimler devralınır, belgelenir ve risk analizi çıkarı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
• sürüm yükseltme
• otomatik test
• teknik borç
• Çankırı
• Şabanözü