Kullanım kılavuzu nasıl yazılır?
Yazılım kullanım kılavuzunda en sık yapılan hata, programı menü menü anlatmaktır. Okuyan kişi menüleri değil, bir işi bitirmeyi ister: “fatura kesmek”, “kullanıcı eklemek”. Bu yüzden kılavuzu özelliklere göre değil, görevlere göre kur.
- Okuyanı tanı. Yeni başlayan bir kullanıcı mı, yönetici mi, destek ekibi mi? Kılavuz tek bir kitleye yazılır.
- Görev listesi çıkar. Okuyanın ilk hafta yapacağı beş ile on işi yaz. Sık sorulan sorular bu listenin en iyi kaynağıdır.
- Her görevi gerçek ekranda kaydet. Test hesabıyla işi yap; her tıklamayı ve yazılan değeri adım olarak al.
- Adımları fiille başlayan cümlelere çevir. “Müşteriler menüsüne tıkla.” Bir adımda bir eylem.
- Görseli işaretle. Düğmeyi halka ya da okla göster, görseli ilgili alana kırp.
- Uyarı ve ipucu ekle. Geri alınamayan adımları ve zorunlu alanları belirt.
- Önce bir yeni başlayanla dene. Takıldığı her yeri düzelt, sonra yayınla.
Yazılım kullanım kılavuzunda hangi bölümler olmalı?
| Bölüm | İçerik | Uzunluk |
|---|---|---|
| Başlarken | Giriş, ilk oturum açma, ekranın genel görünümü | 1 sayfa |
| Görevler | Her görev için numaralı adımlar ve görseller | Görev başına yarım ile bir sayfa |
| Sık sorulanlar | Sık yapılan hatalar ve çözümleri | 1 sayfa |
| Sözlük | Yazılımın kendi terimleri, kısa tanımlarla | Yarım sayfa |
| Destek | Kime, hangi kanaldan, hangi bilgiyle yazılır | Birkaç satır |
Bölümler yazılımın uzunluğuna göre kısalabilir. Küçük bir iç araç için “Görevler” bölümü tek başına yeter. Kılavuzun tanımı ve diğer belgelerle farkı için kullanım kılavuzu sözlük maddesine bak.
Örnek: bir yazılım modülünün kılavuz bölümü
Bir CRM yazılımında “Yeni müşteri kaydı açma” görevi, kılavuzda şu kadar yer kaplar:
- Müşteriler menüsüne tıkla. Görsel: menü çubuğu, Müşteriler işaretli.
- Yeni müşteri düğmesine tıkla. Görsel: sağ üstteki düğme işaretli.
- Firma adı alanına tam unvanı yaz. Görsel: alan işaretli, örnek unvan görünür.
- Vergi numarası alanına 10 haneli numarayı yaz. Uyarı: Alan yalnızca rakam kabul eder.
- Kaydet’e tıkla ve “Kayıt oluşturuldu” mesajını bekle. Görsel: mesaj işaretli.
Beş adım, tek eylem, her adımda bir görsel ve bir uyarı. İşi bir kez yapıp kaydetmek, bu beş ekran görüntüsünü ayrı ayrı alıp kırpmaktan daha kısadır.
Kılavuzda iyi bir adım cümlesi nasıl yazılır?
| Zayıf | Güçlü | Neden |
|---|---|---|
| Gerekli bilgileri gir. | Ad soyad alanına müşterinin adını yaz. | Hangi alan ve ne yazılacağı belli |
| Ayarlara git ve değiştir. | Ayarlar’ı aç, Bildirimler sekmesine tıkla. | Yol ve hedef açık |
| Kaydet ve kontrol et. | Kaydet’e tıkla. “Kayıt oluşturuldu” yazısını gör. | Tek eylem, gözlenebilir sonuç |
Genel kurallar iş talimatı nasıl hazırlanır rehberinde de var; kılavuz aynı adım mantığını kullanır, yalnız daha geniş bir kitleye yazılır.
Kullanım kılavuzu hangi biçimde verilir?
- Bağlantı: sık güncellenen yazılımlar için en rahatı; okuyan her zaman son sürümü görür.
- PDF: müşteriye teslim, e-posta eki, basılı kopya için.
- Word: kurumsal şablona yerleştirilecek ya da müşterinin değiştireceği kılavuzlar için. Ayrıntı: Word için ekran görüntülü kılavuz.
- HTML ya da Markdown: iç wiki ve dokümantasyon sitesi için.
Müşteriye bıraktığın kılavuzda ekranlarda başka müşterilerin verisi kalmamalı; paylaşmadan önce ekran görüntülerini gözden geçir.
Kayıt yoluyla hazırlanan kılavuz neyi yapamaz?
Görevlerin adımlarını çıkarır; “neden” ve “ne zaman” bölümlerini yazmaz, onları sen eklersin. Yalnızca Chrome’da, web arayüzünde yapılan işleri kaydeder; masaüstü programlar ve mobil uygulamalar için ayrı bir yöntem gerekir. Kılavuzun giriş ve sözlük bölümleri de elle yazılır. Kayıt yalnızca senin yaptığın yolu gösterir; programın başka yollarını ve ayarlarını anlatmak istiyorsan onları ayrıca kaydetmen gerekir.
Izly ile yazılım kılavuzu nasıl hazırlanır?
Izly (izly.io), tarayıcıda bir kez yaptığın işi adım adım kılavuza, sesli videoya ve aynı işi tekrar yapan kodsuz bir otomasyona çeviren bir Chrome eklentisidir. Kılavuzun “Görevler” bölümü için her görevi bir kez kaydedersin; her tıklama ekran görüntüsüyle bir adım olur, yazdığın metin de adıma işlenir. Parola alanları kaydedilmez.
Editörde metni düzeltir, ipucu, uyarı ve başlık blokları eklersin. Her görev ayrı bir rehber olur; hepsini bağlantıyla paylaşabilir, PDF alabilirsin. Word, HTML ve Markdown Pro ve Studio planlarındadır. İstersen aynı rehberden Türkçe ya da İngilizce sesli video da üretirsin. Fiyatlar.
Sık sorulan sorular
Yazılım kullanım kılavuzu mutlaka Word’de mi yazılmalı?
Hayır. Word, kurumsal şablon ya da müşterinin düzenleme ihtiyacı varsa uygundur. Sık değişen yazılımlarda paylaşım bağlantısı daha pratiktir, çünkü güncellemede herkes son sürümü görür.
Kullanım kılavuzu kaç sayfa olmalı?
Programın kapsamına bağlı. Önemli olan, okuyanın aradığı görevi hızlı bulması. Küçük bir araçta on sayfa yeter; büyük bir ürünü tek belgede anlatmak yerine görev bazlı rehberler ve bir içindekiler listesi daha kullanışlıdır.
Kılavuzdaki ekran görüntüleri ne zaman yenilenmeli?
Arayüz değiştiğinde. Hangi rehberin hangi ekranı kullandığını bilmek için kılavuzu görev bazlı küçük rehberlere bölmek işe yarar; yalnızca etkilenen rehberi yeniden kaydedersin.
Kullanım kılavuzunu müşteriye nasıl teslim etmeliyim?
Sürekli güncellenecekse paylaşım bağlantısı, imza ya da arşiv gerekiyorsa PDF ver. Müşteri belgeyi kendi şablonuna taşıyacaksa Word kullan. Teslimden önce ekranlarda başka müşterilerin bilgisi kalmadığını kontrol et.
Kullanım kılavuzu ile eğitim dokümanı aynı şey mi?
Çok yakınlar. Kullanım kılavuzu bir yazılımın görevlerini anlatır; eğitim dokümanı ise bir rolün öğrenmesi gereken işleri sıraya koyar. Pratikte ikisi de küçük, görev bazlı rehberlerden kurulur. Ayrıntı için eğitim dokümanı nasıl hazırlanır yazısına bak.
İlgili sayfalar
Bir kez kaydet, rehber kendiliğinden oluşsun
Izly ile işi tarayıcıda bir kez yaparsın. Tıklamalar ve ekran görüntüleri adım adım rehbere dönüşür; sen düzeltir, paylaşır, sesli videoya çevirir ya da bir tablonun her satırı için yeniden çalıştırırsın.