Kodun dökümanı, kodun kendisi olabilmeli (bkz:self-documening, bkz: MS'in kodları)
2010/5/27 Faruk Temur <[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] > 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
