Hazırlayan:Emin BORANDAĞ

1. Hazırlayan:Emin BORANDAĞ

2. Yazılım Dokümanı • Günümüzde yazılımların yapılarının ve içeriklerinin artması ile birlikte yazılım dokümanları bir readme.txt olmaktan çıkmıştır. • Yazılım içeriğinin doğru anlatılması oldukça önemlidir. • Yazılım test uzmanı tarafından dokümanın test edilmesi gerekmektedir.

3. Yazılım Dokümanı • Text ve grafikler içermeli. • Uyarılar ve kayıt bilgileri içermeli • End User License Agreement (EULA) • Kurulum ve kurulmun ne şekilde yapılacağı • User’s manual • Online help • Örnekler uygulamalar • Hata mesajları

4. Yazılım Dokümanı • Hangi şartlar altında çalışıyor? • Mac yada düşük özellikli bilgisayarlarda çalışıyor mu? • Dokuman testi kara kutu testinin bir parçasıdır! • Buradaki bir hata yazılımın içerisindeki hata gibidir! • Hatalara ilişkin yardım bilgilerini içermelidir

5. Dokümantasyon Testi • Hazırlanan doküman çok temel yada çok karmaşık olmamalı. • Terminoloji • Okuyucular için yeteri kadar uygun mu? • Bilgiler düzenli bir sırada mı? • Kısaltmalar bir dizin içerisinde verilmiş mi? • Teknolojik bilgilere yer verildi mi? • Web sayfası,telefon num ve bilgilerin yer aldığı bir index var mı? • Yazılımın özellikleri tam olarak anlatılmış mı? • Verilen örnekler doğru olarak çalışıyor mu?

6. Tartışma • Dokümantasyonu kimler yazmalı? • Dokümanı neden farklı kişiler tarafından yazılım ile karşılaştırılmalı?

7. Otomatik olarak kod dokümanı oluşturma araçları • Doxygen • Javadoc • ROBODoc • POD • TwinText • Karşılaştırma • http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

8. Son incelenen konular • Yazılım dokümanında neler olmalıdır? • Dokümanı test etmek neden önemlidir? Niye test edilmelidir? • Doküman oluşturmak için kullanılan araçlar var mıdır?