Harika Kullanıcı Belgeleri için 9 İpucu (Örneklerle)

Kullanıcı belgeleri, müşterinize teslim edilen genel ürünün önemli bir parçasıdır. Son kullanıcıların ürününüz veya hizmetinizle daha başarılı olmasına yardımcı olur.

Geçmişte, kullanıcı belgeleri, kullanıcının makinesinde yerel olan bir yardım dosyası veya fiziksel bir el kitabı veya kitapçık aracılığıyla verilirdi. Bu, kolayca güncellenemeyeceği veya değiştirilemeyeceği ve yazılım sağlayıcıların içeriklerinin nasıl kullanıldığı hakkında çok az veriye sahip olduğu anlamına geliyordu.

Günümüzde, kullanıcı belgeleri neredeyse her zaman çevrimiçi olarak sunuluyor ve bu da teknik yazarların kullanıcılara nasıl yardımcı olacakları konusunda daha yaratıcı olmalarına yardımcı oldu. Veri toplayabilir, farklı öğrenme tekniklerini deneyebilir, daha hızlı yineleyebilir ve kullanıcılar için daha zengin bir içerik deneyimi üretebilirler.

Bu blog yazısının geldiği yer burası! Bence

Bu gönderide, kullanıcı belgelerinizi geliştirmek için neler yapabileceğinizi keşfedeceğiz ve bazı mükemmel kullanıcı destek içeriği örneklerini gözden geçireceğiz.

Bir planla başlayın

Hayattaki çoğu şey gibi, bir planla başlamak en iyisidir ve kullanıcı belgeleri oluşturmak da farklı değildir. Bu nedenle, başlamadan önce kendinize (ve muhtemelen belgeleri isteyenlere) birçok soru sorduğunuzdan emin olmak isteyeceksiniz.

1. Kitlenizi düşünün

Bunu kimin için yapıyorsun? Son kullanıcı? Sistem yöneticisi mi? Bu içerik yalnızca dahili olarak mı incelenecek yoksa harici olarak da mı görülecek? Kullanıcı belgelerini kimin için oluşturduğunuz, paylaştığınız bilgileri çerçevelemeye yardımcı olur.

2. Nihai hedefinizi değerlendirin ve aklınızda bulundurun

Herhangi bir belgenin temel amacı, hedef kitlenize bir şeyler öğretmektir. Belgelerinizi kimin tüketeceğini belirledikten sonra, onlardan ne elde etmelerini istediğinize karar vermek isteyeceksiniz.

Belgeleri inceledikten sonra hedef kitlenizin gerçekleştirmesini istediğiniz eylem nedir? Bu sorunun cevabını aklınızda tutarak, söz konusu görev için doğru miktarda içerik sağlayabilirsiniz.

3. Kullanıcı belgelerinizin kolayca bulunabilir olduğundan emin olun

Gizli kullanıcı belgeleri, neredeyse kötü kullanıcı belgeleri kadar yararsızdır. Oluşturduğunuz kullanıcı belgelerinin ihtiyaç duyanlar tarafından kolayca bulunabilmesini sağlamak önemlidir.

Bu yalnızca görünür olduğundan emin olmak anlamına gelmez, aynı zamanda kullanıcıların teknik belgelerinizde gezinebileceği ve sorularına hızla yanıt bulabileceği anlamına gelir.

Hedef kitleniz bu yanıtları ne kadar hızlı bulabilirse o kadar mutlu olur. Ayrıca, ürününüzle ilgili önemli ancak sık sorulan soruları yanıtlamak zorunda kalmadan size zaman kazandıracaktır.

Kısa, güçlü yazı

Güçlü yazı, harika kullanıcı belgeleri için çok önemlidir. Ancak yazma, kullanıcı belgelerinin nasıl okunduğundan veya ses çıkardığından daha fazlasını etkiler. Kullanıcı belgelerinizde gezinmenin ne kadar kolay olduğunu da etkileyebilir.

4. Açıklayıcı başlıklar ve alt başlıklar yazın

Başlıklarınızın kullanışlı ve en önemlisi spesifik olduğundan emin olun. Bir soruyu cevaplamak için formüle edilmiş başlıklar veya alt başlıklar yazmak genellikle en iyisidir. Başlıkları bu şekilde çerçevelemek, son kullanıcılarınızın aradıklarını bulmasını kolaylaştırır ve ayrıca doğrudan kullanıcıların ihtiyaçlarına hitap eden makaleler yazmanıza yardımcı olur.

Unbounce, kullanıcı belgeleri boyunca etkili başlıklar ve alt yazılar yazma konusunda harika bir iş çıkarıyor. Bu, belgelerinde gezinmeyi kolaylaştırır. Her belirli makalenin, belirli bir sorunun cevabını bulmayı çok kolaylaştıran kendi içindekiler tablosu vardır.

