Kullanım Kılavuzu Nasıl Oluşturulur: Sıfırdan Kahramana (Tam Kılavuz)

Müşterilerinizin ürününüzden daha fazla değer elde etmesine yardımcı olacak bir kullanım kılavuzunu nasıl oluşturacağınızdan emin değil misiniz?

Kullanım kılavuzu, müşterilerinizin (veya çalışanlarınızın) ürün veya hizmetinizi etkin bir şekilde kullanmasına yardımcı olan içeriktir. Bunun bir kullanım kılavuzu, kullanım kılavuzu, ürün kılavuzu vb. olarak adlandırıldığını da görebilirsiniz.

Yüksek kaliteli bir kullanım kılavuzu oluşturmak, müşterilerinizin ürününüzü etkili bir şekilde kullanmasına yardımcı olmanın ötesinde, müşteri hizmetleri ve destek taleplerini azaltmanıza da yardımcı olabilir, çünkü kullanıcılar sorunlarını desteğe ulaşmadan çözebilir.

Bu ayrıntılı kılavuzda, müşterilerinizin başarıya ulaşmasına yardımcı olacak bir kullanım kılavuzunu nasıl oluşturacağınızı öğreneceksiniz.

Bunu gerçekleştirmek için burada ele alacağımız her şey var:

• Farklı türde kullanım kılavuzları
• Kullanım kılavuzunuzu nerede yayınlamalısınız?
• Kullanım kılavuzu nasıl oluşturulur?

Hadi kazalım!

Farklı Kullanım Kılavuzu Türleri

Hem müşteriye dönük hem de dahili içerik dahil olmak üzere farklı türde kullanım kılavuzları vardır.

Başlamadan önce, içeriğe nasıl yaklaştığınızı etkileyeceğinden, ne tür bir kılavuz oluşturmak istediğinizi anlamak önemlidir.

Farklı kullanım kılavuzu türlerinin kısa bir özeti aşağıda verilmiştir:

