İçerik

• Adım atmak
• Bölüm 1/4: Kullanıcı el kitabınızın planlanması
• Bölüm 2/4: Temel bilgileri yerleştirin
• Bölüm 3/4: Ürün bakımını açıklama
• Bölüm 4/4: Okunabilir bir kılavuz yazın
• İpuçları

Yazılım, bilgisayarlar, oyunlar ve cihazlar kullanım kılavuzları gerektirir; ürünün nasıl kullanılacağını (ve nasıl kullanılmayacağını) açıklayan kılavuzlar. Kullanım kılavuzu, belirli bir yapıya sahip resmi bir belgedir ve teknik bir yazar veya ürün tasarımcısı gibi ürünü baştan aşağı bilen biri tarafından yazılmalıdır. Etkili bir kullanım kılavuzu yazmak, ürünü kimin kullanacağını bilmenizi ve kılavuzu bu kullanıcıları göz önünde bulundurarak yazmanızı gerektirir. Sorunsuz bir kullanıcı deneyimi sağlamak için yazınızı net, kesin ve basit tutun.

Adım atmak

Bölüm 1/4: Kullanıcı el kitabınızın planlanması

1. Bir kullanıcı analizi yapın. Kullanım kılavuzu, ürününüzü veya hizmetinizi satın alacak ve kullanım kılavuzunu okuyacak kullanıcılar için yazılmalıdır. Bir kullanıcı analizi, ana veya hedef kitlenizin kim olacağını size söyleyecek ve metnin yazımında size rehberlik edecektir.
   • Cihazınızı kullanacak kişilerle konuşun. Kontrollü koşullar altında test kullanıcılarına cihazın prototiplerini ve taslak kullanıcı kılavuzunu sunun. Bu test kullanıcılarından, kullanım kılavuzundaki belirsiz veya kafa karıştırıcı şeyler hakkında geri bildirim isteyin ve bu geri bildirime göre kullanım kılavuzunuzda değişiklikler yapın.
   • Asla tüm hedef kitlenizi tatmin edemezsiniz; Hedef kitleye veya en geniş kitleye özel hazırlanmış kılavuzu yazın.
   • Yaş, sağlık (herhangi bir hastalıkları, öğrenme güçlükleri veya engelleri var mı?) Ve kullanıcı kılavuzunu yazmak için en iyi yaklaşımı belirlemek için dinleyicilerin eğitim düzeyini göz önünde bulundurun.
2. Kullanım kılavuzunun tasarımını koordine edin. Cihazı veya ürünü tasarlamaya ve geliştirmeye yardımcı olan ekibin bir parçasıysanız, nasıl çalıştığını açıklamak için ürüne objektif bir şekilde bakmak zor olabilir. Bu nedenle, kullanım kılavuzunu hazırlamanıza yardımcı olması için bir yazar (tercihen talimat yazma deneyimi olan biri) ve bir grafik tasarımcıdan tavsiye almalısınız. Bu kişileri harici bir danışmanlık aracılığıyla veya kendi şirketiniz veya kuruluşunuzdan seçebilirsiniz.
3. Bir görev analizi yapın. İş analizi, cihazı kullanmak için gerekli adımları tanımlama ve düzenleme sürecidir. Kapsamlı bir iş analizi, her adım için gerekli olan malzeme ve ekipmanı (piller, ilaçlar veya kullanıcı tarafından sağlanan diğer ürünler gibi) ve her adımın gerektirebileceği eylemleri, hataları ve sorun giderme önerilerini tanımlar.
   • Birçok farklı görevi veya alt görevi gerçekleştirebilen bir ürününüz varsa, her görev için bir görev analizi yapmanız gerekir. Örneğin: bir arabada korna çalabilir, kemerinizi bağlayabilir ve farlarınızı açıp kapatabilirsiniz. Gerekirse bunların her biri için bir iş analizi yapın.
4. Ürününüzün etiketleme ve pazarlama izni gereksinimlerini karşıladığından emin olun. Bu gereksinimler, ürünlerin kullanıcının güvenliği göz önünde bulundurularak üretildiğini ve kullanıcının radyasyon ve elektrik çarpması gibi tehlikeli koşullara maruz kalmasının sınırlı olmasını sağlar. Reklamlar, bir ürünün amacını ve temel çalıştırma yönergelerini açıkça belirtmeli ve bu kaynakları kullanıcı el kitabınızı yazarken kullanmalısınız.
   • Bir ürünün kullanım kılavuzunun etkili olabilmesi için doğrudan ürüne yapıştırılan etiketlere uygun olarak yazılması gerekir.
   • Kullanım kılavuzunu yazmadan önce cihazınızın resmi olarak satış lisansına sahip olduğundan emin olun.
