BDE İÇİN ETKİLİ DOKÜMANTASYON OLUŞTURMA
SÜREÇ
Dokümantasyon Planlama ve Organizasyon
Yazılım Dokümantasyonu Bilgilendirici kullanıcı seviyesinde Açık Anlaşılır
Anlaşılır bir dil- Ağır bir dil Kullanıcıyı teknik terimlere boğar Önemli noktaları ve bilgileri içermez Aynı bilgiyi tekrar tekrar verir Açıklama yapmada Yetersiz kalır Referanslar ve indeks bölümünü içermez Sayfalar grafiklerden yoksun sadece metin doludur Yeterli açıklamalar Açık ve anlaşılır anlatım Bilgi dolu Kullanıcıyı teşvik edici İyi organize edilmiş Hızlı yardım
Yetersiz dokümantasyona neden olan etkenler Zaman kısıtı Hedef kitlenin iyi tanımlanmaması Yetersiz tasarım
Kullanıcı Seviyesinde Dokümantasyon Kullanıcının farkını farkedin Kendinizi kullanıcı yerine koyun Dokümanı kullanıcı gözü ile hazırlayın Teknik terimleri tanımlayın Deneyin ve güncelleyin
Doküman Türleri Öğretmen El Kitabı Öğrenci El Kitabı Teknik Bilgiler El Kitabı
Öğretmen El Kitabı Pedagojik Bilgi Konu Yaş Öğretim hedefleri Öğretim için kullanım BDE Türü Öğretim sıralaması Gerekli ön bilgiler Ders sonrası etkinlikler Kayıt tutma fonksiyonları
Öğretmen El Kitabı Donanım Bilgisi Bilgisayar yazılımı Yardımcı donanımlar Başlamak için yapılması gerekenler
Öğretmen El Kitabı Yazılım Bilgisi Çalışma zamanı Yardımcı materyaller Değerlendirme yöntemleri Öğrenci kontrol türü Bilgi saklama özellikleri Yedekleme özelikleri Yetersizliklerin listesi
Öğrenci El Kitabı Pedagojik Bilgi Programın tanımı ve türü Öğretim hedefleri Örnekler ve alıştırmalar Alınan notlar Diğer etkinlikler ve yardımcı bilgiler Gerekli ön bilgiler Program kayıtları
Öğrenci El Kitabı Donanım Bilgisi Bilgisayar sistem gereksinimleri Başlama yöntemleri Sistem hataları Giriş & rapor oluşturma yöntemleri
Öğrenci El Kitabı Yazılım Bilgisi Program gereksinimleri Uygunluk Hata mesajları Gerekli yöntemler Özellikler & komutlar Performans özeti
Teknik Bilgiler El Kitabı Pedagojik Bilgi Yorumlar Dönüt Programın gözlenmesi ve not alınması
Teknik Bilgiler El Kitabı Donanım Bilgisi Programın geliştirilirken kullanılan sistem özellikleri Programın test edildiği tüm platformlar Performans konusunda önemli farklılıklar hakkında notlar
Teknik Bilgiler El Kitabı Yazılım Bilgisi Orjinal yaılım tasarımına ilişkin notlar Programın disk üzerinde dağılımı Değişikler hakkında bilgi Geleceğe yönelik iyileştirmeler Açıklamalar Yardımcı donanımlar hakkında bilgiler Akış şeması Programcı
Dokümanın Organizasyonu Öğrenci ve öğretmen el kitabı için ayrı bölümler
Eklerin yazılması Hata mesajları Sözlükler Indeks Örnekler
Dokümanın Diğer Bileşenleri Kapak İçindekiler Örnek, tablo ve grafiklerin listesi
Yazım stili ve doküman yazımının sonlandırılması
Basit ve açık bir dil kullanma işe yarama kullanma sonlandırma bitirme kullanıma hazırlama başlatma sayısal olarak fazla pek çok düzenleme değiştirme Şu anda şimdi Büyük miktarda bolca/çokça Bu nedenledir ki bu yüzden Bu gerçeğe bağlı olarak bu nedenle
Kullanıcıyla konuşuyormuş gibi yazın Konuşma dilinde yazma Kısaltma kullanın. Sorular sorun. Kullanıcıya seslenin. Argodan kaçının. Klişe sözler ve deyimler kullanın. Kısa cümleler kullanın. Bağlaç kullanmaktan kaçının. Kullanıcıyla konuşuyormuş gibi yazın
Konuşma dilinde yazma Zayıf: Bu program tarafından sunulan ve kullanıcıya yanlış giriş yaptığını söyleyen hata mesajları kullanıcıya yardım eder Daha iyi: Yanlış giriş yapıldığını açıklayan hata mesajları kullanıcıya yardım eder
Kelime kullanımında tutarlılık Doğru kelime/kelime grubunu bulduktan sonra hep aynı şekilde kullanın Kullanıcı Rehberi Kullanıcı El Kitabı Enter’a basın Enter tuşuna basın Enter butonuna basın
Büyük harflerin doğru ve tutarlı kulanımı “ENTER” “enter komutu” “Enter Komutu”
Kısaltmaların doğru kullanımı Kelime grubu kısaltmaları: DOS,RAM,I/O,OS/2 Kelime kısaltmaları: vb. ve benzeri vd. ve diğerleri
Teknik terimlerin (jargon) azaltılması Bit, bayt, dosyalar, kayıtlar, data, veri, varsayılan, ana doküman vb.
Fillerin aktif olarak kullanımı Aktif: öğrenci giriş tesitini tamamlar Pasif: giriş testi öğrenci tarafından tamamlanır Ör: Başlamadan önce disketinizi formatlamanız gerekir Öğretmen performans raporunuzu daha sonra gözden geçirecek Program herhangi bir anda çıkmak için ESC tuşunu kullanabilirsiniz
Etkili gramer ve noktalama işaretleri kullanımı Cümlelerin tamamlanmış olduğuna dikkat ediniz. Fiilleri tutarlı bir şekilde kullanın. Akıcı geçişler kullanın. Virgülleri gerektiği yerlerde kullanın. Tutarlı bir yapı kullanın. Noktalı virgül, tırnak, soru işareti gibi nokamalam işaretlerini gerektiğinde kullanın.
Birazda eğlence ... Programcı spesifik olarak öğretmediği sürece bilgisayar değişik şekillerde davranacak kadar zeki değildir
Grafikler ve Şekiller Yöntemsel akış şemaları Çizimler ve çizgi resimler Fotoğraflar
Doküman yazımının sonlandırılması Görsel bir format hazırlanası Doküman nasıl çoğaltılacak? Ne tür kağıt kullanılacak? Sayfalar hangi boyutta olacak? Hangi yazı tipi kullanılacak? Ne kadar boşluk bırakılacak? Doküman ne kadar renkli olacak? Ne tür bir kapak ve cilt kullanılacak?
Doküman yazımının sonlandırılması Parçaların oluşturulması Başlıklar Simgeler Anahtar kelimeler Önemli noktalar Listeler Örnek ekranlar Kullanıcının girmesi gereken metinler Uyarılar
Doküman yazımının sonlandırılması Doküman hazırlamada kullanılan araçlar Kelime işlemciler Yazım kontrolcüleri Gramer kontrolcüleri Sözlük Masaüstü yayıncılık programları Çizim programları
Doküman yazımının sonlandırılması Gözden geçirme, yeniden yazma ve güncelleme Yazım hatalarının belirlenmesi Cümle yapılarının kontrolü Güncelleme için planlama
Kaynaklar Price, R.V. (1990). Computer-aided Instruction: A guide for authors. Pasific Grove, CA: Brooks/Cole Publishing Company. Resimler http://www.auntie.com/clipart/corners01.asp http://www.allfree-clipart.com/ http://192.220.90.74/ http://www.1clipart.com/ Right Words New Zealand Limited http://www.rightwords.co.nz/process.html