Deney Raporlarının Hazırlanması Şükrü Tikveş, Hacettepe Üniversitesi, Mart 2005

İçerik Raporlar Hakkında Bölümümüz Standartları Bu Ödeve Özel Notlar

Üslup: Raporlar kompozisyon değildir Fikirler değil sonuçlar anlatılır Resmi bir dil kullanılır Kısa ve net cümleler kullanılır Şahıs ve kiplerin kullanımını ayrıca araştırıp öğrenin!

Hedef Kitle Yazan için değil, okuyacaklar için hazırlanır Okuyanın sorularına cevap vermesi beklenir Hızlıca okumak için uygun olmalıdır

Durum: Hacettepe Asistanları Her raporda farklı beklentiler vardır Asistana ve ödevin içeriğine göre değişir Genelde deney tanımı içerisinde net olarak belirlenir Bölüme özel rapor standardı (birazdan değinilecek)

Bilgi Derlenmesi Ana kaynak: ödevinizin gerçekleştirimi Online kaynaklar Algoritma ansiklopedileri Çizimler Yorumlar ve karşılaştırmalar Referans göstermeyi unutmayın!

Yapı: Cümleler, Paragraflar Cümleler basit ve açık olur Paragraflar kısa olur, konu değiştikçe yeni bir paragrafa başlanır Not: uzun paragraflar “okunmazlar” İNG223 – Yazma Becerileri dersinde öğrendiklerini kullanın

Biçim: Ana Hatlar Sayfa düzeni Sayfa numaraları Yazı tipleri ve biçim Hizalama Paragraflar

Biçim: Hatalar Hizalama için boşluk kullanmayın Raporunuzun düzgün gözüktüğünü denetleyin Gereksiz resimler (şenlik) ile ciddiyete gölge düşürmeyin

Biçim: Yazı Tipi Aileleri Serif (ex: Times) Normal metinlerin tümü Sans Serif (ex: Arial) Başlıklar, algoritma anlatımı Fixed (ex: Courier) Kod kesimleri Fantasy (ex: Comic Sans MS) Asla kullanmayın!

Biçim: Vurgulama Alt çizgi: yanlış anlaşılma ihtimalini azaltmak için kullanılır Örn: “Aşağıdakilerden hangisi doğru değildir?” İtalik: Beklenmeyen veya yabancı durumları anlatmak için kullanılır Örn: “UNIX işletim sisteminde pointer hataları segmentation fault olarak adlandırılmaktadır.” Kalın: Başlıklar ve şiddetli vurgu için kullanılır Örn: “Quick sort – hızlı sıralama, her türlü girdi için uygun değildir.”

Biçim: Vurgulama (Devam) Biçim değiştirmeden yapılan vurgulama yöntemleri de vardır: Parantez içerisinde (konuyla doğrudan ilgili olmayan) ek bilgilerin yazılması Tırnak içinde “alıntıların ve özel durumların” yazılması (italik alternatifi) Açıklamaların – burada olduğu gibi – kesme işaretleri arasında verilmesi (parantez alternatifi)

Biçim: Vurgulama (Devam) Bunlar katı kurallar değildir, uygun görüldüğünde farklı vurgulama teknikleri (düzgün gözükmesi kaidesiyle) kullanılabilir

Biçim: Vurgulama: Hatalar Birden çok vurgu biçimi bir arada (çok özel durumlar hariç) kullanılmaz. Renk, yazı tipi değişimi, vb tercih edilmez

Biçim: MS Word Biçimlerinden Faydalanma Belge içindeki biçimlerin tutarlı olması için, elinizdeki kelime işlemcinin özelliklerinden faydalanın!

İmlâ ve Dilbilgisi Raporlarınızda hataları olmamalıdır İmla Dilbilgisi Noktalama ve boşluk hataları olmamalıdır

Grafikler ve UML Çizimleri Nesne yapısı, Modül ilişkileri, Bileşen yapıları, Program Akışı, ve benzeri mimari özelliklerin anlatımını grafiksel çizimlerle de destekleyin

