BDE İÇİN ETKİLİ DOKÜMANTASYON OLUŞTURMA

... konulu sunumlar: "BDE İÇİN ETKİLİ DOKÜMANTASYON OLUŞTURMA"— Sunum transkripti:

1 BDE İÇİN ETKİLİ DOKÜMANTASYON OLUŞTURMA
                                                                      

2 SÜREÇ

3 Dokümantasyon Planlama ve Organizasyon

4 Yazılım Dokümantasyonu
Bilgilendirici kullanıcı seviyesinde Açık Anlaşılır

5 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

6 Yetersiz dokümantasyona neden olan etkenler
Zaman kısıtı Hedef kitlenin iyi tanımlanmaması Yetersiz tasarım

7 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                                                                                        

8 Doküman Türleri Öğretmen El Kitabı Öğrenci El Kitabı
Teknik Bilgiler El Kitabı

9 Öğ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ı                                                                                  

10 Öğretmen El Kitabı Donanım Bilgisi
Bilgisayar yazılımı Yardımcı donanımlar Başlamak için yapılması gerekenler

11 Öğ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

12 Öğ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ı                                                                                                                               

13 Öğrenci El Kitabı Donanım Bilgisi
Bilgisayar sistem gereksinimleri Başlama yöntemleri Sistem hataları Giriş & rapor oluşturma yöntemleri

14 Öğrenci El Kitabı Yazılım Bilgisi
                                           Program gereksinimleri Uygunluk Hata mesajları Gerekli yöntemler Özellikler & komutlar Performans özeti

15 Teknik Bilgiler El Kitabı Pedagojik Bilgi
                                                                                 Yorumlar Dönüt Programın gözlenmesi ve not alınması

16 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

17 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ı

18 Dokümanın Organizasyonu
Öğrenci ve öğretmen el kitabı için ayrı bölümler

19 Eklerin yazılması Hata mesajları Sözlükler Indeks Örnekler

20 Dokümanın Diğer Bileşenleri
Kapak İçindekiler Örnek, tablo ve grafiklerin listesi

21 Yazım stili ve doküman yazımının sonlandırılması

22 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

23 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

24 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

25 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

26 Büyük harflerin doğru ve tutarlı kulanımı
“ENTER” “enter komutu” “Enter Komutu”

27 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

28 Teknik terimlerin (jargon) azaltılması
Bit, bayt, dosyalar, kayıtlar, data, veri, varsayılan, ana doküman vb.

29 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

30 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.                                                                                 

31 Birazda eğlence ... Programcı spesifik olarak öğretmediği sürece bilgisayar değişik şekillerde davranacak kadar zeki değildir

32 Grafikler ve Şekiller Yöntemsel akış şemaları
Çizimler ve çizgi resimler Fotoğraflar

33 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?

34 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

35 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ı

36 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

37 Kaynaklar Price, R.V. (1990). Computer-aided Instruction: A guide for authors. Pasific Grove, CA: Brooks/Cole Publishing Company. Resimler Right Words New Zealand Limited