5. Kılavuzunuzun düzenine karar verin. Kılavuzunuzu düzene koymanın birkaç önemli yolu vardır. Her bölümün başına her kelimesi büyük harflerle kalın bir başlık koymalısınız. Örneğin, "Cihazınızı kurun", "Cihazınızı çalıştırın" ve "Sorun Giderme" bölümlerinin tümü kalın bölüm başlıkları olabilir.
   • Kılavuzunuzu düzene koymanın bir başka yolu da, biri metinle sağda ve diğeri metnin hemen solunda, madde işaretleri, sayılar veya uyarı işaretleri veya kırmızı ünlem işaretleri gibi küçük simgeler içeren iki sütun kullanmaktır.
   • Kılavuz, esas olarak, cihazı açıklamak için her görüntünün altında bazı metinler bulunan resimlerden oluşabilir veya yalnızca birkaç resimle birlikte metin olabilir. Kullanıcıya rehberlik etmesi için bir akış şeması da kullanabilirsiniz. Ürününüzü ve her yöntemin el kitabınızı yazmanıza nasıl yardımcı olabileceğini düşünün. Ancak, tek bir kılavuzda farklı düzenleri karıştırmaktan kaçının. Birini seçin ve ona bağlı kalın.

Bölüm 2/4: Temel bilgileri yerleştirin

1. Kılavuzu mantıksal olarak düzenleyin. Kılavuz, kullanıcının en fazla faydayı sağlayacağı şekilde yapılandırılmalıdır. Kılavuzu, ürünün kullanımı açısından anlamlı olan bölümlere veya bölümlere ayırın ve her bölümün hızlı bir şekilde bulunabilmesi için kılavuzun ön kısmına bir içindekiler tablosu ekleyin.
   • Daha uzun kılavuzlar için özellikle içindekiler tablosu gereklidir.
   • Hedef kitlenizin aşina olmayabileceğini açıklayan birçok terim varsa bir sözlük veya dizin gereklidir. Ancak, bir sözlük önerilmemektedir; en iyi seçenek, kılavuzun metnindeki kafa karıştırıcı terimleri açıklamaktır. Bir sözlük eklemeyi seçerseniz, kılavuzun önüne, içindekiler tablosunun hemen sonrasına yerleştirin.
   • Bir tablo veya şekil listesi, yalnızca kılavuzda birkaç tablo veya şekilden fazlası varsa gereklidir.
   • Akışı ve odaklanmayı bozacağı için açıklanması gereken ancak kılavuzun başka bir yerinde açıklanamayan şeyler için bir ek gereklidir.
2. Gerekli uyarıları ekleyin. Genel uyarılar veya önlem bilgileri, ölüm veya ciddi yaralanma dahil olmak üzere ürünün uygunsuz kullanımından kaynaklanan olası tehlikeler hakkında bilgi sağlamalıdır. Bu uyarılar, kılavuzun en önüne, ön sayfadan sonra, kullanıcının önce görmesi için yerleştirilmelidir. Kılavuz metnine, potansiyel olarak tehlikeli bir adımın önerilmesinden hemen önce veya hemen önce özel uyarılar da dahil edilmelidir.
   • Örneğin, elektrikli bir cihaz için genel bir uyarı, onu yağmur yağarken kullanmamak olabilir.
   • Cihazı prize takmadan önce hem ellerinizin hem de cihazın kuru olduğundan emin olmak özel bir talimat olabilir.
   • Uyarıyı IFU'daki geri kalan talimatlardan ayırmak ve kullanıcıların dikkatini buna çekmek için görüntüler (kafatası ve çapraz kemikler gibi) veya farklı bir renkte metin (kırmızı metin gibi) sağlayın.
