Açık, Özlü Kullanım Kılavuzu Talimatları Nasıl Yazılır?

Avatar of Author
Tanya A Mishra
on September 18, 2023 · 16 min read · filed under Product Documentation User Manual Instructions

Ödüllü ve prestijli bir dergi olan Life Is Too Short to RTFM: How Users Relate to Documentation and Excess Features in Consumer Products yedi buçuk yıl boyunca yürüttüğü bir dizi anketin raporlarını paylaşıyor. Araştırmaya göre, tüketiciler kılavuzları zamanın yalnızca %25'inde okuyor. Bunun altında yatan nedenler genellikle net olmayan ayrıntılar, sıkıcı düzenler ve biçimlendirmeler içeren etkisiz kılavuzlardır. Bu blog, tüketici dostu mükemmel bir kullanım kılavuzu yazmaya ilişkin ipuçlarını ve püf noktalarını paylaşıyor. Docsie gibi bir yazılım kullanarak, son derece iyi yazılmış bir kullanım kılavuzunu sorunsuz bir şekilde ve minimum sürede hazırlayabilirsiniz.

Bir kullanım kılavuzuna dahil edilmesi gereken temel unsurlar nelerdir?

Tüm şirketler benzersizdir. Ve aynı şekilde, hiçbir ürün birbirine benzemez. Ancak ürününüz ne olursa olsun, kullanım kılavuzunuz belirli temel unsurların özelliklerini gösterir. İster en yeni akıllı telefonu satıyor olun, ister mikrodalga fırın üreten bir şirkete sahip olun, kullanım kılavuzunuz temel bilgileri içermeli ve bunları kısa ve öz bir şekilde sunmalıdır. Kılavuzlarınızda sunabileceğiniz en iyi 12 özelliği öğrenelim.

Ne Neden
Müşterilerinizle basit bir dille konuştuğunuzda, markanızı daha erişilebilir bulurlar ve sadık kullanıcılar olarak kalmak için ilgi duyarlar. Müşteri hizmetlerinin temelinde de bu yatar.
Erişilebilirlik Belgeniz aracılığıyla kapsayıcılığı teşvik etmeye çalışın. Kılavuzlarınızı bilişsel engelleri, sınırlı işitme, görme bozuklukları vb. olan kişiler için erişilebilir hale getirin.
Mantıksal akış İçeriğinizi ilgili başlıklar ve alt başlıklar kullanarak yapılandırın. Müşterilerin ürününüze nasıl yaklaşacaklarını bilmeleri için kılavuzda mantıklı bir akış olmalıdır. Kafa karışıklığını önlemek için uygun bir başlangıç, orta ve son yapın.
Kılavuzunuzun önemli bir unsuru olan İçindekiler Tablosu, müşterileriniz için bir başlangıç noktası görevi görür. Kullanıcıları, kılavuzun tamamını okumak zorunda kalmadan belirli bilgileri bulmaları için yönlendirir.
Görseller Resimler, illüstrasyonlar, videolar vb. içeriğinizi daha canlı hale getirir. Büyük metin parçaları arasında görseller kullanarak, kılavuzunuzu daha ilgi çekici ve etkileşimli hale getirebilir ve müşterilerinizin söylemeniz gereken her şeyi anlamasını sağlayabilirsiniz.
Basitlik Basit olmak zordur. Bir kullanım kılavuzu teknik bir belgeden çok arkadaşça bir rehber gibi göründüğünde, kullanıcılar içerik miktarından korkmazlar.
Aranabilirlik Günümüzün dijital iletişim dünyasında, çevrimiçi bilgi aramaya daha yatkınız. Bu nedenle, kullanıcıların ilgili içeriği kolayca kontrol edebilmesi için belgenize aranabilirlik unsuru ekleyin.
Güzel tasarım Kılavuzlarınıza grafikler, görseller ve resimler eklerken aşırıya kaçmayın. Alanı akıllıca kullanın ve tüm parça boyunca tutarlı kalan bir renk paleti seçin. Gözlerin yorulmaması için yeterince beyaz boşluk bırakın.
Sorun çözme Kullanım kılavuzunuzun çözmeye çalıştığı soruna odaklanmasını sağlayın. Müşterilerinizin sorunlarını ele alın ve ürünün özelliklerini sıralamak yerine müşterilere nasıl fayda sağlayabileceğini gösterin.
Gerçek geri bildirim Beta test kullanıcılarından veya ürününüzü kullanma deneyimlerini paylaşabilecek bir dizi müşteriden ilk elden bilgi edinmeye çalışın. Onların geri bildirimleri üzerinde çalışın ve ilgili içerikleri hazırlayın.
Diğer kaynaklar Kullanım kılavuzunuzun sonunda, müşterilerin başvurabileceği diğer belgelere bağlantı veren bir bölüm bulundurun. Bunlar önemli web siteleri, e-posta kimlikleri, telefon numaraları vb. olabilir.
## Kullanım Kılavuzu Nasıl Yazılır?

