Kullanıcı Dokümantasyonu Nedir?

Kullanıcı dokümantasyonu, bir ürünü kullanan kişiye destek ekibiyle iletişime geçmeden bir görevi tamamlama yolunu gösteren, yayınlanmış talimatlar bütünüdür.

Ekipler buna son kullanıcı dokümantasyonu, kullanım kılavuzu, kullanıcı el kitabı veya kullanıcı rehberi de der ve kullanıcı dokümantasyonu tanımı bu beş adın tümünde geçerlidir. Kullanıcı dokümantasyonunun anlamı okuyucuya göre şekillenir: ürünü geliştiren değil, ürünü kullanan kişi. Web makaleleri, arayüze gömülü yardım içeriği veya bir PDF olarak yayınlanır.

Kullanıcı Dokümantasyonu Nasıl Çalışır

Bir İçeriği Kullanıcı Dokümantasyonu Yapan Nedir

• Görsellerle eşleştirilmiş, her adımda bir görsel: Her adım, adlandırdığı kontrolün ekran görüntüsünü taşır ve önündeki ekranla eşleştirebilmen için işaretlenmiştir.
• Sade dille yazılmış: Günlük kelimeler, kısaltmalar ilk kullanımda açık yazılır; TechSmith bu kuralı tüm okuyucuları sıradan kişiler olarak ele almak şeklinde ifade eder.
• Ürün sürümlerine göre güncel tutulur: Makalenin gösterdiği bir ekranı değiştiren her yayınlanan sürüm, revizyonu zorunlu kılar.
• Ürünü kullanan kişiye hitap eder: Arka planda ne çalıştığını bilmene gerek kalmadan görevleri arayüz üzerinden tamamlarsın.
• Okuyucunun tamamlamaya çalıştığı görevlere göre organize edilir: Başlıklar bir eylemi adlandırır; böylece "Panoya bir ekip arkadaşı ekleme" başlığı, "Kişiler" adlı bir sayfanın yerini alır.
• Bulunabilir: Arama, bir içindekiler tablosu ve makale başına bir URL, böylece seni yanıtlayan tek sayfaya ulaşırsın.

Kullanıcı Dokümantasyonu Neden Önemli

Destek dokümantasyonunun yanıtladığı bir soru, nadiren kuyruğa ulaşır. Eksik adımı bulan okuyucu orada durur, hiçbir destek talebi açmaz ve destek ekibini bunu yanıtlama maliyetinden kurtarır. Referans sayfası yazarları bu faydayı diğer her şeyden daha tutarlı biçimde öne sürer.

İkinci sonuç, işe alım sürecidir. Yayınlanmış bir görevi takip edebilen yeni bir kullanıcı, planlanmış bir eğitim oturumu olmadan ilk başarılı sonucuna ulaşır ve o oturumu yürütecek olan meslektaş, o saati kazanır. Aynı hesap, dahili bir araca alışan bir çalışan için de geçerlidir.

Üçüncü sonuç ise elde tutmadır. Görevi tamamlayan müşteri kalır, yarı yolda vazgeçen ise ayrılır. Bazı ürünlerde talimatlarının kalitesi, insanların yazılımı hiç benimseyip benimsemeyeceğine karar verir; bir referans sayfasının yazarlarının dokümantasyonu bir takip değil, yayın koşulu olarak ele almasının nedeni de budur.

Kullanıcı Dokümantasyonu Türleri

Hangisini yazacağına karar veren sütun, en sondaki sütundur.

Kullanıcı Dokümantasyonu vs Teknik Dokümantasyon vs SOP vs Bilgi Bankası

Okuyucun terimi belirler: üründe bir şeyi tamamlayan bir müşteri kullanıcı dokümantasyonu demektir, bir mühendis teknik dokümantasyon demektir, şirket prosedürünü takip eden bir çalışan ise SOP demektir. Bilgi bankası ile kullanıcı dokümantasyonu arasındaki fark bir seviye ayrımıdır: birincisini satın alırsın, ikincisini yazarsın.

