Herhangi bir dilde geliştirilen uygulamalarda-yazılımlarda zamanla devredileceğini de düşünerek nasıl bir dökümantasyon hazırlanmalıdır. Bunların bir standardı var mıdır ?

  1. Proje başka bir geliştiriciye devredilecek olduğu durumda dökümantasyon nasıl olmalıdır.
  2. Son kullanıcı için hazırlanacak dökümantasyonun esasları ne olmalıdır ?

Bunlara ek olarak, Javadoc'ın hazırlanacak dökümandaki rolü ne olmalıdır ?

Teşekkürler

soruldu: 14 Ağu '12, 07:18

ersinyildiz's gravatar image

ersinyildiz
2.8k31438
cevap kabul oranı: 28%


Çevik manifesto'dan iki madde hatırlamak gerekirse:

  • Individuals and interactions over processes and tools
  • Working software over comprehensive documentation

Bu kural tabi ki iş devrinin hangi iki kişi arasında olduğuna bağlı. Eğer iş yeni gelen bir çalışana devredilecekse tabi ki bir dökümantasyona illaki ihtiyaç doğuyor (ancak bunun Javadoc ve wiki kullanımı dışına çıkmaması gerektiği kanaatindeyim). Bu devir şirket içi çalışan iki kişi arasında olacaksa, bu durumda işte işin içine biraz çeviklik girmekte, ve "processes and tools" kısmından önemli olarak "Individuals and interactions" önem kazanmakta. Şirket içi "code review" ve "pair programming" ile ortak kod sahipliği yaratılarak hali hazırda şirket içi çalışan devirlerinde kolaylık sağlanmalı. Bu sağlanması gereken kolaylık ile birlikte şirket içi devir işlemleri ile ilgili dökümantasyon anlamında temelde iki kavram var: Javadoc ve Wiki.

Javadoc'lar hem şirket içi çalışan devirlerinde, hem de yeni çalışan devrinde oldukça büyük öneme sahip.Bu sebeple geliştirme aşamasında yorum eklemekten kaçınılmamalı.

Bunun dışında şirket içi bir wiki veya portal kullanımı, alınan spesifik hataların çözümlerinin buraya girilmesi ve şirket içi kullanılan yazılım geliştirme araçlar ve sistemlerinin kurulum dökümantasyonunun burada tutulması gerekli olduğunu düşündüğüm şeylerden biri. Bu dökümantasyonun formatı her şirket için farklı olabilir.

"Working software over comprehensive documentation" ilkesine sadık kalarak, dökümantasyondan önce ve öncelikli olanın çalışan bir yazılım olduğu kanaatindeyim, ki bu hem müşteri için, hem de deviredilecek kişi için bir "görsel ve oynanabilir" zemin hazırlayacak. Proje yöneticileri bu zemin üzerinden belirli bir formata göre(bu format yine şirketten şirkete değişebilir, ancak temelde basitçe ifade etmek gerekirse vogella.com sitesindeki tutorial dökümanları formatına benzer) müşteri için yazılı bir dökümantasyon oluşturup somutlaştırabilirler. Bundan da öte projede BDD(Behaviour Driven Development), ATDD vs. kullanılıyorsa buradaki use-case'leri kullanıp da mock-up çizimler ile birlikte kolaylıkla döküman oluşturabilirler, ki bunu Çevik metodolojilere göre zaten temelde sürüm ve iterasyon planlama toplantılarında(ya da öncesinde) müşteri ile ortak çalışarak yapmaları gerekir.

permanent link

cevaplandı: 15 Ağu '12, 02:21

mabulgu's gravatar image

mabulgu ♦
2.8k43040
cevap kabul oranı: 26%

değiştirildi: 15 Ağu '12, 02:23

Cevabınız
toggle preview

Bu soruyu takip et

E-Posta üzerinden:

Üyelik girişi yaptıktan sonra abonelik işlemlerini yapabilirsiniz

RSS üzerinden:

Cevaplar

Cevaplar ve Yorumlar

Yazı Formatlama

  • *italic* ya da _italic_
  • **bold** ya da __bold__
  • link:[text](http://url.com/ "başlık")
  • resim?![alt text](/path/img.jpg "başlık")
  • liste: 1. Foo 2. Bar
  • temel HTML etiketleri de kullanılabilir

Bu sorunun etiketleri:

×1,079
×25
×1
×1

Soruldu: 14 Ağu '12, 07:18

Görüntüleme: 1,362 kez

Son güncelleme: 15 Ağu '12, 02:23

powered by BitNami OSQA