1. Hedef kitlenizi anlayın

Yazmaya başlamadan önce kullanıcılarınızın kim olduğunu öğrenin. Sorunları, ihtiyaçları ve gereksinimleri nelerdir? Kılavuzunuzdaki talimatları hem yeni başlayanlar hem de deneyimli ürün kullanıcıları için çalışacak şekilde optimize edin. Uzmanlıklarını anlayın ve içeriğinizi eşleştirin.

2. Hedefi bilin

Belgeyi neden yazdığınızı belirleyin. Ürün özellikleriniz hakkında mı konuşmak istiyorsunuz? Ya da kullanıcılarınızın sorunları çözmesine veya sorun giderme adımlarını öğrenmesine yardımcı olmak mı? Amacınızı belirleyin ve içeriğinizi buna göre hazırlayın.

3. Ürünü tanıyın

Geliştiriciler, ürün mühendisleri vb. ile konuşarak ayrıntılı bilgi toplayın. Ürünün arka planını bilin ve doğruluğunu ve alaka düzeyini kontrol etmek için bilgileri çapraz kontrol edin. Anlayışlı sorular sorun ve kendinizi ürün kullanıcılarının yerine koyun.

4. Dili dikkatli kullanın

Herkesin anlayabileceği basit kelimeler ve ifadeler seçin. Pasif ses kullanmaktan kaçının ve birinci şahıs kullanmaktan uzak durun. Jargonu ve teknik terimleri bir kenara bırakın ve süreçleri, sistemleri ve ürün özelliklerini halk dilinde açıklayın.

5. Süreçleri tanımlayın

Süreçlerden ayrıntılı olarak bahsedin ve mümkün olduğunca açıklayıcı olun. Teknik bir yazım tarzını takip edin ancak belgeyi çok fazla bilgi ile doldurmayın. Her kelimeye önem verin ve kafa karışıklığı yaratabilecek muğlak kelimeler veya cümleler kullanmayın.

6. İlgili bölümleri ekleyin

Karmaşık problemleri sindirilebilir parçalara ayırın. İçindekiler, giriş, sıkça sorulan sorular, diğer kaynaklar vb. gibi ilgili ve uygun bölümleri ekleyin. Önemli bölümleri eklemeyi atlamamak için belgenin ana hatlarını çizin veya basit bir şablon kullanın.

7. Uygun görseller koyun

Kullanıcıları talimatlarınızı incelemeye çekmek için fotoğraf ve videolar ekleyin. Resimlerle daha fazla şey anlatın ve bunları dikkatlice yerleştirilmiş metin paragraflarıyla tamamlayın.

8. Mantıksal bir akışa sahip olun

Ne ile başlayın ve ardından ürününüzün nasıl olduğuna geçin. Ürünle ilgili temel terimleri ve ifadeleri açıklayın, özelliklerini vurgulayın ve ardından sorun giderme ve diğer kaynaklar bölümlerine gidin.

9. Net olun

Lafı dolandırmayın. Bilgi aktarın. Bunun için madde işaretleri, tablolar, akış şemaları veya diyagramlar kullanabilirsiniz. Ürün geliştiricileri, araştırma ekibi, mühendisler vb. ile iletişim halinde olarak bilgilerinizi güncel tutun.

10. Son rötuşları yapın

Yayınla düğmesine basmadan önce belgelerinizi düzeltin. Tipografik hatalar, dil sorunları, gramer tutarsızlıkları vb. olup olmadığını kontrol edin. Önemli bilgileri vurgulayarak, okunaklı yazı tipleri kullanarak ve tüm içeriği ayrı bölümlere ayırmak için başlıklar ve alt başlıklar yerleştirerek en iyi okunabilirliği sağlayın.