• Kullanım kılavuzu – klasik bir kullanım kılavuzu, kullanıcılara bir ürünün nasıl kullanılacağını öğretir.
• Eğitim kılavuzu – bir eğitim kılavuzu, kullanıcılara belirli bir görevi nasıl gerçekleştireceklerini veya belirli bir işi nasıl tamamlayacaklarını öğretir.
• Kullanım kılavuzu – bir kullanım kılavuzu, genellikle şirketinizin operasyonlarını belgeleyen dahili bir kılavuzdur.
• Servis kılavuzu - bir servis kılavuzu, kullanıcılara ürün yaşam döngüsünün farklı noktalarında bir ürünün bakımını nasıl düzgün bir şekilde yapacaklarını öğretmeye odaklanır.
• Standart İşletim Prosedürleri (SOP'ler) – SOP'ler, kuruluş üyelerine belirli süreçleri "doğru şekilde" nasıl düzgün bir şekilde tamamlayacaklarını öğreten dahili kılavuzlardır.

Aşağıdaki talimatlar için, çoğunlukla halka açık bir kullanım kılavuzu oluşturmakla ilgileniyoruz. Ancak, aşağıdaki temel ilkeler her türlü kullanım kılavuzu için geçerli olacaktır.

Kullanım Kılavuzunuzu Nerede Yayınlamalısınız?

Kullanım kılavuzunuzu nerede yayınlayacağınız, oluşturduğunuz kullanım kılavuzunun türüne bağlı olacaktır.

Müşteriye dönük kullanım kılavuzlarını neredeyse her zaman web sitenizde yayınlamak isteyeceksiniz. Bu şekilde, kullanıcılar kılavuza her yerden erişebilir.

Ayrıca, kullanım kılavuzu içeriğini web'de yayınlamak, tıklanabilir içindekiler tablosu ve gerçek zamanlı arama önerileri eklemek gibi fiziksel bir kullanım kılavuzuyla yapabileceğinizden daha kullanıcı dostu bir deneyim oluşturmanıza da olanak tanır.

Bununla birlikte, fiziksel ürünler için, web tabanlı kılavuzunuza ek olarak fiziksel bir kullanım kılavuzu da eklemek isteyebilirsiniz.

Dahili kullanım kılavuzları için, genellikle onları genel görünümden gizlemek isteyeceksiniz.

Bunu başarmanın bir yolu, bunları yalnızca bir şirket intranetinde kullanıma sunmaktır. Ancak, evden çalışan bu kadar çok insan varken, şirketinizin kendi VPN kurulumu yoksa bunu yapmak zor olabilir.

Bunun yerine, çalışanın bir kullanıcı hesabında oturum açmasını isteyerek veya yalnızca sayfaya erişmek için bir parola ekleyerek içeriği parolayla korumayı düşünebilirsiniz.

Fiziksel kullanım kılavuzları için, daha karmaşık kılavuzlar yayınlamanıza yardımcı olması için özel bir bilgi yönetimi aracı kullanabilirsiniz. Ya da daha basit kullanım kılavuzları için Google Dokümanlar'a yazıp oradan yayınlayabilirsiniz - teknik yazma araçları koleksiyonumuzda hayatınızı kolaylaştıracak bazı yararlı araçlar bulunur.

Kullanım kılavuzunuzu çevrimiçi yayınlamak için çoğu belgeleme veya bilgi bankası yazılımını kullanabilirsiniz. Hem halka açık hem de dahili kullanım kılavuzlarını işleyebilen bir araç istiyorsanız, WordPress için açık kaynaklı Heroic Knowledge Base eklentisini düşünebilirsiniz. Eğitimde bunun hakkında daha ayrıntılı olarak konuşacağız.

Aşağıda, Heroic Knowledge Base'den (ve Heroic Knowledge Base hakkında) bir çevrimiçi kullanım kılavuzu örneği verilmiştir:

Eğitimden bahsetmişken…

Altı Adımda Kullanım Kılavuzu Nasıl Oluşturulur

Artık biraz arka plan bilgisine sahip olduğunuza göre, sıfırdan başlayıp tamamlanmış bir kullanım kılavuzuna kadar bir kullanım kılavuzunun nasıl oluşturulacağına geçelim.

1. Kullanıcı Kişilerinizi Oluşturun

Herhangi bir içerik oluşturmaya başlamadan önce, içeriğin kimin için olduğunu anlamak istersiniz, bunu kullanıcı karakterleri oluşturarak başarabilirsiniz.

Muhtemelen müşterilerinizin kim olduğu hakkında zaten iyi bir fikriniz vardır, ancak çabalarınızı gerçekten odaklamak için bunu yazmanız yararlı olacaktır.

Bu neden önemli?

İşte bir örnek:

Makine mühendisleri için teknik içerik oluşturmak ile teknik olmayan kullanıcılar için teknik içerik oluşturmak arasında büyük bir fark vardır.

Çoğu ürün için, farklar o kadar da keskin olmayacaktır. Ancak, kullanım kılavuzunuzun onu gerçekten kullanacak kişiler için anlamlı olduğundan emin olabilmeniz için müşterilerinizi anlamak yine de önemlidir.

2. Temel Problem(ler)i ve Hedef(ler)i Belirleyin

Müşterilerinizin kim olduğunu anladıktan sonraki adım, oluşturacağınız kullanım kılavuzu ile neyi başarmaya çalıştıklarını anlamaktır.

Yani, bu kılavuzu okuyacak kişilerin nihai hedefi (veya nihai hedefleri) nedir?

Bunu anlamak önemlidir, çünkü kılavuzunuzun amacı, kullanıcılarınızın bu hedefe mümkün olduğunca verimli bir şekilde ulaşmalarına yardımcı olmak olmalıdır.

Bazı durumlarda, bu nihai hedef belirli bir şey olabilir. Örneğin, bir sosyal medya yönetim aracınız varsa, bu “sosyal medyada bir gönderi planlamak” olabilir.

Diğerlerinde ise “proje yönetimi süreçlerimizi iyileştirmek” gibi daha soyut bir hedef olabilir.

Daha büyük ürünler için, kullanıcının elde etmeye çalıştığı birden fazla şey olabilir, bu da bizi bir sonraki bölüme götürür.

3. Mantıksal Yapı ve Hiyerarşi Oluşturun

Artık müşterilerinizin kim olduğunu ve ne elde etmek istediklerini anladığınıza göre, kullanım kılavuzunuzun yapısını belirlemeye başlayabilirsiniz.

Kullanıcılarınızı "sıfırdan" bir önceki bölümde listelediğiniz nihai hedeflere ulaşmaya götürecek bir yapı oluşturmak istiyorsunuz.

İşte bunu yapmanıza yardımcı olacak bazı ipuçları:

1. Müşterilerin ürününüzden mümkün olan en kısa sürede değer elde etmeye başlamasına nasıl yardımcı olabileceğinizi düşünün.
2. Kendi kişisel bilginizi ondan çıkarın. Belli ki ürününüz hakkında çok şey biliyorsunuz, ancak müşterilerinizin bu düzeyde arka plan bilgisi olmayacak.
3. Müşterilerinizin ürününüzü kullanmaya çalışırken karşılaşabilecekleri genel sorunları veya kafa karıştırıcı ayrıntıları ele aldığınızdan emin olun. Bunlar, müşterilerin sorunlarla karşılaşma olasılığının en yüksek olduğu zamanlarda mantıklı bir şekilde ele alınmalıdır.

4. Kullanım Kılavuzu İçeriğinizi Yazın

İçeriğinizin haritasını çıkardıktan sonra, yazmaya başlamaya hazırsınız.

Ürününüzün/kuruluşunuzun büyüklüğüne bağlı olarak her şeyi kendiniz yazabilirsiniz. Veya içeriği yazmak için diğer ekip üyeleriyle işbirliği yapmanız gerekebilir.

Kullanım kılavuzunuzu yazarken göz önünde bulundurmanız gereken bazı genel kullanım kılavuzu en iyi uygulamaları şunlardır:

• Tutarlı biçimlendirme sağlamak için bir şablon kullanın . Biçimlendirilmiş bir şablon oluşturmak yalnızca işinizi hızlandırmakla kalmaz, aynı zamanda kılavuzunuzdaki her makalenin diğerleriyle tutarlı olmasını da sağlar.
• Kullanıcılara yardımcı olacak görseller (resimler ve videolar) ekleyin . Metin ne kadar ayrıntılı ve kapsamlı olursa olsun, iyi açıklamalı bir resim veya GIF, bağımsız metin yönergelerinden daha yararlı olabilir.
• Sade bir dil kullanın ve jargondan kaçının . Veya jargon tamamen kaçınılmaz olduğunda, onu açıkladığınızdan emin olun.
• Kısa ve öz tutun . Bir kullanım kılavuzu ile hedefiniz, konuyu mümkün olduğunca az kelimeyle tam olarak ele almak olmalıdır. Önemli bilgileri atlamayın, ancak gereksiz içeriği acımasızca kesin.
• Mümkün olduğunda yönergeler için madde işaretleri ve listeler kullanın . Numaralı veya madde işaretli bir liste kullanmak, kullanıcıların kılavuzu takip etmesini kolaylaştırabilir. Veya bir listenin izin verdiğinden daha fazla ayrıntıya ihtiyacınız varsa, her adımı kendi alt başlığı yapabilirsiniz.
• Aktif ses kullan . Pasif ses, bir kullanım kılavuzundaki talimatlar için özellikle kafa karıştırıcı olabilir. “Kırmızı butona basarak ürünü açabilirsiniz” ile “Kırmızı butona basarak ürünü açabilirsiniz” arasındaki farktır. İkinci örnek (aktif ses) daha nettir ve okuyucunun kendisini talimatlara dahil etmesini kolaylaştırır.

Son olarak, kullanım kılavuzu talimatlarınızı sanki ilk kez kullanıyormuşsunuz gibi test etmek her zaman iyi bir fikirdir.

Yani, bir makale yazdıktan sonra geri dönün ve hiçbir şeyi kaçırmadığınızdan emin olmak için bu talimatları adım adım izleyin.

5. Kullanım Kılavuzunuzu Yayınlayın

İçeriğinizi aldıktan sonra, canlı yayına geçmenin son adımı, müşterilerinizin kolayca erişebilmesini sağlamak için kullanım kılavuzunuzu yayınlamaktır.

Bunu nasıl yapacağınız, ne tür bir ürün sunduğunuza bağlı olacaktır. Örneğin, fiziksel ürünler gönderiyorsanız, el kitabınızın fiziksel bir sürümünü dahil etmek isteyebilirsiniz.

Bununla birlikte, ne tür bir ürün sunuyor olursanız olun, kullanım kılavuzunuzu insanların kolayca bulabilmesi için çevrimiçi olarak yayınlamak isteyeceksiniz.

Bunu yapmanıza yardımcı olması için bilgi bankası/dokümantasyon yazılımını kullanabilirsiniz.

Örneğin, Heroic Knowledge Base WordPress eklentisi ile açık kaynak WordPress yazılımını kullanarak kullanım kılavuzunuzu yayınlayabilirsiniz.

Bu açık kaynak yaklaşımı size platformunuz üzerinde tam sahiplik ve kontrol sağlarken, müşterilerinizin kullanım kılavuzunuzda daha etkin bir şekilde gezinmesine yardımcı olacak pek çok yararlı araç sağlamaya devam eder:

• Kategori organizasyonu – kullanım kılavuzunuzu kolayca mantıksal kategoriler halinde düzenleyebilir ve bu kategorileri sürükleyip bırakarak sıralayabilirsiniz.
• Gerçek zamanlı arama önerileri – Müşteriler doğrudan belirli bir eğitime atlamak isterse, aramaya yazmaya başlayabilir ve sorgularına göre canlı arama önerilerini görebilirler.
• Otomatik içindekiler – eklenti, her kullanım kılavuzu makalesi için otomatik olarak tıklanabilir bir içindekiler tablosu oluşturacak ve bu da okuyucuların doğrudan kendileriyle ilgili bölüme atlamalarına yardımcı olacaktır.
• Kolay açıklamalar/biçimlendirme – makalelerinizdeki temel öğelere dikkat çekmek için açıklamaları ve diğer biçimlendirmeleri kolayca ekleyebilirsiniz.
• Anında cevaplar widget'ı – sitenizde özel bir kullanım kılavuzu sayfası oluşturmaya ek olarak, ziyaretçilerin sitenizdeki herhangi bir yerden kullanım kılavuzu içeriğine göz atmalarını sağlayan aranabilir bir anında cevaplar widget'ı da ekleyebilirsiniz.

Bir kullanım kılavuzu yayınlamanıza yardımcı olacak daha fazla yazılım seçeneği görmek istiyorsanız, en iyi bilgi bankası yazılımı ve en iyi dokümantasyon araçları hakkındaki yazılarımızı okuyabilirsiniz.

6. Kullanım Kılavuzunuzu Gerektiğinde Güncelleyin ve Revize Edin

Kullanım kılavuzu oluşturmak bir kerelik bir çaba değildir. İleride, içeriğinizi gözden geçirmek ve güncellemek için zaman ayırmanız gerekecek.

Kullanım kılavuzunuzu güncellemeniz gerekebilecek iki ana neden vardır:

1. Ürününüze yeni özellikler eklediniz veya mevcut özelliklerin/arayüzlerin çalışma şeklini değiştirdiniz.
2. Kullanım kılavuzu içeriğinizi daha faydalı hale getirmek için geliştirmek istiyorsunuz.

İlk durum açıktır – ürününüzü bir şekilde değiştirirseniz, bu değişiklikleri hesaba katmak için kullanım kılavuzunuzu güncellemeniz gerekir.

Ancak, ikinci durumu da hesaba katmak önemlidir. Ne kadar denerseniz deneyin, muhtemelen her kullanım kılavuzu makalesini ilk günden itibaren mükemmel hale getiremeyeceksiniz.

Kullanıcılarınıza daha iyi yardımcı olmak için, düşük performanslı manuel içeriği daha kullanışlı hale getirmek için güncellemek ve gözden geçirmek isteyeceksiniz.

Kullanım kılavuzunuzu Heroic Knowledge Base gibi bir araçla yayınlarsanız, hangi makalelerin iyileştirilmesi gerektiğini kolayca görebilmeniz için yerleşik makale yararlılık derecelendirmeleri içerir. Kullanıcılar ayrıca makale hakkında metin geri bildirimi bırakabilir, bu da sizi makalenin olabildiğince yardımcı olmayan belirli bölümlerine yönlendirebilir:

Kullanıcıların sorun yaşadığı konulardaki makaleleri de kaçırıyor olabilirsiniz. Bu eksik konuları bulmanıza yardımcı olmak için Heroic Knowledge Base ayrıca yerleşik arama analitiği içerir, böylece hangi aramalarda herhangi bir konu sonucu olmadığını ( genel olarak genel aramaların yanı sıra ) takip edebilirsiniz:

Kullanım Kılavuzunuzu Bugün Oluşturun

Müşterilerinizi başarıya hazırlamak istiyorsanız, bir kullanım kılavuzunun nasıl oluşturulacağını öğrenmek önemlidir.

Bu gönderideki ipuçları ve en iyi uygulamalarla, artık kullanım kılavuzunuzu kullanmaya başlamanız için gereken bilgiye sahip olmalısınız.

Kullanım kılavuzunuzu çevrimiçi olarak yayınlamanın ve müşterilerinizin kılavuzda gezinmesine yardımcı olmanın kolay bir yolu için WordPress ve Heroic Knowledge Base eklentisini kullanabilirsiniz.

Heroic Knowledge Base, makalelerinizi yayınlamanızı ve gerektiğinde düzenlemenizi kolaylaştırır. Ayrıca, müşterileriniz canlı arama önerileri, otomatik içindekiler tablosu ve daha fazlası gibi yararlı özelliklerden yararlanabilir.

Bugün başlayın ve kullanım kılavuzunuzu hemen yayınlayacaksınız.

İşletmenizdeki dahili bilgileri geliştirmek için belgeler oluşturmakla ilgileniyorsanız, personeliniz için bir eğitim kılavuzunun nasıl yayınlanacağına ilişkin eğitimimiz de ilginizi çekebilir.