5
01.12.2011 1 HELP USER INTERFACE HELP USER INTERFACE DOCUMENTATION DOCUMENTATION ALİCEM GÜRBOSTAN ALİCEM GÜRBOSTAN 2008638004 2008638004 DÖKÜMANTASYON DÖKÜMANTASYON Belgeleme, bir çalışma için gerekli belgeleri arama ve sağlama, Belgeleme, bir çalışma için gerekli belgeleri arama ve sağlama, belgelere dayandırma belgelere dayandırma Dökümantasyon sürecini 4 kısımda inceleyebiliriz Dökümantasyon sürecini 4 kısımda inceleyebiliriz ARAYÜZ ARAYÜZ NEDİR NEDİR Kullanıcı arayüzü, veya kullanıcı arabirimi (İnsan Makine Arayüzü) Kullanıcı arayüzü, veya kullanıcı arabirimi (İnsan Makine Arayüzü) insanların bir makine, cihaz, bilgisayar programı ya da karmaşık insanların bir makine, cihaz, bilgisayar programı ya da karmaşık aletlerle etkileşimini sağlayan yöntemlerin bileşkesine verilen addır. aletlerle etkileşimini sağlayan yöntemlerin bileşkesine verilen addır. DÖKÜMANTASYON DÖKÜMANTASYON Kullanıcıya programın içeriği ve kullanımı konusunda yardımcı olmak Kullanıcıya programın içeriği ve kullanımı konusunda yardımcı olmak Kullanıcıyı yönlendirmek Kullanıcıyı yönlendirmek Kullanıcı ile program yapımcısı arasındaki iletişimi sağlamak Kullanıcı ile program yapımcısı arasındaki iletişimi sağlamak Yazılımcılara örnek oluşturma Yazılımcılara örnek oluşturma BİLGİLENDİRME NASIL YAPILIR BİLGİLENDİRME NASIL YAPILIR Arayüzde yer alan kelime ve semboller Arayüzde yer alan kelime ve semboller Yardım menüsü Yardım menüsü Yardım menüsü Yardım menüsü Web sitesi Web sitesi Kullanım kılavuzu Kullanım kılavuzu BİLGİLENDİRME NASIL YAPILIR BİLGİLENDİRME NASIL YAPILIR Kullanıcı arayüzünde yer alan yapılacak işe özel hazırlanmış kelime Kullanıcı arayüzünde yer alan yapılacak işe özel hazırlanmış kelime ve sembollerle ve sembollerle

HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

Embed Size (px)

Citation preview

Page 1: HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

01.12.2011

1

HELP USER INTERFACE HELP USER INTERFACE DOCUMENTATIONDOCUMENTATION

ALİCEM GÜRBOSTANALİCEM GÜRBOSTAN20086380042008638004

DÖKÜMANTASYONDÖKÜMANTASYON

Belgeleme, bir çalışma için gerekli belgeleri arama ve sağlama, Belgeleme, bir çalışma için gerekli belgeleri arama ve sağlama, belgelere dayandırma belgelere dayandırma Dökümantasyon sürecini 4 kısımda inceleyebilirizDökümantasyon sürecini 4 kısımda inceleyebiliriz

ARAYÜZARAYÜZ NEDİRNEDİRKullanıcı arayüzü, veya kullanıcı arabirimi (İnsan Makine Arayüzü) Kullanıcı arayüzü, veya kullanıcı arabirimi (İnsan Makine Arayüzü) insanların bir makine, cihaz, bilgisayar programı ya da karmaşık insanların bir makine, cihaz, bilgisayar programı ya da karmaşık aletlerle etkileşimini sağlayan yöntemlerin bileşkesine verilen addır.aletlerle etkileşimini sağlayan yöntemlerin bileşkesine verilen addır.

DÖKÜMANTASYONDÖKÜMANTASYON

Kullanıcıya programın içeriği ve kullanımı konusunda yardımcı olmakKullanıcıya programın içeriği ve kullanımı konusunda yardımcı olmak

Kullanıcıyı yönlendirmekKullanıcıyı yönlendirmek

Kullanıcı ile program yapımcısı arasındaki iletişimi sağlamakKullanıcı ile program yapımcısı arasındaki iletişimi sağlamak

Yazılımcılara örnek oluşturmaYazılımcılara örnek oluşturma

BİLGİLENDİRME NASIL YAPILIRBİLGİLENDİRME NASIL YAPILIR

Arayüzde yer alan kelime ve semboller Arayüzde yer alan kelime ve semboller

Yardım menüsüYardım menüsüYardım menüsüYardım menüsü

Web sitesiWeb sitesi

Kullanım kılavuzuKullanım kılavuzu

BİLGİLENDİRME NASIL YAPILIRBİLGİLENDİRME NASIL YAPILIRKullanıcı arayüzünde yer alan yapılacak işe özel hazırlanmış kelime Kullanıcı arayüzünde yer alan yapılacak işe özel hazırlanmış kelime ve sembollerleve sembollerle