Bir Kullanım Kılavuzu Nasıl Yapılandırılır ve Düzenlenir?

  • Bir kullanım kılavuzunda gezinmeyi ve takip etmeyi kolaylaştırmak için organize bir yapı ve mantıksal akış oluşturmak çok önemlidir. Kılavuz, ana işlevler, bileşenler veya prosedürlerle ilgili farklı bölümler veya kısımlar halinde düzenlenmelidir. Bilgileri mantıksal bloklara ayırmak için açık, tanımlayıcı başlıklar ve alt başlıklar kullanın.

  • Ayrıntılara dalmadan önce üst düzey bir oryantasyon sağlamak için bir genel bakış veya ürün tanıtım bölümü ile başlayın. İlgili özellikleri veya görevleri bölümler halinde gruplayın - örneğin, kurulum, temel çalıştırma, sorun giderme, bakım için ayrı bölümler. Kılavuzun net ve aşamalı bir akışa sahip olması için bölümleri ve bölüm başlıklarını sırayla numaralandırın.

  • Her bölümde, bilgileri kullanım sırasına göre düzenleyin - basit veya ön adımlar daha ileri görevlerden önce gelir. Numaralandırılmış adım formatlarında açık prosedür talimatları verin. Daha iyi okunabilirlik için metni** kısa paragraflara ayırın. Yoğun metni bölmek için uygun olan yerlerde madde işaretli veya numaralandırılmış listeler kullanın.

  • Diyagramlar, akış şemaları ve adım adım grafikler ile sıraları veya iş akışlarını görsel olarak** açıklayın. İlgili olduğunda arayüz veya bileşen yakın çekimlerini gösterin. Kılavuzun tamamını okumak istemeyen sabırsız kullanıcılar için bir başlangıç veya hızlı kurulum kılavuzu hazırlamayı düşünün. Kolay gezinme ve arama için bir içindekiler tablosu, dizin sayfası ve terimler sözlüğü ekleyin. İyi organize edilmiş bir yapı kullanmak her türlü kullanıcı kılavuzunu daha tutarlı, sezgisel ve kullanıcı dostu hale getirecektir.

Bir kullanım kılavuzu oluşturmak için hangi yazılımı kullanmalıyım?

Pazar bir dizi dokümantasyon yazılımı ile doludur. Bazıları uygun fiyatlandırma planları sunarken, bazıları hiç görülmemiş özelliklerle övünüyor. Bu nedenle, etrafta bu kadar çok seçenek varken bunalmış hissetmek yaygındır. Kullanım kılavuzunuzu çevrimiçi olarak oluşturabileceğiniz, düzenleyebileceğiniz, yayınlayabileceğiniz ve paylaşabileceğiniz güvenilir yazılım ortağınız olarak Docsie'yi seçin. Docsie](https://help.docsie.io/), çeşitli kılavuz portföylerinin düzenlenmesinden birden fazla sürümün yönetilmesine kadar kullanım kılavuzu oluşturma sürecinizi hızlandırmak için mükemmel bir yazılımdır!

Faydalı özellikler:

  • Platform, tüm belgelerinizi düzenli tutmanıza yardımcı olur, böylece hedef kullanıcılarınızla paylaşmanız gereken belgeyi kolayca tespit edebilirsiniz.

  • Raflar özelliği, kılavuzun aradığınız bölümünü bulmanızı sağlar.

  • Sürüm kontrolü sayesinde belgenizde daha önce yapılan düzenlemeleri kontrol edebilirsiniz.

  • Çeviri özelliği, içeriğinizi otomatik olarak hedeflenen dile çevirir.

  • Görevleri tanımlayabilir, iş akışlarını listeleyebilir ve anlaşılır bir belge sunabilirsiniz.

  • Kurum içi tasarım ekibiyle işbirliği, markayla uyumlu kullanıcı kılavuzları oluşturmanıza yardımcı olur.

  • Tek bir düğmeye tıklayarak sorunsuz yayıncılığın keyfini çıkarın.

Anahtar avantajlar:

  • Tüm belgeleri farklı erişilebilirlik düzeyleriyle tek bir yerde barındırır.

  • Ürünle ilgili belgeleri yayınlamak ve sürdürmek için harcanan zaman ve çabayı azaltır.

  • Temiz ve sezgisel kullanıcı arayüzü dokümantasyonu kolay ve süper hızlı hale getirir.

  • Birden fazla sürümün tutulması, kolay düzenleme ve işbirliğine yardımcı olur.

  • Anlaşılması kolay, işe alımı sorunsuz hale getirir.

Bir kullanım kılavuzunu takip etmesi ve anlaması kolay hale getirmenin en iyi yolu nedir?

  • Herhangi bir kullanım kılavuzunun en önemli yönü, talimatları takip etmesi ve anlaması kolay hale getirmektir. Aşırı teknik jargondan veya ürüne özgü kafa karıştırıcı terminolojiden kaçınan basit, açık bir dil kullanın. Kısa, anlaşılır cümleleri aktif sesle yazın.

  • Kullanıcıların kavramları anlaması için yeterli ayrıntı ve açıklama sağlayın, ancak basit eylemleri fazla açıklamayın. Kullanıcıların gözünü korkutmak yerine kendilerini rahat hissetmelerine yardımcı olmak için samimi ve sohbet havasında bir ton kullanın. Farklı şekillerde yorumlanabilecek muğlak ifadelerden kaçının.

  • Arayüz öğelerine, düğmelere ve menü öğelerine atıfta bulunmak için tutarlı terimler kullanın. Kullanımı görsel olarak göstermek ve açıklamaları güçlendirmek için ekran görüntüleri ve diyagramlar ekleyin. Yalnızca metin açıklamalarına güvenmek yerine ürünün her adımda nasıl göründüğünü gösterin.

  • Talimatları her adımda farklı eylemler içeren numaralandırılmış adım formatlarında biçimlendirin. Daha iyi okunabilirlik** için bilgileri kısa paragraflara bölün. Yoğun metin bloklarını önlemek için kalın başlıklar, madde işaretleri, numaralandırılmış listeler ve bol miktarda beyaz boşluk kullanın.

  • Kullanıcıların belirli görevlerden önce önkoşulları tamamlaması gerekiyorsa rehberlik sağlayın. Kullanıma yardımcı olmak için ipuçları, kısayollar veya öneriler verin. Potansiyel olarak zararlı eylemlerden önce uyarılar veya dikkat bildirimleri ekleyin.

  • Uzun veya karmaşık prosedürlerden sonra anahtar çıkarımları veya hatırlatıcıları özetleyin. Kılavuzu net hiyerarşiler ve navigasyon ile yapılandırarak göz gezdirmeye izin verin. İzleyicinin bilgi düzeyine göre uyarlanmış iyi yazılmış bir kullanım kılavuzu, ustalığa giden en basit yolu sunar.

