DÖKÜMANTASYON HELP USER INTERFACE DOCUMENTATION Belgeleme, bir çalışma için gerekli belgeleri arama ve sağlama, belgelere dayandırma Dökümantasyon sürecini 4 kısımda inceleyebiliriz ALİCEM GÜRBOSTAN 2008638004 ARAYÜZ NEDİR Kullanıcı arayüzü, veya kullanıcı arabirimi (İnsan Makine Arayüzü) insanların bir makine, cihaz, bilgisayar programı ya da karmaşık aletlerle etkileşimini sağlayan yöntemlerin bileşkesine verilen addır. DÖKÜMANTASYON Kullanıcıya programın içeriği ve kullanımı konusunda yardımcı olmak Kullanıcıyı yönlendirmek Kullanıcı ile program yapımcısı arasındaki iletişimi sağlamak Yazılımcılara örnek oluşturma Kullanıcı arayüzünde yer alan yapılacak işe özel hazırlanmış kelime ve sembollerle Arayüzde yer alan kelime ve semboller Yardım menüsü Web sitesi Kullanım kılavuzu 1
Arayüzde bulunan yardım menüsü sayesinde YARDIM MENÜSÜNDE BULUNMASI GEREKENLER Kullanılan program hakkında genel bilgiler SİSTEM GEREKSİNİMLERİ DETAYLI AÇIKLAMA ARAYÜZDEKİ KELİMELERİN PROGRAM İÇİNDE İFADE ETTİKLERİ ANLAM İLETİŞİM BİLGİLERİ 2
SÖZLÜK PROGRAM SORUMLUSUNUN SİTESİNDE Kullanıcı arayüzünü hazırlayan firmanın veya kişinin web sitesine erişerek gerekli yardımı alabilir WEB SİTESİNDE ARANAN KRİTERLER Kullanıcıya aradığı bilgiye ulaşması için seçenekler sunmalı Kullanılan arayüz anlaşılabilir olmalı Dil seçenekleri sunabilmeli Online destek sunabilmeli Görsel destek verebilmeli KULLANIM KILAVUZU Kılavuzu ; bir ürün veya sistemin kullanımıyla ilgili açıklamaların olduğu dokümantasyon olarak tanımlayabiliriz. KILAVUZ NASIL HAZIRLANIR Hedef kitlesi seçilmeli Dil kurallarına uygun ve anlaşılabilir olmalı İçindekiler bölümü İndeks kısmı 3
HEDEF KİTLESİ Kılavuza başlamadan yapılması gereken en önemli iştir Hedef kitlenin özellikleri bilinmeli DİL KURALLARI Redaksiyon; yazılmış bir metin üzerinde gereken düzeltmeleri yaparak yazıyı yayıma hazır duruma getirmedir. Kullanım kılavuzu metinleri için önemli bir unsur olan redaksiyon, uzmanlık gerektiren bir iştir iştir. Yazılan metinlerin yine son kullanıcı Kullanıcı tipleri belirlenmeli profilini de göz önünde bulundurularak cümlelerdeki anlam bütünlüğünün sağlanması, imlâ kurallarının doğru uygulanması, noktalama işaretlerinin kullanımı ve yazım biçimlerinin yasal düzenlemelere uygun biçimde düzenlenmesi işlemidir. ANLAŞILABİLİRLİK İÇİNDEKİLER Kılavuzda yazılan metinler için anlaşılabilirlik ön planda olmalıdır. Kılavuzda kullanılan dil mümkün olduğu kadar sade olmalıdır. Uzun cümlelerden kaçınılmalıdır. Kılavuzdaki teknik terim kullanım seviyesi kullanıcının İçindekiler bölümü, kullanım kılavuzunu okuyan kişinin ilgilendiği bölümü zaman kaybetmeden kolayca bulmasını sağlamalıdır. İçindekiler bölümü oluşturulurken ana amaç kullanıcıyı doğru bir şşekilde yönlendirmek y y ve kılavuzu zaman kaybetmeden etkin bir şekilde kullanmasını sağlamaktır. Bununla birlikte kullanım kılavuzunda anlatılan konular hakkında da kullanıcıya bir ön fikir bilgi düzeyine göre belirlenmelidir. Son kullanıcının verilmiş olur. anlamayacağı teknik terimler kullanılmamalıdır. Kullanılan cümleler anlaşılabilir olmalıdır ve kullanıcının herhangi bir yorum yapmasına gerek vermemelidir. İÇİNDEKİLER İçindekiler bölümü, ana bölüm başlıkları ve bunların alt başlıklarından ve sayfa numaralarından oluşur. İçindekiler bölümü genel olarak kullanım kılavuzlarının başında kkullanılır. ll l B Bazı d dokümanlarda kü l d ise, i şayett anlatım l t bölü bölüm bölüm bölü yapıldıysa, dokümanın başında içindekiler verildiği gibi bölüm başlarında da o bölümle ilgili içindekiler bölümü ekstradan verilebilir. İNDEKS İndeks, kılavuzun spesifik konu, özel isim, parça ismi vb. bakımından içindekileri yer numarasıyla belirtilen ve dokümanın arka sayfasında yer alan alfabetik listedir. İndeks bölümü sayfa sayısı 20 den fazla olan dokümanlar için hazırlanır. hazırlanır İndeks bölümü kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder, bu yüzden bu bölümdeki kelimeler, kullanıcının arama oranının fazla olabileceği kelimelerden seçilmelidir. 4
KILAVUZDAKİ BÖLÜMLER Kapak sayfası İçindekiler Genel bilgiler Ürün/sistemin kullanımı Bakım Sık sorulan sorular http://inndustry.blogcu.com/kullanim-kilavuzu-nasil-hazirlanir/10845626 http://www.nero.com/eng/support.html http://www.ihop.org.tr/dosya/huridocs/dokumantasyonnedir.pdf t /d /h id /d t di df http://www.msxlabs.org/forum/x-sozluk/308676-kullanici-arayuzu- kullanici-arayuzu-nedir-kullanici-arayuzu-hakkinda.html indeks 5