Page 2: HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

01.12.2011

2

BİLGİLENDİRMEBİLGİLENDİRME NASIL YAPILIRNASIL YAPILIR

Arayüzde bulunan yardım menüsü sayesindeArayüzde bulunan yardım menüsü sayesinde

YARDIM MENÜSÜNDE BULUNMASI YARDIM MENÜSÜNDE BULUNMASI GEREKENLERGEREKENLER

Kullanılan program hakkında genel bilgilerKullanılan program hakkında genel bilgiler

SİSTEM GEREKSİNİMLERİSİSTEM GEREKSİNİMLERİ DETAYLI AÇIKLAMADETAYLI AÇIKLAMA

ARAYÜZDEKİ KELİMELERİN ARAYÜZDEKİ KELİMELERİN PROGRAM İÇİNDE İFADE PROGRAM İÇİNDE İFADE

ETTİKLERİ ANLAMETTİKLERİ ANLAMİLETİŞİM BİLGİLERİİLETİŞİM BİLGİLERİ

Page 3: HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

01.12.2011

3

SÖZLÜKSÖZLÜK PROGRAM SORUMLUSUNUN PROGRAM SORUMLUSUNUN SİTESİNDESİTESİNDE

Kullanıcı arayüzünü hazırlayan firmanın veya kişinin web sitesine Kullanıcı arayüzünü hazırlayan firmanın veya kişinin web sitesine erişerek gerekli yardımı alabilirerişerek gerekli yardımı alabilir

WEB SİTESİNDE ARANAN KRİTERLERWEB SİTESİNDE ARANAN KRİTERLER

Kullanıcıya aradığı bilgiye ulaşması için seçenekler sunmalıKullanıcıya aradığı bilgiye ulaşması için seçenekler sunmalı

Kullanılan arayüz anlaşılabilir olmalıKullanılan arayüz anlaşılabilir olmalı

Dil seçenekleri sunabilmeliDil seçenekleri sunabilmeliDil seçenekleri sunabilmeliDil seçenekleri sunabilmeli

Online destek sunabilmeliOnline destek sunabilmeli

Görsel destek verebilmeliGörsel destek verebilmeli

KULLANIM KILAVUZUKULLANIM KILAVUZU

Kılavuzu ; bir ürün veya sistemin kullanımıyla ilgili açıklamaların olduğu dokümantasyon olarak tanımlayabiliriz.

KILAVUZ NASIL HAZIRLANIRKILAVUZ NASIL HAZIRLANIR

Hedef kitlesi seçilmeliHedef kitlesi seçilmeli

Dil kurallarına uygun ve anlaşılabilir olmalıDil kurallarına uygun ve anlaşılabilir olmalı

İçindekiler bölümüİçindekiler bölümü

İndeks kısmıİndeks kısmı

Page 4: HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

01.12.2011

4

HEDEF KİTLESİHEDEF KİTLESİ

Kılavuza başlamadan yapılması gereken en önemli iştirKılavuza başlamadan yapılması gereken en önemli iştir

Hedef kitlenin özellikleri bilinmeliHedef kitlenin özellikleri bilinmeli

Kullanıcı tipleri belirlenmeliKullanıcı tipleri belirlenmeli

DİL KURALLARIDİL KURALLARIRedaksiyon; yazılmış bir metin üzerinde gereken düzeltmeleriRedaksiyon; yazılmış bir metin üzerinde gereken düzeltmeleriyaparak yazıyı yayıma hazır duruma getirmedir. yaparak yazıyı yayıma hazır duruma getirmedir.

Kullanım kılavuzu metinleri için önemli bir unsur olan redaksiyon, Kullanım kılavuzu metinleri için önemli bir unsur olan redaksiyon,

uzmanlık gerektiren bir iştir Yazılan metinlerin yine son kullanıcıuzmanlık gerektiren bir iştir Yazılan metinlerin yine son kullanıcıuzmanlık gerektiren bir iştir. Yazılan metinlerin yine son kullanıcıuzmanlık gerektiren bir iştir. Yazılan metinlerin yine son kullanıcı

profilini de göz önünde bulundurularak cümlelerdeki anlam profilini de göz önünde bulundurularak cümlelerdeki anlam

bütünlüğünün sağlanması, imlâ kurallarının doğru uygulanması, 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 noktalama işaretlerinin kullanımı ve yazım biçimlerinin yasal

düzenlemelere uygun biçimde düzenlenmesi işlemidir.düzenlemelere uygun biçimde düzenlenmesi işlemidir.

ANLAŞILABİLİRLİKANLAŞILABİLİRLİKKılavuzda yazılan metinler için anlaşılabilirlik ön planda olmalıdır. 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. UzunKılavuzda kullanılan dil mümkün olduğu kadar sade olmalıdır. Uzun

cümlelerden kaçınılmalıdır. cümlelerden kaçınılmalıdır.

Kılavuzdaki teknik terim kullanım seviyesi kullanıcının Kılavuzdaki teknik terim kullanım seviyesi kullanıcının