Hangi grafikler, ekran görüntüleri veya görseller kullanım kılavuzlarını iyileştirmeye yardımcı olur?

  • Ürün özelliklerini göstermek, karmaşık süreçleri açıklamak ve anlayışı geliştirmek için kullanım kılavuzlarında Görseller çok değerlidir. Ekran görüntüleri, kullanıcılara ürün arayüzünün tam olarak nasıl göründüğünü göstermek ve metin talimatlarını güçlendirmek için gereklidir. Menü seçeneklerini, düğme tıklamalarını, giriş alanlarını, bildirimleri vb. ortaya çıkarmak için prosedürler sırasında önemli aşamaların ekran görüntülerini yakalayın.

  • Önemli alanları vurgulamak ve kullanıcıların dikkatini yönlendirmek için ekran görüntülerini** belirtme çizgileri, metin etiketleri ve oklarla notlandırın. Görüntülerin ayrıntıları gösterecek kadar büyük olduğundan ve netlik için optimize edildiğinden emin olun. Adımlarda atıfta bulunurken düğmelerin veya ayarların yakın çekimlerini ekleyin.

  • Diyagramlar, örneğin tel kafesler ve akış şemaları, ilişkileri ve iş akışlarını görselleştirir. Patlatılmış görünümler tek tek bileşenleri detaylandırır. İnfografikler istatistikleri veya verileri yaratıcı bir şekilde temsil eder. Fotoğraflar ekipman kurulumunu gösterir. Simgeler uyarıları, ipuçlarını, notları vb. grafiksel olarak gösterir. Kavramları açıklamak veya görsel ilgi eklemek için eskiz tarzı illüstrasyonları düşünün. Grafikler ve tablolar karmaşık bilgileri bir bakışta düzenler.

  • Grafikler maksimum netlik ve görsel etki için profesyonelce tasarlanmalıdır. Görseller arasında tutarlı ikonografi ve renk kodlaması kullanın. İlgili, yüksek kaliteli grafikler yalnızca yoğun metni bölmekle kalmaz, aynı zamanda talimatların anlaşılmasını ve hatırlanmasını da geliştirir.

Ancak, kılavuzu aşırı, ilgisiz veya kötü uygulanmış görsellerle dağınık hale getirmekten kaçının. Görseller metni tamamlar ancak temel mesajdan uzaklaştırmamalıdır. Yalnızca içeriği doğrudan destekleyen grafikler kullanın. Görsellerin etrafında yeterli beyaz alan olması okunabilirliği artırır. Göz alıcı ancak minimalist bir yaklaşımla, net grafikler kullanıcı kılavuzlarını daha ilgi çekici ve öğretici hale getirir.

Bir kullanım kılavuzu ne kadar ayrıntılı ve kapsamlı olmalıdır?