Kullanıcı Dokümantasyonu Nasıl Oluşturulur

Beş yayınlanmış prosedür tek bir sırada birleşir. Kullanıcı dokümantasyonu nasıl yazılır, kullanım kılavuzu nasıl hazırlanır ya da kullanıcı el kitabı nasıl oluşturulur diye sor: bu adımlar üçünü de kapsar.

1. Hedef kitleyi ve tek görevi adlandır. Kimin okuduğuna ve tamamlamaya çalıştığı tek işe karar ver. Makalenin kapsamı o iştir, altındaki özellik değil.
2. Yazmadan önce süreci haritalandır. Görevi üründe adım adım yürüt ve neler olduğunu kaydet, arayüzün tuhaf davrandığı yerler dahil.
3. Makaleyi eylemle başlıklandır. "Bir ekip arkadaşının şifresini sıfırlama", ne yapmak istediğini yazan bir okuyucuya döner; "Şifreler" adlı bir sayfa dönmez.
4. Her adımı tek bir eyleme indir. "ve" ile birleştirilmiş herhangi bir adım aslında ikidir. Ön koşulları ve uyarıları uygulandıkları adımın üstüne koy, çünkü altına basılan bir uyarı okuyucu harekete geçtikten sonra ulaşır.
5. Adım başına bir görsel yakala. Anlatılan kontrolü işaretle ve sonucu gösteren bir görselle bitir, böylece okuyucu kendi ekranını buna göre kontrol edebilir.
6. Taslağı bu görevi daha önce yapmamış bir meslektaşa ver. Sorduğu her adımı yeniden yaz. Taslağın, okuyucunun sahip olmadığı bilgiyi varsayar ve bunu ancak soğuk bir deneme gösterir.
7. Bir sahip ve bir bakım tetikleyicisi adlandır. Belgeye bir kişi ata ve revizyonu zorunlu kılan olayı belirt: makalenin gösterdiği bir ekranı değiştiren bir sürüm. Bu makalenin dayandığı on referans sayfasından dokuzu ikisini de adlandırmıyor.

Kullanıcı Dokümantasyonu En İyi Uygulamaları

Aşağıdaki kullanıcı dokümantasyonu en iyi uygulamalarının her biri, bir kuralı önlediği hatayla eşleştirir.

• Yap: Adım başına tek eylem yaz, "ve" ile birleştirilmiş her şeyi ikiye ayır.

Yapma: İş başında bir istasyonda duran okuyucunun içinden çıkamayacağı yoğun bir metin duvarı yayınlama.

• Yap: Makaleleri okuyucunun yapmak istediği eyleme göre başlıklandır.

Yapma: Rehberleri, makale başına URL'si olmayan düz bir hiyerarşi altında konu isimleriyle dosyalama; bu da onları aramadan erişilemez kılar.

• Yap: Aktif çatı ve kısa cümleler kullan, sonucu sayısallaştırmak için bir okunabilirlik skoru ekle.

Yapma: Özelliği geliştiren kişinin seviyesinde yazma; bu, başlangıç seviyesindeki okuyucunun sahip olmadığı bilgiyi varsayar.

• Yap: Terminolojiyi ve biçimlendirmeyi set boyunca tek bir stil kılavuzuna veya şablona bağla.

Yapma: Her yazarın aynı düğmeyi üç farklı şekilde adlandırmasına izin verme; bu, aramanın kaçırmasına ve okuyucuların doğru sayfada olduklarından şüphe duymasına yol açar.

• Yap: Taslağı görevi bilmeyen birine ver ve sorduğu her şeyi düzelt.

Yapma: Yalnızca yazarın hiç çalıştırdığı adımları yayınlama.

Yaygın Kullanıcı Dokümantasyonu Hataları