5. Göz atmayı kolaylaştırın

Bilgilerin taranması kolay bir şekilde sağlanması, kullanıcıların zamandan tasarruf etmesine yardımcı olur. İnsanlar olarak, elde edebileceğimiz her türlü zaman tasarrufu için minnettarız. Ayrıca, kullanıcılar tam olarak ne aradıklarını bilemeyebilirler. Bu, göz atması kolay içeriğin en faydalı olduğu zamandır.

IBM, temiz bir içindekiler tablosu düzenleyerek ve ilgili konular sağlayarak yardım içeriğine göz atılmasını kolaylaştırma konusunda iyi bir iş çıkarıyor.

6. Kolayca aranabilir hale getirin

Google, sorularımızın yanıtlarını bulmanın, onları bir arama kutusuna yazmak kadar basit olduğu konusunda bizi eğitti. Yardım belgeleriniz bu beklentiyi yansıtmalıdır. Yardım içeriğiniz aranabilir değilse, muhtemelen çok yararlı değildir.

Hubspot'un kapsamlı bilgi tabanı, müşterileri için self servisi kolaylaştırır.

Anlamayı Geliştirmek için Görselleri Kullanın

İyi kullanıcı belgeleri son derece görseldir. Güçlü yazı ve metin, harika kullanıcı belgeleri için gerekli olsa da, insanlar en iyi görseller de mevcut olduğunda öğrenir.

7. Açıklamalı ekran görüntüleri kullanın

Açıklamalı ekran görüntüleri, kullanıcı belgelerinde kullanılacak güçlü görsellerdir. Tam olarak hangi adımları atmaları gerektiğini göstererek kullanıcılar için varsayımları ortadan kaldırırlar.

TechSmith Snagit gibi programlarla ekran görüntülerine metin belirtme çizgileri, oklar ve daha fazlasını eklemek kolaydır. Örneğin, bu blog yazısı boyunca Snagit ile yaptığım açıklamalı ekran görüntülerini kullandığımı fark edeceksiniz.

İlham alıyorsanız, Snagit'in Adım Aracı'nı deneyebilirsiniz; bu, bir görüntünün bölümlerini, işaret edip tıkladıkça sıralı belirtme çizgileri yerleştirerek tanımlamanıza olanak tanır. Başka bir adım eklemek için her tıkladığınızda, sayı otomatik olarak ilerler.

Belgelerinde ekran görüntülerinin gücünü kullanma konusunda harika bir iş çıkaran şirket Asana'dır. Müthiş kullanıcı belgeleri boyunca, müşterileri net bir şekilde yönlendirmek için açıklamalı ekran görüntüleri kullanırlar.

8. Anlatmak için değil göstermek için videodan yararlanın

Video, bir süreci göstermek için iyi çalışır. Çok sayıda harika kullanıcı belgesi, videonun gücünü metin talimatlarıyla birleştirir. Örneğin, bir süreci hızlı bir şekilde gözden geçirmek için kısa bir video kullanmak iyi bir uygulamadır.

Ardından, videonun yanı sıra, kullanıcıların süreci kendileri denerken başvurmaları için adım adım bir metin kılavuzu sağlayabilirsiniz. Bu şekilde, kısa bir hatırlatmaya ihtiyaçları olursa videoyu tekrar tekrar izlemek zorunda kalmazlar.

TechSmith ürün eğitimlerimizde, tartıştığımız özellik veya konuya tam bir genel bakış sağlamak için bir ana video kullanıyoruz. Ardından, videonun altında, videonun ana noktalarını yinelemek için ekran görüntüleri veya animasyonlu GIF'ler eşliğinde snippet'ler sağlıyoruz.

9. Örnekleri ve sonuçları gösterin

Kullanıcıların, her bir görevi başarıyla tamamlamanın neye benzediğini bilmesi gerekir. Kullanıcılara örnek bir nihai sonucun ekran görüntüsünü sağlamak, ideal sonucu hedef kitlenize göstermenin iyi bir yoludur.

Mükemmel kullanıcı belgeleri, son kullanıcıların sorularına yanıt bulmasını kolaylaştırır ve bu da mutlu ve memnun kullanıcılar yaratır.

Müthiş kullanıcı belgeleri oluşturmanın önemli bir parçası, net, kolayca taranabilir bilgiler sağlamaktır. Ekran görüntüleri, videolar veya animasyonlu GIF'ler gibi görseller, kullanıcılarınızla daha verimli ve etkili iletişim kurmanın harika yollarıdır.