Kullanıcı kılavuzlarını oluştururken doğru ayrıntı düzeyini belirlemek dengeleyici bir eylemdir. Çok az bilgi, kullanıcıların kafasının karışmasına ve ürünü düzgün bir şekilde kullanamamasına neden olur. Ancak aşırı ayrıntı, kılavuzları hantal, sıkıcı ve kullanımı zor hale getirebilir.

  • Kullanıcıların görevleri güvenli ve etkili bir şekilde tamamlamaları için gereken asgari talimatları sağlamaya odaklanın. Kavramsal arka plan için genel açıklamalar yapın, ancak doğrudan ilgili olmadıkça derinlemesine teori veya teknik ayrıntılardan kaçının.

  • Kullanıcıların** ayarları yapılandırmak, özellikleri çalıştırmak ve bakım yapmak için atması gereken her adımı açıklayın. Bilgi sahibi olduğunuzu varsaymayın veya bariz görünen adımları atlamayın. Ancak basit noktaları tekrarlamayın.

  • Kapsamlı ve özlü arasındaki tatlı noktayı bulun. Kısa ve öz ifadeler kullanın ve gereksiz ayrıntıları atlayın. Kısalık için tutarlı terminoloji kullanın. Karmaşık süreçleri netleştirmek için gerektiğinde seçici olarak genişletilmiş açıklamalar sağlayın.

  • Uzun pasajlardan kaçınmak için metni görsellerle destekleyin. Uzun prosedürlerden sonra önemli çıkarımları özetleyin. Kullanıcıların ayrıntılara kolayca başvurabilmesi için bir dizin, sözlük ve içindekiler tablosu ekleyin.

  • İçeriği farklı kullanıcı türleri için birden fazla kılavuzda bölümlere ayırmayı düşünün, örneğin yeni başlayanlar ve ileri düzey kullanıcılar gibi. Ya da genel kullanım talimatlarını derinlemesine teknik özelliklerden ayırın.

  • Kılavuzların** eksiksiz olması gerekirken, çok fazla bilgi ters etki yaratabilir. Gerçek kullanıcıların ihtiyaçlarını hedefleyin ve her yönü kapsamlı bir şekilde belgelemeye çalışmak yerine yinelemeli taslak hazırlama, kullanıcı testi ve geri bildirim yoluyla dengeyi bulun. Uyarlanmış bir yaklaşım, gerçek kullanılabilirlik için yeterli ancak sıkı bir şekilde odaklanmış içeriğe sahip kılavuzlar üretir.

Bir kullanım kılavuzunun bölümleri ve kısımları arasında tutarlılığı nasıl sağlarım?

Bir kullanıcı kılavuzunda kullanılan format, ton, terminoloji ve stilde tutarlılığı korumak, tutarlı bir kullanıcı deneyimi için çok önemlidir. Tutarlı bir kılavuz, kullanıcıların kafa karışıklığı veya dikkat dağınıklığı olmadan bilgileri kolayca bulmalarını ve özümsemelerini sağlar.

Baştan sona aynı belge yapısını kullanın ve bölümler, başlıklar, sayfalar, şekiller, ve tablolar için tek tip numaralandırma şemaları kullanın. Metin stilleri, girintiler ve satır aralıkları gibi biçimlendirme öğelerini tutarlı tutun.

Arayüz öğelerine, bileşenlere, düğmelere, menü öğelerine vb. atıfta bulunmak için özdeş terminoloji kullanın. Asla farklı terimleri veya etiketleri birbirinin yerine kullanmayın. İster öğretici, ister konuşmaya dayalı veya resmi olsun, sabit bir ton kullanın.

Aynı cümle yapılarını kullanarak ve pasif ve aktif ses arasında ani dalgalanmalardan kaçınarak yazma stilini tekdüze tutun. Ani değişimler olmadan benzer cümle uzunlukları ve kelime bilgisi seviyeleri kullanın.

Notlar, ipuçları, uyarılar, bildirimler** vb. için aynı stili uygulayın. Talimatları tutarlı bir numaralandırılmış adım düzeninde biçimlendirin. Simgeler, ekran görüntüleri ve diyagramlar gibi görselleri standartlaştırın. Bölümleri, kısımları, şekilleri, tabloları ve başlıkları tutarlı bir numaralandırma/adlandırma sistemiyle çapraz referanslandırın. Tekdüzeliği güçlendirmek için stil kılavuzları, şablonlar veya makrolar oluşturun ve kullanın.

Her ne kadar ayrı bölümler farklı işlevleri hedeflese de, kılavuz birleşik bir belge olarak okunmalıdır. Tutarlılık profesyonelliği çağrıştırır ve net kullanıcı beklentileri belirleyerek kullanılabilirliği destekler. Ancak tutarlılık açıklığın önüne geçmemelidir - daha iyi anlama ve öğrenme için kesinlikle gerekli olduğunda format bozulabilir.

Okunabilirlik için bir kullanım kılavuzundaki metni, yazı tiplerini, düzeni nasıl biçimlendirmeliyim?

  • Bir kullanım kılavuzundaki metin, yazı tipleri ve düzen biçimlendirmesi, optimum okunabilirlik için dikkatli bir değerlendirme gerektirir.

  • Tutarlı biçimlendirme kuralları kullanarak temiz, iyi yapılandırılmış bir düzen hedefleyin. Satır sonları, boşluklar ve madde işaretleri kullanarak yoğun paragraflardan ve metin bloklarından kaçının. Başlıklar ve alt başlıklar kullanarak içeriği mantıksal bölümler halinde düzenleyin.