• İçeriğin bir sürümden sonra bayatlamasına izin vermek. Ekran görüntüsü yeri değişmiş bir düğmeyi gösterir, okuyucu artık var olmayan bir adımı takip eder ve makalenin önlemesi gereken destek talebi yine de açılır. manual.to, statik PDF'lerin aylar içinde güncelliğini yitirdiğini bildiriyor.
• Uzman için yazmak. Başlangıç seviyesindeki okuyucunun sahip olmadığı bilgiyi varsayarsın; oysa belge tam olarak o okuyucu için var olur, bu yüzden okuyucu destek ekibine gider.
• Yoğun metin duvarları yayınlamak. İş başındaki biri, bir istasyonda okumayı yarı yolda bırakır; makale tam yardımcı olması gereken anda kullanılmadan kalır.
• Okuyucuların bulamadığı dokümantasyon yayınlamak. Zayıf arama, düz bir hiyerarşi ve makale başına URL yokluğu; setin yazım maliyetini tam olarak ödersin ama talep tasarrufunun hiçbirini toplamazsın.

Kullanıcı Dokümantasyonu Örneği

Kullanıcı dokümantasyonu örnekleri için sıralamada çıkan sayfalar, başka şirketlerin yardım merkezlerinden galerilerdir. Aşağıdaki doldurulmuş örneği bir kullanıcı dokümantasyonu şablonu olarak al; son kullanıcı dokümantasyonu örneklerinin atladığı iki alanı taşır: bir sahip ve bir gözden geçirme tetikleyicisi.

• Başlık: Paylaşılan bir panoya ekip arkadaşı ekleme
• Kimin için: Zaten oluşturulmuş bir panosu ve plandan boş bir koltuğu olan çalışma alanı yöneticisi.
• Başlamadan önce: Ekip arkadaşının iş e-postasını hazır tut. Kişisel bir adrese gönderilen davetler alan adı kontrolünden geçemez.
• Adım 1. Panoyu aç ve sağ üstteki Paylaş'a tıkla. Ekran görüntüsü: Paylaş'ın işaretlendiği pano başlığı. Üyeler bu düğmeyi gri görür, bu yüzden bu adımı bir yöneticiden yapmasını iste.
• Adım 2. Ekip arkadaşının iş e-postasını davet alanına yaz.
• Adım 3. Alanın yanındaki rol açılır menüsünden Düzenleyen veya Görüntüleyen'i seç. Ekran görüntüsü: açık açılır menü.
• Adım 4. Davet Gönder'e tıkla. Ekran görüntüsü: "Davet gönderildi" onayı.
• Sonuç: Ekip arkadaşı, kabul edene kadar üye listesinde Beklemede olarak görünür, sonra seçtiğin rolle Üyeler'e geçer.
• Sorun giderme: On dakika sonra e-posta gelmediyse, spam klasörünü kontrol etmesini ve üye listesinden yeniden göndermeni iste. "Koltuk limitine ulaşıldı" durumunda, devre dışı bırakılmış bir üyeyi kaldır veya Faturalama'dan koltuk ekle.
• İlgili: Bir ekip arkadaşının rolünü değiştirme. Bir panodan birini kaldırma.
• URL: /help/boards/add-a-teammate-to-a-shared-board
• Sahip: Destek lideri. Son gözden geçirme: Ağustos 2026. Gözden geçirme tetikleyicisi: Paylaş iletişim kutusunu değiştiren herhangi bir sürüm.

Gerçek Kullanıcı Dokümantasyonunu Gör

Hinto'nun kendi bilgi bankası bu terimin canlı bir örneğidir ve aşağıdaki makale, bir video klibi sekiz numaralı adımda kırpmayı, her adımda adlandırdığı kontrolü göstererek kapsar.

Kayıttan Kullanıcı Dokümantasyonuna Tek Adımda