Hacettepe Rapor Yazım Kılavuzu [ ftp://ftp/pub/dersler/BIL1XX/BIL137_BL-I/0X-04/exp1_2002/rapor-format.pdf ] Bölümdeki tüm yazılım ödevi raporları için geçerlidir

Kapak Sayfası Tek sayfa halinde Tanıtım amaçlı Ödevin kendisini Raporu hazırlayanı Kim için hazırlandığını

Katalog Bilgileri Tek sayfa halinde Arşivleme / kütüphane amaçlı

Yazılım Kullanım Belgelendirmesi Programın “ne işe yaradığı” ve “nasıl kullanılacağı” anlatılmalı Kullanım örneklerine yer verilmeli

YKB: Hatalar Programın “ödev” amacıyla hazırlandığından bahsedilmez (bu bir sonraki bölümde yapılmalı) Program çalışması “sabit genişlikli” yazı tipi ile gösterilir

Tasarım Belgelendirmesi Yazılımın ne amaçla hazırlandığı, Hazırlarken karşılaşılan sorunlar ve bunların çözümleri Yazılımın mimari tasarımı

TB: Problem ve Çözüm Problem kesiminde, ödevi ve karşılaşılan sorunları, kendi anladığınız şekilde anlatacaksınız. Çözüm kısmında, varsa olası çözümleri, kendi çözümünüzü ve bunu niçin tercih ettiğinizi anlatacaksınız

TB: Problem ve Çözüm: Hatalar Ödev tanımını kopyalamayın! Çözüm kesiminde “iki hafta boyunca başınızdan geçenleri” anlatmayın Sıkıcı ve amacı olmayan açıklamalardan kaçının (net ve hedefe yönelik açıklamaları tercih edin)

TB: Algoritmalar: Hatalar Gerekli gereksiz tüm yordamları İngilizce olarak yazmayın Algoritmanızı rakam kalabalığı ile okunmaz hale getirmeyin Veri yapısında “lafı dolandırmayın”, yığıt kullanıyorsanız “there is an array…” diye başlamayın, doğrudan stack deyin.

TB: Algoritmalar: Örnek Okunur Kısa ve net Tüm durumları kapsayan Mantıksal olarak tutarlı - coherent

Yazılım Sınama Notları Yazılımızı kendi sınamanız sırasında karşılaştığınız bulgular yazılır

Referanslar Referanslarınız eksiksiz olarak yazın Dipnot kullanmayın, ekler kısmında tüm referansları listeleyin Düzgün bir biçim (listeleme) kullanın Aşağıdaki referansları verin!

Bu Ödev Hakkında Büyük ağırlık rapor kesiminde (%60) Kendi çalışmanız ve ürün sunumu olarak bir miktar farklı

Algoritma Anlatımı Algoritmayı kendi cümlelerinizle “açıklayın” Ana fikrini anlatmaya çalışın Pseudo code tercih edilir

Algoritma: Davranış Davranışı şekillerle gösterin Bu şekillerden bir anlam çıkarmaya çalışın (biraz önce bahsedilen ana fikir açıklaması)

Algoritma: Karşılaştırma Algoritmalarınız grafiklerle karşılaştırın Grafiklerden yorum çıkarmaya çalışın Hangi algoritma hangi durumda tercih edilir Algoritmaların, varsa, zayıf yönleri nelerdir?

Kaynaklar Bulduğunuz kodların kaynaklarını eksiksiz olarak verin Eksik kaynak o kesimin kabul edilmemesine yol açar Yaptığınız değişiklikleri de belirtin

Son olarak Bölümde bir öğrenci en az 25-30 rapor hazırlanıyor Bölüm sonrası hayatta da öneriler ve çalışmalar rapor olarak sunulacak Kendinizi yazılı ve sözlü ifade edebilme kabiliyeti çok önemlidir

Tavsiyeler Her türlü raporlarınız teslim etmeden önce mutlaka gözden geçirin Anlamadığınız noktalarda raporu talep eden kişilerle (müşteriyle) konuşun