Gövde metni için 10-12 punto büyüklüğünde Arial, Times New Roman veya Calibri* gibi standart bir profesyonel yazı tipi kullanın. Başlıklar için ayrılmış süslü yazı tiplerinden kaçının. Vurgu için kalın veya italik yazıları idareli kullanın.

  • Metnin sıkışık hissettirmemesi için yeterli satır aralığı ve kenar boşlukları sağlayın. Satır uzunluğunu 50-60 karakterle sınırlayın. Metni sola hizalayın. Yazı tiplerinin ve boyutlarının başlıklar, gövde metni, başlıklar, uyarılar vb. arasında tutarlı olduğundan emin olun.

  • Talimatları takip edilmesi kolay adımlara bölmek için numaralı veya madde işaretli listeler kullanın. Tablolar karmaşık verileri verimli bir şekilde düzenler. Simgeler ve uyarı etiketleri gövde metninden ayrılır. Yazı tipi çeşitlerinin stratejik kullanımı görsel hiyerarşi ekler.

  • Okunabilirlik için büyük harf bloklarını, altını çizme ve ünlem işaretlerini** en aza indirin. Ana bölümler arasında sayfa sonlarını özenle kullanın. Sayfaları numaralandırın ve üstbilgi ve altbilgi ekleyin.

  • Biçimlendirme, kesintisiz okuduğunu anlamayı kolaylaştırarak kullanıcının gözünden kaybolmalıdır. Hizalama, boşluklar ve görsel akış, önemli bilgilerin net bir şekilde ortaya çıkmasını sağlar. Temiz, iyi biçimlendirilmiş bir düzen, kılavuzun kullanılabilirliğini ve eğitici değerini artırır.

Bir kullanım kılavuzu yazarken hangi tonu ve dili kullanmalıyım?

  • Bir kullanım kılavuzunda kullanılan ton ve dil, profesyonellik ile ulaşılabilirlik arasında denge kurmalıdır. Doğruluğu korurken aşırı teknik jargondan kaçınmak talimatların açık ve erişilebilir olmasına yardımcı olur. Kullanıcının ihtiyaçlarına odaklanan basit, anlaşılır bir dil kullanın. Kavramları net bir şekilde açıklayın ve aktif ses ve olumlu emir kipleri ("Güç düğmesine basın") kullanarak adım adım rehberlik sağlayın.

  • Konuşmaya dayalı, samimi bir ton kullanın. Okuyucuya doğrudan hitap etmek için sık sık "siz" ifadesini kullanın. Sadece komutlar vermek yerine yardımcı bir eğitmen olarak ipuçları ve rehberlik sağlayın. İlk kullanımda gerekli terimleri, kısaltmaları ve model numaralarını tanımlayın. Referans için bir terimler sözlüğü sağlayın. Karmaşık teknik kavramları açıklarken açıklayıcı analojiler veya metaforlar kullanın.

  • Teknik şartnameleri kolayca sindirilebilir talimatlara** çevirmek beceri gerektirir. Gereksiz ayrıntıları atlayın ancak aşırı basitleştirmekten kaçının. Tutarlı ifadeler kullanın ve açıklamaları görsellerle güçlendirin.

  • Okuyucuya saygılı bir şekilde hitap edin. Patronluk taslayan veya hakaret içeren** bir dil kullanmaktan kaçının. Yaş, cinsiyet, kültür, yetenekler vb. ile ilgili kapsayıcı ve profesyonel bir üslup kullanın.

  • Yanlış veya muğlak terminoloji kullanıcıları hayal kırıklığına uğratırken, açık iletişim güçlendirir. Olası yanlış anlamaları veya olumsuz çağrışımları ortadan kaldırmak için ifadeleri dikkatlice gözden geçirin. Mümkün olduğunda gerçek kullanıcılardan geri bildirim alın.

  • Uygun ton ve dil ile bir kılavuz korkutucu olmaktan ziyade davetkar bir his verir. Net açıklamalar, stil ile birleştiğinde kullanım kılavuzunun etkinliğini en üst düzeye çıkarır.