3. Cihazı tanımlayın. Açıklamanız, hem cihazın amacının yazılı bir açıklamasını hem de cihazın neye benzediğini gösteren küçük bir grafik gösterimini içermelidir. Şekil, cihazda bulunan tüm anahtarları, düğmeleri ve takılabilir parçaları etiketlemeli ve adlandırmalıdır.
4. Kurulum talimatlarını sağlayın. Kurulum bölümü, ürünü veya cihazı kullanmaya nasıl hazırlanılacağına ilişkin temel bilgileri içermelidir. Cihaz bir ev kullanıcısı tarafından yapılamaz veya kurulamazsa, bunu kurulum bölümünün üst kısmında kalın bir başlıkta açıkça belirtin. Aşağıdakileri de eklemelisiniz:
   • Parça listesi
   • Paket Açma Talimatları
   • Kurulum uyarıları
   • Yanlış kurulumun sonuçları
   • Kurulum sırasında zorluk çıkması durumunda kimi arayacak
5. Operasyon hakkında bilgi verin. Bu bölüm, kullanıcı kılavuzunun en önemli bölümüdür ve cihazın nasıl kullanılacağına dair somut, ayrıntılı bilgiler sağlamalıdır. Güç kablosunu takmak veya ellerinizi yıkamak gibi üniteyi kullanmak için temel hazırlıklarla başlayın. Cihazın nasıl kullanılacağını açıklayan mantıksal, numaralandırılmış adımların yanı sıra kullanıcının cihazı doğru kullandığında bekleyebileceği herhangi bir geri bildirimle (örneğin, "Bir tıklama duyacaksınız ...") devam edin.
   • Bu bölümün sonunda, hızlı bir şekilde açıklanamayan sorunları çözmek için kullanıcılara sorun giderme bölümüne başvurulmalıdır.
   • Görüntüleri gerekli yerlere yerleştirin. Bazı adımlar en iyi şekilde hem resimlerle hem de sözcüklerle açıklanır. Kılavuzunuzdaki fotoğrafları veya çizimleri kullanmayı düşünün.
   • Bu bölümde, herhangi bir bölümde olduğu gibi, uygun olmayan kullanım veya çalıştırma ile ilgili güvenlik uyarılarına yer vermelisiniz. Örneğin, motorlu testere kullanıcılarını bazı ilaçları kullanırken alkol içmemeleri veya motorlu testereyi kullanmamaları konusunda uyarabilirsiniz.
   • Kullanıcıların fayda sağlayacağını düşünüyorsanız, cihazın doğru kullanımını ve çalışmasını gösteren çevrimiçi videolara bağlantılar eklemeyi düşünün. Bu videoları ya bu bölümün başında ya da (yalnızca bir adımı gösteren videolar durumunda) her adımın sonunda kaydedebilirsiniz.
6. Sonuna ürünün bir özetini ekleyin. Özet, temel çalıştırma adımlarını sağlamak için kılavuzun sonunda, dizinden hemen önce görünmelidir. Bu, operasyonel bilgilerin basitleştirilmiş, sadeleştirilmiş bir versiyonu olmalı ve birden fazla sayfa olmamalıdır. Cihazın veya ürünün nasıl kullanılacağını özetleyin. Temel uyarıları, ürünün nasıl kullanılacağını açıklayan numaralı adımları ve kullanıcıları yardıma yönlendiren telefon numaralarını veya e-posta adreslerini ekleyin.
   • Kullanıcının özet sayfasını sık sık kaldırmasını veya buna başvurmasını bekliyorsanız, kullanıcının taşımasını ve bakmasını kolaylaştırmak için çıkarılabilir bir lamine kart veya kalın karton üzerine yazdırabilirsiniz.
   • Alternatif olarak, kullanıcı tarafından hızlı ve kolay başvuru için doğrudan ürüne bir özet uygulayabilirsiniz.

Bölüm 3/4: Ürün bakımını açıklama

1. Cihazın nasıl temizleneceğini açıklayın. Cihazınızın veya ürününüzün temizlenmesi gerekiyorsa, bunun nasıl yapılacağını açıklayın. Gerekli temizlik maddelerini listeleyin. Okuyucuya ne sıklıkla temizleneceğini söyleyin. Ardından, kılavuzun diğer bölümlerinde olduğu gibi, nasıl temizleneceğine dair numaralandırılmış adım adım talimatlar ekleyin.
   • Temizleme, ürünün sökülmesini veya belirli bir parçanın veya parçaların çıkarılmasını gerektiriyorsa, ürünün nasıl sökülmesi gerektiğini belirtin.
   • Cihazın temizlenememesinin sonuçları hakkında bir uyarı verin. Örneğin, "Aygıt temizlenmezse performans optimumun altında olacaktır" diyebilirsiniz.
