Ücretsiz kullanıcı kılavuzu oluşturucu

Kullanıcı kılavuzu nedir?

Kullanıcı kılavuzu, bir ürünün ne işe yaradığını, nasıl başlanacağını ve her bir özelliğin nasıl kullanılacağını tek bir düzenli belgede açıklayan kapsamlı bir rehberdir. Kullanıcı kılavuzu oluşturucu, ürününüzün tanımından bu yapıyı taslak haline getirir, böylece boş bir sayfayla uğraşmak yerine her bölümü yerli yerinde olan bir taslakla başlar ve detayları doldurursunuz.

Buna kullanıcı rehberi, talimat kılavuzu veya ürün dokümantasyonu dendiğini de duyabilirsiniz. İsimler farklı olsa da işlev aynıdır: insanların ürünü size sormadan kullanmalarına yardımcı olmak.

Bir kullanıcı kılavuzu neleri içerir?

Oluşturucu, çoğu kılavuzun paylaştığı şu yapıyı izler:

• Giriş: ürünün ne olduğu, kimin için olduğu ve bununla neler yapabilecekleri.
• Başlangıç: gereksinimler, kurulum veya ilk oturum açma ve numaralandırılmış adımlar olarak yapılacak ilk yararlı şey.
• Özellik başına bir bölüm: yeni bir kullanıcının karşılaştığı sırayla, arayüz etiketleri kalın yazılarak.
• Ayarlar ve hesap: üründe varsa roller, faturalandırma ve tercihler.
• Sorun giderme: olası sorunlar ve her biri hakkında ne yapılması gerektiği.
• SSS ve sözlük: hızlı yanıtlar ve ürünün kendi terimlerinin açıklamaları.

Hangi dokümantasyon formatına ihtiyacınız var?

Birçok ekip bunları birleştirir: genel resim için bir kılavuz, yardım merkezi makalelerine bölünmüş içerik ve gösterilmesi daha kolay görevler için kısa videolar.

Kısa bir kullanıcı kılavuzu örneği

Bir zaman takibi uygulaması için, oluşturulan kullanıcı rehberinin Başlangıç bölümü şu şekilde olabilir:

Başlangıç

1. Yöneticinizden gelen davet e-postasını açın ve şuna tıklayın: Çalışma alanına katıl.
2. Şifrenizi belirleyin ve oturum açın.
3. Tıklayın: Zamanlayıcıyı başlat, ardından bir müşteri ve proje seçin.
4. Tıklayın: Durdur bitirdiğinizde. Giriş, haftalık zaman çizelgenizde görünür.

Tanımınızın tam bir menü adı veya URL gibi bir detayı vermediği yerlerde, oluşturucu tahmin etmek yerine doldurmanız için bir yer tutucu yazar.

Daha iyi bir kılavuz için ürününüzü nasıl tanımlamalısınız?

Kullanıcı kılavuzu oluşturucu yalnızca metninizin desteklediği özellikleri tanımlar, bu nedenle kalite tanımınızdan gelir. Ana özellikleri yeni bir kullanıcının karşılaştığı sırayla listeleyin, ekranları ve düğmeleri arayüzde göründükleri gibi adlandırın ve ürününüzde varsa rolleri, ayarları ve faturalandırmayı belirtin. Müşterilerin en sık karşılaştığı sorunları ekleyin, böylece sorun giderme bölümü yararlı olur. Hedef kitle alanını da doldurun: yöneticiler için bir kılavuz kısa olabilir, ancak ilk kez kullananlar için olan her adımı içermelidir.

İnsanların kullandığı bir kullanıcı kılavuzu nasıl yazılır?

Ekrana göre değil, göreve göre düzenleyin

Okuyucular bir hedefle gelir: “fatura gönder”, “takım arkadaşı ekle”. Bölümleri menü yapınıza göre değil, bu hedeflere göre adlandırın.

En az deneyimli okuyucunuz için yazın

Terimleri ilk kullandığınızda tanımlayın ve size bariz gelen adımları atlamayın.

Arayüzü gösterin

Her önemli adımın ekran görüntüsü veya kısa bir video, “bu nerede?” sorusunu herhangi bir açıklamadan daha hızlı yanıtlar.

Bunu yaşayan bir belge olarak görün

Her sürüm bir bölümü hatalı hale getirebilir. Bir sorumlu atayın ve ürün her değiştiğinde etkilenen sayfaları gözden geçirin.

Yaygın kullanıcı kılavuzu hataları

• İşlerin nasıl yapılacağını açıklamak yerine her düğmeyi tanımlamak.
• Arayüzle eşleşmeyen dahili isimler kullanmak.
• Bağlantı verilebilir sayfalar yerine kimsenin arayamadığı devasa bir PDF.
• İnsanların tıkandıklarında en çok aradıkları kısım olan sorun gidermeyi dışarıda bırakmak.

Oluşturucu ürünün kendisinden değil, tanımınızdan çalışır, bu nedenle yayınlamadan önce her adımı kontrol edin ve her yer tutucuyu değiştirin.