Bir Yazılım Kullanım Kılavuzu Nasıl Yazılır: Nihai Kılavuz (Bir Şablon Dahil)

Ürününüz için nasıl bir yazılım kullanım kılavuzu yazacağınızdan emin değil misiniz?

Kullanıcılarınızın ürününüzden en yüksek değeri mümkün olan en verimli şekilde almasına yardımcı olmak istiyorsanız, kaliteli bir yazılım kullanım kılavuzu oluşturmak başlamak için harika bir yerdir.

Kullanıcılara ürününüzü kendi başlarına öğrenmeleri ve sorunlarını gidermeleri için ihtiyaç duydukları içeriği vererek, insan destek kanallarınıza ulaşmalarına gerek kalmadan başarılı olmalarına yardımcı olabilirsiniz.

Bu, yalnızca kullanıcılarınız için işleri kolaylaştırmakla kalmaz, aynı zamanda işletmenizdeki destek taleplerini de azaltarak zamandan ve paradan tasarruf etmenizi sağlar.

Peki, kullanıcılarınız için mükemmel yazılım kullanım kılavuzunu nasıl oluşturabilirsiniz? Bu kılavuzun amacı budur.

Harekete geçmenize yardımcı olmak için, bu yazıda ele alacağımız her şey burada:

• Yazılım kullanım kılavuzu nedir?
• Bir yazılım kullanım kılavuzu şablonu da dahil olmak üzere dört adımda bir yazılım kullanım kılavuzu nasıl yazılır?
• Kullanım kılavuzunuz için yüksek kaliteli içerik oluşturmaya yönelik en iyi uygulamalar

Hadi kazalım!

Yazılım Kullanım Kılavuzu Nedir?

Bir yazılım kullanım kılavuzu, yazılım uygulamanızın veya ürününüzün nasıl kullanılacağı ve yönetileceği hakkında bilgi sağlayan belgelerdir.

Yazılım kullanıcı kılavuzunuz, başlangıç ​​kılavuzları, yönergeler, sözlükler, sorun giderme ipuçları ve diğer benzer içerik türlerini içerebilir.

Temel olarak, kullanıcılarınızın yazılımınızdan değer elde etmek için ihtiyaç duyduğu tüm bilgileri içerir.

Tipik olarak, kurulum adımlarıyla başlayacak, ardından arayüze genel bir bakış ve farklı özelliklerin nasıl kullanılacağını kapsayacak ve ardından gerekirse sorun giderme ve SSS'leri ele alacaktır. Yine aşağıda daha ayrıntılı bir yazılım kullanım kılavuzu şablonu paylaşacağız.

Bir yazılım kullanım kılavuzu örneğini görmek için, doğrudan arayüz açıklamasına atlayan Forklift 3 Kullanım Kılavuzuna bakabilirsiniz.

Başka bir örnek olarak, doğrudan Slack arayüzünü açıklamaya atlayan Slack'in Başlarken içeriğine bakabilirsiniz.

Bir Yazılım Kullanım Kılavuzu Oluşturmak Neden Önemlidir?

Ürününüz için bir yazılım kullanım kılavuzu oluşturmanın iki büyük nedeni vardır:

1. Geliştirilmiş kullanıcı deneyimi – kullanıcıların yazılımınızı nasıl kullanacaklarını öğrenmelerini kolaylaştırarak ve yazılımınızdan aldıkları değeri en üst düzeye çıkararak, kullanıcılarınız daha iyi deneyimler yaşayacaktır.
2. Azaltılmış destek yükü – kullanıcılara kendi sorunlarını çözme yeteneği vererek, insan destek kanallarınızdaki yükü azaltabilirsiniz. Bu, özellikle kullanım kılavuzunuzu bir bilgi tabanı ve/veya sık sorulan sorular (SSS'ler) gibi diğer destek içeriği türleri ile birleştirirseniz geçerlidir.

Dört Adımda Yazılım Kullanım Kılavuzu Nasıl Yazılır?

Şimdi, bir yazılım kullanım kılavuzunun nasıl yazılacağına ilişkin genel adım adım kılavuza geçelim. Bir sonraki bölümde, kullanım kılavuzunuzdaki asıl içerik için bazı en iyi uygulamaları da ele alacağız.

Bu konulara daha genel bir bakışla ilgileniyorsanız, herhangi bir kullanım kılavuzunun nasıl oluşturulacağına dair bir kılavuzumuz da var.

1. Yazılım Kullanım Kılavuzunuzun Yapısını Planlayın

El kitabınız için herhangi bir içerik oluşturmaya başlamadan önce, el kitabınızın yapısını düzgün bir şekilde belirlemek isteyeceksiniz.

El kitabınızı olabildiğince kapsamlı hale getirmek için, bunu yapmanıza yardımcı olması için birden çok kilit paydaşı bir araya getirmek isteyebilirsiniz.

Örneğin, bu, müşteri başarısını, satışları vb. içerebilir - kullanıcıların üründen mümkün olduğunca fazla değer elde etmesine nasıl yardımcı olacağı konusunda bilgi sahibi olan herkes. Bazı durumlarda, daha gelişmiş ayrıntılarla yardımcı olması için daha fazla teknik personel getirmeniz de gerekebilir.

Elbette, solo bir proje yürütüyorsanız, tüm bu şapkaları kendiniz takacaksınız. Tek başına kurucu olmanın neşesi budur.

İlgili bilgi sahiplerine sahip olduğunuzda, kullanım kılavuzunuzun ana hatlarını oluşturabilirsiniz.

Kaba bir yazılım kullanım kılavuzu şablonu için şöyle bir şey izleyebilirsiniz…

1. İçindekiler – kullanıcıların ne bekleyeceklerini bilmeleri için kullanım kılavuzunuzdaki farklı bölümleri listeleyin.
2. Giriş – yazılım kullanım kılavuzunuzun amacını açıklayın.
3. Sistem gereksinimleri - donanım özellikleri, işletim sistemi vb.
4. Kurulum talimatları – kullanıcının yazılımı nasıl kurabileceğini kapsar.
5. Kullanıcı arayüzüne genel bakış – arayüze üst düzey bir genel bakış sağlar.
6. Belirli özellikler nasıl kullanılır – kullanıcılara nasıl çalıştığını gösteren her temel özellik için bir bölüm oluşturun.
7. Sık sorulan sorular - bir kullanıcının sahip olabileceği bazı yaygın soruları kapsar.
8. Sorun giderme – sorun giderme önerilerini paylaşın.
9. Sözlük – yazılımınızın belirli bir terminolojisi varsa, yazılım kullanım kılavuzunuzun sonuna bir sözlük eklemek isteyebilirsiniz.
10. Destek iletişim bilgileri – kullanıcıların herhangi bir ek yardıma ihtiyaç duymaları halinde destek ekibiyle nasıl iletişime geçebileceklerini açıklayın. Kullanıcıların desteğe ulaşmadan önce kendilerine yardım etmeye çalışması için bunu sona erdirmek istiyorsunuz.

Bu yazılım kullanım kılavuzu şablonunu tam olarak takip etmek zorunda değilsiniz – bu, eklemek isteyebileceğiniz şeyler hakkında size bir fikir vermek için yalnızca bir başlangıç ​​noktasıdır.

2. Yazılım Kullanım Kılavuzu İçeriğinizi Oluşturun

Taslağınızı aldıktan sonra, yazılım kullanım kılavuzu içeriğinizi oluşturmaya hazırsınız demektir.

İçeriğinizin büyük bir kısmı metin olacaktır, ancak ilgili resimleri, GIF'leri ve videoları da eklemeyi unutmayın.

Bu adım muhtemelen en fazla zaman alacak olsa da, bu bölümü şimdilik kısa tutuyoruz çünkü bir sonraki bölümde, ekibinizin etkili kullanım kılavuzu içeriği oluşturmasına yardımcı olacak bazı yazılım kullanım kılavuzu en iyi uygulamalarını paylaşacağız.

İçeriğinizi kimin yazacağı, kuruluşunuzun büyüklüğüne ve ürününüzün karmaşıklığına bağlı olacaktır. Ekibinizde özel bir teknik yazarınız yoksa, yazılımınızın karmaşıklığına bağlı olarak içeriği müşteri başarı ekibinize veya teknik ekibinize atamanız gerekebilir.

Veya, tek başına bir kurucuysanız, içeriğinizi en iyi şekilde anladığınız için muhtemelen kılavuz içeriğinizi yazacak en iyi kişi siz olacaksınız. İlk taslağınızı geliştirmenize yardımcı olması için her zaman bir editör kiralayabilirsiniz.

3. Yazılım Kullanım Kılavuzunuzu Yayınlayın

Yazılım kullanım kılavuzunuzun içeriğine sahip olduğunuzda, kılavuzunuzu kullanıcıların kolayca tüketmesini sağlayacak şekilde yayınlamanız gerekir.

Çoğu bilgi tabanı veya dokümantasyon yazılımı, bir yazılım kullanım kılavuzu için iyi çalışmalıdır, ancak aşırı derecede sınırlı hissediyorsanız her zaman kendi çözümünüzü kodlayabilirsiniz. Bazı işletmeler, web sürümüne ek olarak kullanım kılavuzunun PDF sürümünü de yayınlar.

Yazılım kullanım kılavuzunuzun web sürümünü yayınlamak için bazı harika seçenekleri görmek için, en iyi bilgi bankası yazılımları ve en iyi dokümantasyon araçları listemize göz atabilirsiniz.

Size sağlam bir özellik listesi, içeriğiniz üzerinde tam mülkiyet ve her şeyi ihtiyaçlarınıza göre özelleştirme esnekliği sağlayan bir kullanım kılavuzu yazılımı arıyorsanız, Heroic Knowledge Base WordPress eklentimizi kullanabilirsiniz.

Heroic Knowledge Base, benzer şekilde açık kaynaklı WordPress içerik yönetim sistemini (CMS), yazılım kullanım kılavuzunuzu yayınlamak için ihtiyaç duyduğunuz tüm işlevlerle genişleten açık kaynaklı bir yazılımdır.

Platformunuz üzerinde tam sahipliğe ve ayrıca her öğeyi gerektiği gibi ayarlama esnekliğine sahip olacaksınız. Ancak aynı zamanda Heroic Knowledge Base, yazılım kullanıcı kılavuzunuzun ihtiyaç duyduğu tüm önemli özellikler için yerleşik işlevsellik içerir:

• Makale organizasyonu – kategorileri kullanarak yazılım kılavuzunuzdaki makaleleri düzenleyebilirsiniz. Örneğin, "Kurulum", "Arayüz", "Özellikleri Kullanma", "Sorun Giderme" vb. için farklı kategorileriniz olabilir.
• İçerik bulma özellikleri – kullanıcıların ilgili içeriği olabildiğince çabuk bulmasına yardımcı olmak için Heroic Knowledge Base, gerçek zamanlı arama önerileri, otomatik içindekiler tablosu ve daha fazlası gibi faydalı içerik keşfetme özellikleri içerir.
• Kullanıcı geri bildirim sistemi – kullanıcılar, her makalenin yararlılığı hakkında geri bildirim paylaşabilir, bu da neyi iyi yaptığınızı (ve nerelerde geliştirmeniz gerektiğini) bilmenizi sağlar.
• Ayrıntılı analiz – hangi makalelerin en çok görüntülendiğini, hangi makalelerin en çok insan desteği talebine yol açtığını, kullanıcıların hangi terimleri aradığını, hangi aramaların sonuç getirmediğini ve daha fazlasını takip edebilirsiniz.

4. Yazılım Kullanım Kılavuzunuzu Geri Bildirim ve Değişikliklere Dayalı Olarak Güncelleyin

Kaliteli bir yazılım kullanım kılavuzu oluşturmak "bir kez ve bitti" işi değildir. El kitabınızı yayınladıktan sonra, el kitabınızı gerektiği gibi güncellemek ve revize etmek için kilit paydaşları görevlendirmeniz önemlidir.

Bazı durumlarda, bu güncellemeler yazılımınızdaki bir değişiklik nedeniyle gerekli olabilir. Örneğin, yeni bir özellik eklerseniz veya yazılımınızın arayüzünü değiştirirseniz, bu değişiklikleri hesaba katmak için kullanım kılavuzunuzu güncellemeniz gerekir.

Diğer durumlarda, bu güncellemeler kullanıcı geri bildirimlerinden kaynaklanabilir. Örneğin, belirli bir makalenin kullanıcıların kafasını karıştırdığını görürseniz, o makaleyi daha yararlı hale getirmek için güncelleyebilirsiniz.

Veya, kullanıcıların yazılım kullanım kılavuzunuzda olmayan bir konuyu aradığını görürseniz, o konuyu kapsayacak yeni bir makale oluşturmanız gerekebilir.

Kullanım kılavuzunuzu Heroic Knowledge Base gibi bir araçla yayınlamak, kullanım kılavuzu içeriğinizi izleyebilmeniz ve iyileştirebilmeniz için bu tür analizleri kolayca izlemenize olanak tanır.

Yazılım Kullanım Kılavuzunuzu Yazmak İçin En İyi Uygulamalar

Artık bir yazılım kullanım kılavuzunun nasıl yazılacağının temel sürecini anladığınıza göre, etkili kullanım kılavuzu içeriği oluşturmak için bazı en iyi uygulamaları gözden geçirelim.

Kitlenizin Kim Olduğunu Anlayın

Yararlı bir kullanım kılavuzu içeriği oluşturmak istiyorsanız, kimin için yazdığınızı bilmek çok önemlidir:

• Kullanıcılarınızın nereden geldiği.
• Yazılımınızla başarmaya çalıştıkları şey.
• Hangi acı noktalarını yaşıyorlar.
• Sektörünüz ve/veya ilgili herhangi bir teknik alan hakkındaki genel bilgi düzeyleri.
• Hangi şirket için çalışıyorlar (veya yalnız kullanıcılarsa).
• Vesaire.

Örneğin, yazılımınızın Salesforce ile ilgilendiğini varsayalım. Hedef kullanıcılarınız deneyimli Salesforce yöneticileriyse, içeriğiniz, hedef kullanıcılarınızın satış görevlileri olmasına göre çok daha farklı görünecektir.

Muhtemelen mevcut çalışmalarınızdan hedef kullanıcılarınız hakkında iyi bir anlayışa sahip olacaksınız. Ancak emin değilseniz, daha derin bir anlayış kazanmak için müşteri karakterlerini, anketleri ve röportajları kullanabilirsiniz.

Mantıksal Bir Yapı ve Organizasyon Kullanın

Buna önceki bölümün ilk adımında değinmiştik, ancak kullanıcıların içeriğinizden değer elde etmesini kolaylaştırmak için kullanım kılavuzunuzu en uygun şekilde düzenlemeniz önemlidir.

Kullanım kılavuzunuzu düzenlemenin farklı yolları vardır ve farklı bölümlerde birden fazla yaklaşım kullanabilirsiniz:

• Doğrusal deneyim – kılavuzunuzu, kullanıcıların deneyimleyeceği şekilde düzenleyebilirsiniz. Örneğin ilk bölüm olarak “Kurulum” ile başlayıp bir sonraki bölümde kurulum sonrası ilk işleme geçebilirsiniz.
• Özellik – manuel içeriğinizi yazılımınızdaki farklı özelliklere göre düzenleyebilirsiniz.
• Sorun Giderme – genel sorun giderme adımlarını tek bir noktada toplayabilirsiniz.

Yine, el kitabınızda birden çok yaklaşım kullanmakta hiçbir sakınca yoktur. Örneğin, yükleme işlemi için her şeyi doğrusal bir şekilde düzenleyerek başlayabilirsiniz.

Ancak kurulumu tamamladıktan ve kullanıcılar yazılımınızı farklı şekillerde uygulamaya başladıktan sonra, özellik tabanlı bir organizasyon yaklaşımına geçebilirsiniz.

Yazınızı Basit ve Tutarlı Tutun

Yazılım kullanım kılavuzunuzu mümkün olduğunca erişilebilir kılmak için, yazınızı mümkün olduğunca basit tutmanız önemlidir.

İşte bunu gerçekleştirmek için akılda tutulması gereken bazı şeyler:

• Jargon veya kafa karıştırıcı kelimeler kullanmayın – sektörünüz ve/veya ürününüzün dili söz konusu olduğunda tüm kullanıcılarınız aynı bilgiye sahip olmayacaktır, bu nedenle gereksiz teknik jargondan ve kafa karıştırıcı kelime dağarcığından kaçınmak önemlidir. Sorunları bulmak için içeriğinizi Flesch Reading Ease testi gibi araçlarla test edebilirsiniz.
• Pasif sesten kaçının – pasif ses kullanmak özellikle bir kullanım kılavuzunda kafa karıştırıcı olabilir. Örneğin, “Taslağınızı Kaydet düğmesine basarak taslağınızın bir kopyasını kaydedebilirsiniz” gibi pasif bir ses kullanmak yerine, “Taslağı Kaydet düğmesine basarak taslağınızın bir kopyasını kaydedebilirsiniz” gibi aktif bir ses kullanmak daha iyidir. taslak."
• Kısa cümleler kullanın – içeriğinizi kısa cümlelere bölmek, kullanıcıların kullanım kılavuzu içeriğinizi okumasını ve taramasını kolaylaştırır. Mümkün olduğunca uzun paragraflardan kaçının (AKA “metin duvarları”).
• Tutarlı olun – tutarlı ifadeler ve biçimlendirme kullanmak, kullanıcıların kılavuzunuzu anlamasını kolaylaştıracaktır. Örneğin, belirli bir görevdeki adımları tek tek listelemek için her zaman sıralı bir liste kullanıyorsanız, bu biçimlendirmeyi tüm kullanım kılavuzunuzda tutmaya çalışın.
• Dilbilgisi ile ilgili sorunlardan kaçının – kullanıcıların el kitabınızı anlamasını zorlaştırabilecek herhangi bir dilbilgisi hatanız olmadığından emin olun. Grammarly ve Hemingway gibi araçları kullanarak bunu kontrol edebilirsiniz.

Yararlı Olduğu Yerlerde Resimleri ve Videoları Dahil Edin

Metin içeriği kullanım kılavuzunuzun temelini oluşturacak olsa da, mantıklı olduğu yerlerde resim ve videoları da dahil etmek önemlidir.

"Bir resim bin kelimeye bedeldir" sözü klişe olabilir, ancak kullanıcıların yazılım ürününüzden nasıl değer elde edebileceklerini açıklamaya çalışırken kesinlikle doğru olabilir.

Metninizdeki kavramları açıklamaya yardımcı olması için, neden bahsettiğinizi gösteren açıklamalı resimler veya GIF'ler ekleyebilirsiniz.

Örneğin, Slack, arayüz tanıtım resimlerine açıklama ekleme konusunda harika bir iş çıkarıyor.

Video içeriği de bazı kullanıcılar için faydalı olabilir. Ancak, yalnızca video içeriğine güvenme konusunda dikkatli olmalısınız çünkü bu, kullanıcıların yazılım kılavuzu içeriğini tüketmesi için her zaman en uygun yol değildir.

Örneğin, bir kullanıcı yalnızca belirli bir ayrıntıyla ilgili sorunları gidermeye çalışıyorsa, bu ayrıntıyı metin içeriğinde bulması genellikle bir videodan çok daha kolaydır.

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

Bu, kullanıcılarınızı başarıya hazırlayacak harika bir yazılım kullanım kılavuzunun nasıl yazılacağına ilişkin kılavuzumuzu tamamlıyor.

Yazılım kullanım kılavuzunuzu yayınlamanın en kolay yolunu istiyorsanız, WordPress için Heroic Knowledge Base eklentisini kullanabilirsiniz.

Heroic Knowledge Base, WordPress CMS'den tamamen sizin kontrolünüz altında olan kendi barındırılan yazılım kullanım kılavuzunuzu oluşturmak için yararlanmanıza izin veren açık kaynaklı bir eklentidir.

Aynı zamanda, işlevsellikten ödün vermenize gerek yok çünkü Heroic Knowledge Base, harika bir yazılım kullanım kılavuzu oluşturmak için ihtiyacınız olan tüm özellikleri sunuyor. Bu özellikler, canlı arama önerileri, kategori organizasyonu, kullanıcı geri bildirimi toplama, analiz ve daha fazlasını içerir.

Başlamaya hazırsanız, Heroic Knowledge Base'i bugün satın alın ve kısa sürede harika görünen bir kullanım kılavuzuna sahip olacaksınız.