2. Kullanıcıyı temel bakımı nasıl gerçekleştireceğini sayın. Ürün veya cihaz, performans sorunlarını düzeltmek için kullanıcı tarafından tamir edilebilir durumdaysa, kullanıcı için bunun nasıl yapılacağına dair numaralandırılmış talimatlar sağlayın. Örneğin, her 300 saatlik kullanımdan sonra pillerin değiştirilmesi gerekiyorsa, pillerin değiştirilmesi gerekip gerekmediğini, bitmiş pillerin nasıl çıkarılacağını ve yenilerinin nasıl takılacağını kontrol edin.
   • Yalnızca sertifikalı bir teknisyen tarafından gerçekleştirilebilecek belirli bakım görevleri varsa, kılavuzun bakım bölümünü iki kısma ayırın.
3. Depolama seçeneklerini tartışın. Kılavuz, gerekirse ürün veya cihazın nasıl doğru şekilde saklanacağını açıklamalıdır. ayrıca depolamanın neden gerekli olduğu ve uygun olmayan depolamanın sonuçları hakkında bilgi de eklemelisiniz. Örneğin: yazabilirsiniz:
   • Ürünü serin ve kuru bir yerde saklayın. Yanlış saklama, nem birikmesi nedeniyle ürününüzün ömrünü kısaltabilir. "
   • "Ürünü ısıya maruz bırakmayın veya 50 santigrat derecenin üzerindeki sıcaklıklarda saklamayın.Eğer yaparsanız, yanmaya neden olabilir. "
4. Sorun giderme bilgileri sağlayın. Bu bölümü genel sorunlar ve çözümlerinin bir listesi olarak düzenleyebilirsiniz. Benzer sorunları mantıksal bir başlık altında gruplayın. Bu şekilde, kullanıcılar belirli sorunları hızlı bir şekilde bulabilir.
   • Örneğin, bilgisayarın mavi ekranı görüntülemesiyle ilgili birkaç sorun varsa, bunları "Yaygın ekran sorunları" gibi bir alt başlık altında gruplayın.
   • Ayrıca bu bölüme müşteri hizmetleri için bir telefon numarası ve / veya e-posta eklemelisiniz.

Bölüm 4/4: Okunabilir bir kılavuz yazın

1. Diğer kullanıcı kılavuzlarını okuyun. Kendi ürününüz için bir kılavuz yazmadan önce, diğer etkili kullanım kılavuzlarına göz atın. Yapısına, kelime seçimine ve cümle yapısına dikkat edin. Apple, Google ve Microsoft gibi büyük markalar, daha dikkatli bir şekilde yazılmış bir kullanıcı kılavuzu oluşturmanıza yardımcı olabilecek güçlü, etkili kullanıcı kılavuzları üretir.
   • Sadece okumayın herşey kullanım kılavuzları. Sattığınız benzer ürünler için kılavuzları okuyun. Örneğin, bebek ürünleri satıyorsanız, teknik kılavuzları değil, bebek kılavuzlarını okuyun.
2. Standartlarınızı seçin. Yazımı, kelime seçimini ve ifadeyi standart hale getirmek, kullanım kılavuzunu daha kullanıcı dostu hale getirecektir. Chicago Stil Kılavuzu ve Microsoft Stil Kılavuzu, kullanıcı kılavuzunuzu yazarken yardımcı stil kılavuzları olabilir; kılavuzunuz için doğru olup olmadığını görmek için her ikisini de kontrol edin.
   • Örneğin, kılavuzunuzda hem "güç anahtarı" hem de "güç düğmesi" kullanmak yerine, iki terimden birini seçin ve buna bağlı kalın.
3. Aktif sesi kullanın. Aktif ses, olayları kullanıcının bakış açısından açıklayan bir yazma şeklidir. Konunun tanımsız olduğu alternatif olan pasif sesten anlamak daha kolaydır.
   • Yazınızdaki pasif bölümleri belirlemek için Hemingway Uygulamasını (www.hemmingwayapp.com) deneyin.
   • Bu iki örnek cümleyi inceleyin - ilki aktif ve ikincisi pasiftir:
     • Paketi yavaş ve dikkatli bir şekilde açmalısınız.
     • Ambalaj yavaş ve dikkatli bir şekilde açılmalıdır.
