Neden Raporlama?
Bir projeyi profesyonel bir şekilde yürütürken, elde ettiğiniz bulguları, kullandığınız verilerin kaynaklarını, bu verilere erişme zamanlarını, bu süreçte takip ettiğiniz adımları ve bu adımları neden takip ettiğiniz gibi, 3 ay sonrasında unutulabilecek veya bir başkasıyla paylaşılabilecek bilgileri yazılı hale getirmeye ihtiyaç duyarız. Amacımız yazı yazmak için yazı yazmak değil; yaptığımız işi en güzel şekliyle sunacak ve uzun bir süre sonra geri döndüğümüzde deneyimlerimizi bize hatırlatacak kısa, öz ve şık bir döküman oluşturmak.
Kullandığınız verilerin veya yazılımların versiyonu değişebilir, saatlerce arayarak bulduğunuz bir çözüm birkaç ay sonra unutulabilir veya yaptığınız çalışmayla ilgilenen birisi o konuda uzman olmasa dahi neler yaptığınızı veya hangi adımları izlediğinizi anlamak isteyebilir.
Özellikle bir ekiple (akademi içinde veya dışında) çalışmaya başladığınızda yazma alışkanlığını kazanmış olmak birçok açıdan hayati önem kazanır. İyi bir şekilde hazırlanmış ve biçimlendirilmiş bir rapor emeğinizi ortaya çıkarır ve profesyonel imajınızı güçlendirir. Başlarda biraz sıkıcı gelse de, yazmak iyidir, faydalıdır.
Rapor Biçimi:
Her ne kadar kamuda "Times New Roman, 12 Font, Çift Satır Aralığı" kalıbı yerleşmiş olsa da, estetik ve pedagojik olarak bunun en doğru seçim olduğunu söylemek biraz zor. En doğrusu olmamakla birlikte, genel kuralları şu şekilde sıralayabiliriz:
- Yazı tipi, okumayı zorlaştırmayan modern bir font olmalı (PT Sans, Calibri, Cambria, Helvetica Neue, Tahoma, Arial vb.), Kokonor veya Comic Sans tarzı rahat yazı tipleri gerekmedikçe kullanılmamalı. Hangi yazı tipi seçildiyse onunla devam edilmeli. Kopyalayıp yapıştırılan metinlerin de yazı tipi düzeltilmeli ve tüm metin bütünlük içerisinde olmalı.
- Yazı boyutu, 10 veya 11 punto olmalı.
- Satır aralığı 1.15 ila 1.5 değerleri arasında seçilmeli.
- Gerekmedikçe renklendirmeden kaçınılmalı; metin siyah veya koyu gri tonlarında seçilmeli, arkaplan beyaz veya kontrast oluşturacak açık bir renkte olmalı.
- Bölüm başlıkları kalın olmalı, metin yazı boyutundan en az 1 punto büyük olmalı.
- Eğer raporun yapısını bozmayacaksa, raporun başlık bölümü tek sütun, raporun kalanı ise çift sutünlu hale getirilmeli.
Rapor içeriği:
Rapor, içeriğe ilişkin kısa bir başlığı, adınızı ve soyadınızı, iletişim bilgilerinizi (genellikle e-posta adresinizi), raporu tamamlama tarihinizi ve raporunuz çok sayıda kısımdan oluşuyorsa içindekiler kısmını içermelidir.
Her bir proje bölümü için hazırlayacağınız raporda:
- Raporun hangi problemi çözmek veya hangi durumu açıklamak için hazırlandığını belirten kısa ve öz bir açıklama yer almalıdır.
- Raporu hazırlamak için gerçekleştirdiğiniz çalışmalar maddeler halinde kısaca özetlenmelidir.
- Varsa, geliştirilen kodlar veya kullanılan formüller ayrı bir bölümde açıklamalarıyla yer almalıdır.
- Elde ettiğiniz sonuç veya bulgular özetlenmelidir.
- Kullanılan veri kaynakları veya çevrimiçi yazılımlar erişilme/kullanılma tarihleriyle birlikte ayrı bir bölüm olarak rapora eklenmelidir.
- Yapılan çalışmaların bir önceki raporla olan ilişkisi son bölümde ifade edilmelidir.
- Her bir bölüm, alt başlıklarla birbirinden görsel olarak ayrılmalıdır.
Projeyi tamamladığınızda hazırlayacağınız proje bitirme raporunda:
- Rapor başlığını, adınızı ve soyadınızı, iletişim bilgilerinizi ve rapor hazırlanma tarihini içeren bir kapak sayfası olmalıdır.
- Proje konusu ile rapor içeriğini anlatan ve 300 kelimeyi geçmeyen kısa bir özet yer almalıdır.
- Proje konusuna uzak kişilerin anlayabileceği tarzda, konunun arka planına dair bir giriş bölümü bulunmalıdır.
- Gerçekleştirdiğiniz çalışmaları ve elde ettiğiniz sonuçları içeren bir kısım yer almalıdır.
- Kullandığınız veri kaynakları ile çevrimiçi yazılımların erişilme tarihleri ve varsa versiyon bilgileri raporun sonuna eklenmelidir.
Dosyaya İlişkin Öneriler:
Kullandığınız kelime işlemci ne olursa olsun, hazırlanan döküman hem orjinal dosya biçiminde, hem .docx dosya biçiminde, hem de .pdf dosya biçiminde saklanmalı, mümkünse e-posta veya sanal sürücü gibi bir ortamda yedeği bulunmalı
Dosya isimleri açıklayıcı olmalı, dosyanın oluşturulduğu tarihi ve saati içermeli, aynı döküman sürekli olarak güncelleniyorsa her güncelleme ayrı bir dosya halinde kaydedilmeli ve dosya ismi en yenisi en yüksek sayıyı içerecek şekilde bir versiyon bilgisi içermeli. Örneğin: "Biyoinformatik_Projesi_29Haziran2013_23:25_versiyon1.pdf".