Bir kullanım kılavuzunun güvenlik uyarılarını ve feragatnameleri kapsadığından nasıl emin olabilirim?

  • Kullanım kılavuzları** riskleri en aza indirmek için okuyucuları olası güvenlik tehlikeleri ve ürünlerin doğru çalışması konusunda uyarmalıdır. Güvenlik bilgilerinin açık bir şekilde iletilmesi hem kullanıcıyı hem de üreticiyi korur.

  • Yüksek gerilime maruz kalma, hareketli parçalar, kimyasal etkileşim, yüksek çalışma sıcaklıkları vb. gibi tehlikeli eylemlerden önce güvenlik uyarılarını ekleyin. Tehlikeleri vurgulamak için "Uyarı" veya "Dikkat" gibi işaret sözcükleri kullanın.

  • Güvenli olmayan uygulamalardan kaynaklanan olası yaralanma veya hasarı açıklayın. Güvenli çalışma için kesin talimatlar sağlayın. Varsa, gerekli koruyucu donanımları veya çevresel koşulları listeleyin.

  • Dikkat çekmek için uyarı sembolleri veya simgeleri gibi görsel uyarılar kullanın. Kontrast renkte kalın, büyük harfler de uyarıları vurgular. Tehlikeler için tutarlı, özel biçimlendirme manuel taranabilirliği artırır.

  • Kullanıcıları güvenlik bölümlerini tamamen okumaları konusunda bilgilendirin ve gerektiğinde eğitim sertifikası sağlayın. Yaralanmaları önlemek için düzenli ekipman denetimi ve bakımını tavsiye edin. Uygunsa, kullanıcı sağlığı için ergonomik en iyi uygulamaları önerin.

  • Eğitimli profesyonellere karşı tüketiciler** gibi çeşitli kullanıcı grupları için güvenlik önlemlerini belirtin. Küresel kitleler için uyarı çevirmenlerini veya piktogramları göz önünde bulundurun. Tüm güvenlik iletişimi oldukça görünür, açık ve görsel ipuçlarıyla desteklenmiş olmalıdır.

  • Güvenlik yönergelerine** ek olarak, hasarı önlemek için uygun ekipman kullanımını da belirtin ve kullanıcılara kılavuzu okumalarını söyleyin. Aşırı feragatnameler odaklanmayı zayıflatırken, tehlikelerin vurgulanması yaratıcıların kullanıcı refahı için endişe duyduğunu gösterir. Açık güvenlik iletişimi sorumluluğu en aza indirir ve profesyonel itibarı artırır.

Kullanım kılavuzları basılmalı mı yoksa dijital olarak mı sunulmalı?

  • Kullanıcı kılavuzları basılı ya da dijital formatlarda sunulabilir ve her birinin kendine özgü artıları ve eksileri vardır. Şirketler basılı ve elektronik kılavuzlar arasında karar verirken kullanıcıların ihtiyaçlarını ve ürün karmaşıklığını göz önünde bulundurmalıdır.

  • Baskılı kılavuzlar cihaz olmadan kolay işe alım ve hızlı referans sağlar. Doğrusal adım adım rehberlik gerektiren kurulum, çalıştırma ve bakım talimatları için idealdirler. Baskı ayrıca pil/ekran sınırlamalarını da ortadan kaldırır.

  • Bununla birlikte, baskı israflı, maliyetli ve güncellenmesi zor olabilir. Elektronik kılavuzlar kaynakların korunmasına yardımcı olur ve çevrimiçi olarak ucuza dağıtılabilir. Kolayca arama yapılabilir ve video eğitimleri gibi multimedya içerebilirler.

  • Dijital formatlar masaüstü veya mobil cihazlarda teknik özelliklere, sorun giderme, nasıl yapılır veya referans bilgilerine sıralı olmayan bir şekilde erişmek için uygundur. Ancak uzun süreli ekran okuma yorgunluğa neden olur. Dijital erişim internet bağlantısına ve güce dayanır.

  • Görselliği yüksek kılavuzlar için baskı, görüntü kalitesini ve netliği en üst düzeye çıkarır. Ancak elektronik kılavuzlar ayrıntılar için yakınlaştırma olanağı sağlar. Optimum sayfa boyutu, ciltleme, yönlendirme ve kağıt ağırlığını belirlerken kullanılabilirliği göz önünde bulundurun.

  • Baskı tercih ediyorsanız, her zaman, her yerden erişim için dijital bir versiyon da sağlayın. Elektronik dağıtım için duyarlı HTML gibi kullanıcı dostu yazılım formatlarını seçin. PDF'ler biçimlendirmeyi korur ancak aramayı sınırlar.

  • İdeal olarak, hem basılı bir hızlı başlangıç kılavuzu hem de kapsamlı bir e-kılavuz sunun. Basılı, dijital veya her iki formatın da en uygun olup olmadığını belirlemek için kullanıcı ihtiyaçlarını, ürün türünü ve görev türlerini değerlendirin. İkili dağıtım yaklaşımı, kılavuzların kullanılabilirliğini ve faydasını en üst düzeye çıkarır.