4. Numaralı talimatlar yazın. Sayısal olarak sıralı talimatlar, okuyucunun söz konusu ürünü kullanma, bağlama veya oluşturma sürecine daha iyi odaklanmasına yardımcı olur. Uzun, ayrıntılı bir paragraf veya bir dizi numaralandırılmamış paragraf yazmak yerine, kullanım kılavuzunuzu her biri açıkça numaralandırılmış basit, açık adımlarla yazın.
5. Her adıma bir zorunlulukla başlayın. Emir, eyleme yönelik bir fiildir. Her adıma bir fiil ile başlayarak, okuyucuya adımı tamamlamak için gereken eylem hakkında bir ipucu verirsiniz. Örneğin, hakkında yazdığınız ürüne bağlı olarak adımlarınıza "Bağlan", "Onayla" veya "Kaydır" gibi bir komutla başlayabilirsiniz. Ancak, adımlarınıza sistemden bir yanıt alarak başlamayın.
   • Örneğin, ekran maviye dönüp yanıp sönmeye başlarsa, şu adımı başlatmayın: "Ekran yanıp sönecek ve maviye dönecektir." Deneyin: "Giriş tuşunu basılı tutun. Ekran yanıp sönecek ve maviye dönecektir. "
6. Hangi kelimeleri kullanacağınızı belirleyin. Bir yo-yo kılavuzu yazıyorsanız, dinleyicileriniz çoğunlukla küçük çocuklar olacaktır. Yo-yonun nasıl çalıştığını açıklamak için basit kelimeler ve kelimeler kullanın. Bir taramalı elektron mikroskobu kılavuzu yazarken, hedef kitleniz çok ayrıntılı bilgileri anlayabilen çok yetenekli bilim adamlarından oluşur, bu nedenle özel kelime dağarcığı veya incelikli açıklamalar kullanmaktan çekinmeyin.
   • Genel olarak, jargon ve teknik dilden kaçınmaya çalışırsınız.
   • Mümkün olan en geniş kullanıcı tabanı için etkili olmak için, ilkokul altıncı sınıftan yedinci sınıfa kadar bir seviyede yazmaya çalışın.
7. Bir ürünü yurt dışına gönderirken, çevirilerinizin doğru olduğundan emin olun. Kullanım kılavuzunuzu ürününüzü gönderdiğiniz ülkenin ana diline çevirmesi için bir tercüman tutun. Bir çevrimiçi çeviri programı da kullanabilirsiniz, ancak anadili İngilizce olan bir konuşmacıdan çeviriyi okumasını ve hataları kontrol etmesini isteyebilirsiniz.
   • Hedef kitlenizde birden fazla dil grubu temsil ediliyorsa, lütfen kullanıcı kılavuzunun her bir ilgili dildeki çevirilerini ekleyin.
   • Kelime kelime çeviri olmayan belirli terimler için hedef dilde farklı kelimeler olabileceğinden çevirmen ürüne aşina olmalıdır.
8. Kısa cümlelerle yazın. Birkaç uzun paragraf yerine çok sayıda kısa paragraf kullanırsınız. Her bölümdeki mantıksal sonları arayın ve yararlı bilgileri bir veya iki cümlelik parçalar halinde özetleyin. Aynısı cümle düzeyinde de geçerlidir. Cümlelerinizi uzun ve ayrıntılı değil, kısa ve basit tutun.
   • Bir adım çok uzun sürüyorsa, onu daha küçük adımlara bölün. Bu, kelime sayısını azaltmayacaktır, ancak satır sonları okumayı kolaylaştıracaktır.
9. Kılavuzda hata olup olmadığını kontrol edin. Bir kılavuz, dilbilgisi ve yazım hataları nedeniyle güvenilirliğini kaybedebilir. Bir meslektaşınız veya teknik yazarın kılavuzu düzenlemesini ve yeniden okumasını sağlayın. Yazım ve dilbilgisine ek olarak, bir düzeltici aşağıdakilere de dikkat etmelidir:
   • Pasif ses
   • Net olmayan veya kafa karıştırıcı dil
   • Sarmalanmış cümle yapısı
   • Aşırı uzun paragraflar

İpuçları

• İnsanlar farklı yollarla öğrenirler; Mümkün ve uygunsa, görsel odaklı okuyucuları barındırmak için kılavuza görsel yardımlar veya çevrimiçi videolara bağlantılar ekleyin.