Bu örneği boş bir sayfadan üretmek çoğu ekibin takıldığı yerdir; kullanıcı dokümantasyonu araçlarının artık bir belge yerine bir kayıttan başlamasının nedeni de budur. Görevi bir kez kaydet veya elindeki bir videoyu getir: Hinto AI, Loom, Zoom, YouTube ile yerel MP4, MOV veya WebM dosyalarını kabul eder ve tarayıcıdan ya da Chrome uzantısından ekranı, kamerayı ve mikrofonu kaydeder.

Eylem tespiti, arayüz durum değişikliklerini ve düğme tıklamalarını tanır, bunlardan ekran görüntüleri ve yazılı adımlar çıkarır, ardından tek bir kaydı çoklu organize makaleden oluşan bir içindekiler tablosuna dönüştürür: son kullanıcı dokümantasyonu için bir yardım merkezi veya bir ürün demosundan üretilen sürüm notları. Bir bölüm yanlış çıktığında, o bölümü işaretle ve yalnızca o blok için yeniden yazım veya yeni görseller iste, ardından hassas olan her şeyi kırp, çerçevele, odakla veya bulanıklaştır. Sonucu kendi özel alan adındaki genel bir URL'ye yayınlarsın ve sistem, çoğu kullanıcı el kitabı yazılımının yaptığı gibi koltuk başına ücretlendirme yerine üretimleri aylık bir kredi tahsisi olarak ölçer.

Kullanıcı Dokümantasyonu SSS

Kullanıcı dokümantasyonunu kim yazar?

Okuyucunun sorularına en yakın oturan kişi: destek, bir ürün sahibi veya bunu tam zamanlı yapan bir teknik yazar. Sayfayı güncel tutmak, kalemi kimin tuttuğundan daha önemlidir; bu makalenin dayandığı on referans sayfasından dokuzu, ilk yayından sonra belge için bir sahip adlandırmaz.

Bir kullanım kılavuzu neleri içermeli?

Wikipedia'nın standart içeriği güvenlik, montaj, kurulum, çalıştırma, bakım, sorun giderme, teknik özellikler ve garantiyi kapsar. Yazılım kılavuzları fiziksel bölümleri çıkarır, geri kalanını korur ve bir başlangıç yolu ile görev başına bir makale ekler. Okuyucuların ürünle hâlâ örtüşüp örtüşmediğini değerlendirebilmesi için bir sahip ve son gözden geçirme tarihini belgenin içine koy.

Kullanıcı rehberi ile kullanıcı el kitabı arasındaki fark nedir?

Her iki ad da tek bir şeye işaret eder. Kullanıcı el kitabı, kullanıcı rehberi, sahip kılavuzu veya kullanım kılavuzu, birinin belirli bir ürünü, hizmeti veya uygulamayı kullanmasına yardımcı olan materyaldir. Bunları gerçekten ayıran ekipler, kısa görev odaklı makale için rehber, tam referans için el kitabı terimini kullanır.

İyi bir kullanıcı rehberini ne oluşturur?

Referans set üç konuda hemfikirdir: adımın anlattığı kontrolü gösteren adım başına bir açıklamalı görsel, açıklanmamış jargon içermeyen sade dil ve ürünün sunduğu özellikler yerine okuyucunun tamamlamak istediği görevler etrafında kurulmuş bir organizasyon. Bu üçünden herhangi birinde başarısız olan bir sayfa, okuyucuları desteğe gönderir.

Yazılım testinde kullanıcı dokümantasyonu testi nedir?

Yazılı adımları canlı üründe ilk kez yapan biriyle birlikte adım adım yürütür, sonra sorduğu her adımı düzeltirsin. TechSmith bunlara acemi kullanıcılar der, manual.to ise hiç yapmamış kullanıcılar der. Bu alıştırma, varsayılan bilgiyi ve yakın zamandaki bir sürümün sessizce bozduğu adımları yakalar.

İlgili Terimler

Standart Operasyon Prosedürü, Bilgi Bankası, Süreç Dokümantasyonu