bilgi düzeyine göre belirlenmelidir. Son kullanıcının bilgi düzeyine göre belirlenmelidir. Son kullanıcının

anlamayacağı teknik terimler kullanılmamalıdır. anlamayacağı teknik terimler kullanılmamalıdır.

Kullanılan cümleler anlaşılabilir olmalıdır ve kullanıcınınKullanılan cümleler anlaşılabilir olmalıdır ve kullanıcının

herhangi bir yorum yapmasına gerek vermemelidir.herhangi bir yorum yapmasına gerek vermemelidir.

İÇİNDEKİLERİÇİNDEKİLER

İçindekiler bölümü, kullanım kılavuzunu okuyan kişinin ilgilendiği İç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. 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İçindekiler bölümü oluşturulurken ana amaç kullanıcıyı doğru birşekilde yönlendirmek ve kılavuzu zaman kaybetmeden etkin bir şekilde yönlendirmek ve kılavuzu zaman kaybetmeden etkin bir ş y yş y yşekilde kullanmasını sağlamaktır. Bununla birlikte kullanımşekilde kullanmasını sağlamaktır. Bununla birlikte kullanımkılavuzunda anlatılan konular hakkında da kullanıcıya bir ön fikir kılavuzunda anlatılan konular hakkında da kullanıcıya bir ön fikir

verilmiş olur.verilmiş olur.

İÇİNDEKİLERİÇİNDEKİLER

İçindekiler bölümü, ana bölüm başlıkları ve bunların alt İç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. başlıklarından ve sayfa numaralarından oluşur. İçindekiler bölümü genel olarak kullanım kılavuzlarının başında İçindekiler bölümü genel olarak kullanım kılavuzlarının başında k ll l B d kü l d i t l t bölü bölük ll l B d kü l d i t l t bölü bölükullanılır. Bazı dokümanlarda ise, şayet anlatım bölüm bölüm kullanılır. Bazı dokümanlarda ise, şayet anlatım bölüm bölüm yapıldıysa, dokümanın başında içindekiler verildiği gibi bölüm 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.başlarında da o bölümle ilgili içindekiler bölümü ekstradan verilebilir.

İNDEKSİNDEKS

İndeks, kılavuzun spesifik konu, özel isim, parça ismi vb. İndeks, kılavuzun spesifik konu, özel isim, parça ismi vb.

bakımından içindekileri yer numarasıyla belirtilen ve dokümanın bakımından içindekileri yer numarasıyla belirtilen ve dokümanın arka sayfasında yer alan alfabetik listedir. İndeks bölümü sayfaarka sayfasında yer alan alfabetik listedir. İndeks bölümü sayfasayısı 20’den fazla olan dokümanlar için hazırlanır İndeks bölümüsayısı 20’den fazla olan dokümanlar için hazırlanır İndeks bölümüsayısı 20’den fazla olan dokümanlar için hazırlanır. İndeks bölümü sayısı 20’den fazla olan dokümanlar için hazırlanır. İndeks bölümü kullanıcının doküman içerisinde geçen spesifik kelimeleri kolaycakullanıcının doküman içerisinde geçen spesifik kelimeleri kolaycabulmasına yardım eder, bu yüzden bu bölümdeki kelimeler, 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 kullanıcının arama oranının fazla olabileceği kelimelerden

seçilmelidir.seçilmelidir.

Page 5: HELP USER İNTERFACE DOCUMENTATİON [Uyumluluk · PDF fileKILAVUZ NASIL HAZIRLANIR ... kullanıcının doküman içerisinde geçen spesifik kelimeleri kolayca bulmasına yardım eder,

01.12.2011

5

KILAVUZDAKİ BÖLÜMLER KILAVUZDAKİ BÖLÜMLER Kapak sayfasıKapak sayfası

İçindekilerİçindekiler

Genel bilgilerGenel bilgiler

Ürün/sistemin kullanımıÜrün/sistemin kullanımı

BakımBakım

Sık sorulan sorularSık sorulan sorular

indeksindeks

http://inndustry.blogcu.com/kullanimhttp://inndustry.blogcu.com/kullanim--kilavuzukilavuzu--nasilnasil--hazirlanir/10845626hazirlanir/10845626

http://www.nero.com/eng/support.htmlhttp://www.nero.com/eng/support.html

htt // ih t /d /h id /d k t di dfhtt // ih t /d /h id /d k t di dfhttp://www.ihop.org.tr/dosya/huridocs/dokumantasyonnedir.pdfhttp://www.ihop.org.tr/dosya/huridocs/dokumantasyonnedir.pdf

http://www.msxlabs.org/forum/xhttp://www.msxlabs.org/forum/x--sozluk/308676sozluk/308676--kullanicikullanici--arayuzuarayuzu--kullanicikullanici--arayuzuarayuzu--nedirnedir--kullanicikullanici--arayuzuarayuzu--hakkinda.htmlhakkinda.html