Merhaba,
Yazılım belgeleme konusunda yazılım geliştirme aşamaları bazında ve
yazılım projesi bazında birçok belge üretilebilir... SWEBOK[1] yazılım
mühendisliği konusunda önemli bir kaynaktır. Burada yazılım geliştirme
süreçleri irdelenmiştir ve bu süreçler için, sırasında ve sonrasında
üretilebilecek belgeler, ilgili standartları referans gösterilerek
verilmiştir. Aşağıda aklıma gelen birkaç belgeyi listeliyorum...
+ Sistem tanımı/kullanıcı gereksinimleri
+ Sistem gereksinimleri tanımları
+ Yazılım gereksinimleri tanımları
+ Kavramsal modelleme belgeleri
+ Sistem tasarım tanımları
+ Test planı
+ Test raporları
+ Kabul test raporu
+ Son kullanıcı kullanım kılavuzları
+ Sistem yöneticisi kullanım kılavuzları
+ Kalite planları
Kod içinde yapılan belgelemede bu belgelerin bir parçasıdır.
Proje konusunda ise öncelikle ve tepede Proje planı olmak üzere buna
bağlı alt planlar oluşturulabilir. Aslında bu plan diğer mühendislik
proje planları ile benzerdir. Proje planında çalışma planı, iş kırılım
ağacı, belki bir gantt chart, risk planı, bütçe, vb. olabilir. Proje
yönetim ve planları konusunda temel kaynakda PMBOK [2] olarak
gösterilebilir.
Konu aslında oldukça derin. Belgelemeler genellikle proje büyüklüğü ve
projeyi yapan kurumun olgunluğu (CMMI veya ISO 15504 ile ölçülebilir
bunlarda), yazılım mühendisliği süreçlerini nasıl ele aldığına göre değişir.
Umarım fikir vermiştir...
Burak
[1] http://www.computer.org/portal/web/swebok/html
[2]
http://en.wikipedia.org/wiki/A_Guide_to_the_Project_Management_Body_of_Knowledge
On 27-05-2010 18:53, Rüştü Derici wrote:
katılmıyorum. bir uygulama sadece "kod" dan ibaret değildir. IT
(Enformasyon Teknolojileri) ve IS (Enformasyon Sistemleri) bazında
irdelenmesi şarttır.
Ben de açıkçası bu işi en iyi nasıl çözeriz kısmında takılıp kalıyorum..
bu standartlar ile ilgili dökümanları da akademisyen bi arkadaşıma
rica ettim gönderir yakında merakla bekliyorum şahsen.
Software Engineering dersi aslında tamda bu konu ile ilgili ..Bu
konuda güzel bir kitap ya da kaynaktan haberdar
olan var mı?
2010/5/27 hal 2000 hal <[email protected] <mailto:[email protected]>>
Kodun dökümanı, kodun kendisi olabilmeli (bkz:self-documening, bkz:
MS'in kodları)
2010/5/27 Faruk Temur <[email protected] <mailto:[email protected]>>:
> Merhabalar,
>
> İş ilanlarında hep görürüz, projelerini dökümantasyon veya
raporlama olarak
> sunabilen gibi ifadeleri. Bunlar üzerine merak ettiğim hususlar
şunlar:
>
> 1- Projeyi dökümantasyonlarken neler yapılmalı nasıl döküman
edilmeli?
> Örnekleri olan arkadaşlar fikir olması açısından paylaşabilir mi?
>
> 2- Raporlama derken nasıl bir raporlama. Tabi bu projeye göre
değişir
> biliyorum ama genel olarak nasıl bir raporlamadan bahsediliyor
ve yine
> bununla ilgili mümkünse bir örnek veri paylaşılabilinir mi?
>
> FreeBSD Handbook ve Redhat 'ın dökümantasyonu çok başarılı.
Dökümantasyon
> yapısınında böyle olması gerektiğini biliyorum ama merak ettiğim
bir yazılım
> projesinde PHP, Java vb. kodlamalarda nasıl bir dökümantasyon
oluşturulur.
> Fonksiyonların açıklamaları, parametleri vb. özellikleri
belgelendirilir,
> biliyorum. Peki bunun yanında başka neler belgelendirilir?
>
> Teşekkürler.
>
> _______________________________________________
> Linux-programlama mailing list
> [email protected]
<mailto:[email protected]>
> https://liste.linux.org.tr/mailman/listinfo/linux-programlama
> Liste kurallari: http://liste.linux.org.tr/kurallar.php
>
>
_______________________________________________
Linux-programlama mailing list
[email protected]
<mailto:[email protected]>
https://liste.linux.org.tr/mailman/listinfo/linux-programlama
Liste kurallari: http://liste.linux.org.tr/kurallar.php
_______________________________________________
Linux-programlama mailing list
[email protected]
https://liste.linux.org.tr/mailman/listinfo/linux-programlama
Liste kurallari: http://liste.linux.org.tr/kurallar.php
_______________________________________________
Linux-programlama mailing list
[email protected]
https://liste.linux.org.tr/mailman/listinfo/linux-programlama
Liste kurallari: http://liste.linux.org.tr/kurallar.php
