Yazılım Mühendisliği

Ekim 18, 2008

Yazılımda Dokümantasyona Farklı Bir Bakış

Filed under: Metaforlar,Metodolojiler — Yahya KOÇ @ 12:01 pm
Tags:

Agile Manifestosu‘ndan hatırlayacağımız üzere çalışan yazılıma,kapsamlı dokümantasyondan daha fazla önem veriyoruz.Bu demek değildirki dokümantasyona önem vermiyoruz.Fakat “çalışan yazılımın kendisi zaten bir dokümandır” mantığıyla hareket ediyoruz.
“Code Complete” kitabının “Yazılım Metaforları” bölümünde şöyle bir açıklama var:
…………
1998 tarihli bir çalışmaya göre bir milyon satırdan oluşan bir yazılım için yaklaşık 69 farklı doküman tipine ihtiyaç varmış.Bu büyüklükte bir sistemin gereksinim dokümanları 4000-5000 sayfadan oluşuyormuş.Tasarım dokümanları bu sayının iki üç katıymış.
…………..

Bu kadar büyüklükte bir dokümantasyonun bırakın anlaşılmasını beklemek, okunması bile çok zordur.Neredeyse kod satırından çok doküman yazılıyor.Eski metedolojilere göre zaten geçerli olan “koddan çok açıklama satırı” mantığıdır.Günümüzde bile bu tür görüşleri savunanlar var.Saygı duyuyoruz.

Bugün daha çok yazılımın ürün hali ile ilgili dokümantasyondan bahsetmek istiyorum.
Bir iş uygulam yazılımı yaptığınızı düşünelim.Uygulamayı devreye alıyorsunuz.Kullanıcılara uygulama için eğitim vermeniz gerekli.Ama önce kalite standartları gereği kullanıcı klavuzu yazmanız gerektiği hatırlatılıyor.Fontlar,şablonlar,imlâ kuralları…. Doküman yazmak kod yazmaktan çok daha zor hale geliyor… Yazılımcının en büyük hazinesi zamandır.Doküman yazmak kolay bir işlem olsa da çok fazla zamana mâl olur(Aynı şekilde sayfa üzerinde html ile uğraşmak vs..).Bir şekilde dokümanı yazmayı bitirdiğinizi varsayalım.Eğitim için insanları toplayıp iki saatte yazılımın işlevlerini anlatmaya çalışıyorsunuz.Ne kadar faydalı olduğu şüpheli.Doküman yazmak için çok değerli iki saatinizi harcıyorsunuz.Eğitim vermek için tüm şirketin çok değerli iki saatini harcıyorsunuz.
Bu tür eski moda dokümantasyon ve eğitim teknikleri yerine, kaydedilmiş eğitim videolarını tercih etmemiz gerektiğini düşünüyorum(Bknz. Camtasia). Yazılım her işlevini anlatan ufak ufak videolar kaydedip bütün kullanıcıların erişebileceği ortak bir noktaya koyun.Böylece kullanıcılar,programda takıldıkları yerde bu videroları izleyip sorularına cevap bulabilecekler.Artık her takıldıkları yerde sizi aramayacaklar.”Call center” olmaktan kurtulacaksınız.

Bu yöntemle elde edeceğimiz kazanımlarımızı özetleyelim:

  • Kullanıcıların hiç bir zaman okumayacağı klavuzlar hazırlamak için çektiğiniz eziyetten kurtulacaksınız.
  • Doküman yazmak ve eğitim vermek için, sizin ve kullanıcılarınızın zamanını harcamamış olacaksınız.
  • Kullanıcılar tarafından sürekli rahatsız edilmeyeceksiniz.

Yorum yapın »

Henüz yorum yapılmamış.

Bu yazıya yapılan yorumlar için RSS beslemeleri. URI'nin geri izlemesini yap.

Yorum yapın

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Değiştir )

Twitter picture

You are commenting using your Twitter account. Log Out / Değiştir )

Facebook photo

You are commenting using your Facebook account. Log Out / Değiştir )

Connecting to %s

Theme: Rubric. WordPress.com'dan blog alın.

Follow

Get every new post delivered to your Inbox.