Anahtar Çıkarımlar:

  • İyi bir kullanım kılavuzu çeşitli faktörlere bağlıdır. Basit bir dile, dikkat çekici görsel unsurlara ve mantıksal, hiyerarşik bir yapıya** sahip olmalıdır. Şirketler yalnızca belirli konuları içermeli ve bunları kısa ve öz bir şekilde sunmalıdır, böylece müşteriler bunalmaz veya içeriği gözden geçirmeyebilir.

  • Kılavuzu yazmadan önce içerik, biçimlendirme ve yapıyı tasarlayın. Güvenilir bir yazılım platformu kullanın ve müşterilerinize aktarmanız gereken her şeyi belgeleyin. Belgelerinizi çevrimiçi yayınlamak için Docsie'yi seçin ve ekip üyelerinize erişim izni verin, böylece parça üzerindeki yorumlarını düzenleyebilir ve paylaşabilirler.

  • Bir kullanım kılavuzu müşterileriniz için ilk temas noktası görevi görür. Ürünle ilgili tüm bilgileri ve ürün bakımı ile kaçınılması gereken hususlara ilişkin kilit bölümleri içermelidir. Kullanıcı kılavuzları, ürünün sorun giderme, sık sorulan sorular, ürün işlevselliği vb. tüm yönlerini kapsamalıdır.

  • Karmaşık kavramları açıklarken teknik jargondan** kaçının. Anlaşılması kolay basit bir dil kullanın. Ürününüzle ilgili tüm kavramları basit kelimeler kullanarak açıklayın. Grafikleri, iş akışlarını ve diyagramları yalnızca mevcut içeriğe katkıda bulunduklarında ekleyin ve bunları içerikle bağlantılı olarak açıklayın.

  • Ürününüz hakkında korkutucu teoriler paylaşmaktan uzak durun. Yararlı, pratik ayrıntılar verin ve müşterilerin her şeyi bildiğini varsaymayın. Net olun, ekstra ve gereksiz bilgilerden kaçının ve yalnızca gerekli olanları paylaşın. Kullanım kılavuzunuzun tüm bölümlerinin ton, stil, biçimlendirme, terminoloji vb. açısından tutarlılığı koruduğundan emin olun.

Son Düşünceler

Kullanım kılavuzları yazmak hem bir bilim hem de bir sanattır. Müşterilerinizin psikolojisini anlamanız ve anlaşılması kolay kullanım kılavuzlarını kapsamlı bir dille yazmanız gerekir. Yararlı ve etkili kullanım kılavuzları satış sonrası hizmetin daha iyi olmasını ve sonuç olarak daha fazla müşteri memnuniyetini sağlar.

Docsie](https://www.docsie.io/) ile kolayca çevrimiçi bir kullanıcı kılavuzu oluşturabilir ve bunu düzenlemek, çevirmek, yayınlamak, bakımını yapmak ve kullanıcılarınızın kullanımına sunmak için ekibinizle paylaşabilirsiniz. Docsie, tüm dokümantasyon ihtiyaçlarınızı anlayan ve basit ama güçlü çevrimiçi kılavuzlar yazmayı kolay bir yürüyüş haline getiren mükemmel bir çözümdür.

Sıkça Sorulan Sorular

**1. Bir kullanım kılavuzunun en önemli özelliği nedir?

Ans: Her şeyin ötesinde, kullanım kılavuzları basit ve takip etmesi kolay olmalıdır. İçerik ve format, müşterilerin kolaylıkla takip edebilmesi ve açıklanan sürecin her adımını anlayabilmesi için kullanıcı dostu bir şekilde hazırlanmalıdır.

**2. Kullanım kılavuzları neden önemlidir?

Ans: Kullanım kılavuzları, müşterilerin ürünü kullanmadan önce ürün hakkında eksiksiz bilgi edinmesini sağlar. Kılavuzlar, ürünün kullanım ömrünü etkilemeden etkin bir şekilde kullanılabilmesi için ürünün detaylı özelliklerinden bahseden ve nasıl kullanılacağına dair ipuçları paylaşan zengin bir kaynaktır.

**3. Kullanım kılavuzlarının amacı nedir?

Ans: Bir kullanım kılavuzunun birincil amacı belirsizliği ortadan kaldırmak ve tüketicilerin bir ürün hakkında daha fazla bilgi sahibi olmalarına ve ürünü nasıl kullanacaklarını öğrenmelerine yardımcı olmaktır. Müşterilerin satın aldıkları üründen en iyi şekilde nasıl yararlanacaklarına dair somut talimatlar içeren bir içeriktir.

**4. Kullanım kılavuzu dokümantasyonu ile ne kastedilmektedir?

Ans: Kullanım kılavuzu dokümantasyonu, şirketlerin sorunlarını çözmek ve ürünle daha başarılı olmalarına yardımcı olmak için hedef kitleleriyle paylaştıkları içeriğin hazırlanmasını ifade eder. Bu, kullanıcıların ürünlerini kullanırken yapılması ve yapılmaması gerekenleri anlamalarına yardımcı olan bir tür kılavuzdur.

**5. Kullanım kılavuzu ne tür bir belgedir?

Ans: Oldukça teknik bir belgedir. Temel bilgileri sağlamaya odaklanır ve ayrıca müşterilere ürünleri en iyi şekilde kullanabilmeleri ve bakımını yapabilmeleri için rehberlik eder.


Subscribe to the newsletter

Stay up to date with our latest news and products