Kullanım kılavuzları, Teknik Dokümantasyonun en çok ilgilenilen konularından biridir. Müşteriye teslim edilen ürünün müşteri tarafından en verimli, güvenli ve doğru biçimde kullanılmasını sağlayan doküman türüdür. Hangi sektörden olursa olsun, dayanıklı tüketim ürünlerinin satışıyla birlikte müşteriye verilmesi zorunlu olan dokümanlardır.
Sen ne söylersen söyle, söylediğin, karşındakinin anladığı kadardır.
Mevlâna Celaleddin-i Rûmî
Kullanım Kılavuzunda Hangi Bilgiler Bulunur?
Kullanım kılavuzu yazılırken dikkat edilmesi gereken en önemli konulardan birisi hedef kitledir. Kullanım kılavuzu oluşturulurken müşteri yani hedef kitle analizi çok doğru biçimde yapılmalı; içerik hazırlanırken kılavuzu okuyacak kişilerin teknik bilgi seviyesi, alışkanlıkları, temel becerileri ve eğitim seviyesi göz önünde bulundurulmalıdır. Hazırladığınız kılavuzlar, müşterinizin ihtiyacını karşılamak zorundadır. Hem içerik hem de görsel açıdan anlaşılabilir bir kullanım kılavuzu oluşturmazsanız yalnızca yasal bir prosedürü yerine getirmiş olursunuz.
Genel olarak bir makine kullanım kılavuzunda aşağıdaki bölümler bulunur;
- İçindekiler
- Güvenlik Bilgileri
- Makine Bilgileri
- Çalıştırma Bilgileri
- Acil Durum Bilgileri
- Bakım Bilgileri
- Arıza Giderme
- Teknik Bilgiler
- İndeks
Kullanım Kılavuzlarının Dili
Kılavuzlarınızı mümkün olan en sade, kısa ve kurallara uygun biçimde hazırlamalısınız. Kullandığınız dil sade ve anlaşılabilir olmalıdır. Olabildiğince kısa cümleler kurmalı, gereksiz kelime oyunlarından kaçınmalısınız. Bununla birlikte içerikteki ifadelerinize dikkat etmelisiniz. Kullanıcının kafasını karıştıracak, birbiri ile çelişen ve bulanık ifadelerden uzak durun.
Azı Karar, Çoğu Zarar.
Türk Atasözü
Her işte olduğu gibi kullanım kılavuzu hazırlarken de ölçü çok önemlidir. Unutmayın ki üretici olarak bilginin kaynağı sizsiniz. Ürünle ilgili tüm ve her seviyede bilginin sahibi olarak hedef kullanıcınızla – yalnızca ihtiyacı kadar – bilgiyi paylaşmalısınız. Örnek olarak; kullanıcının yapmasını istemediğiniz sökme – takma işlemleriyle ilgili bir bilgiyi kılavuzda paylaşırsanız bu durum, kullanıcıda bu işi kendi kendine yapabileceği algısını doğurur. Bu da istenmeyen sonuçlara neden olabilir. Bu nedenle kullanım kılavuzu içeriğini hazırlamadan önce kullanıcının yapabileceği ve yapamayacağı işleri belirten bir liste hazırlayın. Vereceğiniz bilgileri bu listeye göre düzenleyin. Kullanıcının yapmasını istemediğiniz işler için bilgi vermekten kaçının. Yine de anlam bütünlüğünü sağlamak için yapılmasını istemediğiniz işlerle ilgili bilgi vermek zorundaysanız, kullanıcıyı bahsi geçen işlemi yapmaması için kesin bir dille uyarın.
Bununla birlikte hangi dilde yazılmış olursa olsun kullanım kılavuzları son kullanıcının ihtiyacına göre farklı dillere çevrilirler. Yapılacak çevirinin kalitesini artırmak, maliyeti düşürmek için metin kalıplarınızı gözden geçirin.
Türkçe Kullanım Kılavuzu içerisinde geçmesi planlanan:
“Makinenin kapaklarını açarken içeride basınçlı havanın olup olmadığını kontrol edin.”
cümlesini ele alalım. Bu cümleyi olduğu gibi (bire bir) ingilizceye çevirecek olursak
“When opening the covers of the machine, check whether there is compressed air inside”
gibi bir cümle elde ederiz. Görüldüğü üzere Türkçede oldukça anlamlı bir cümle kurulmuş olmasına karşın ingilizcesi pek de anlamlı olmadı.
Bu sorunu gidermek için çeviri işini yapan kişinin sorumluluk alması ve cümle üzerinde ayrıca çalışması gerekir. Bu da ek zaman ve tecrübe yani maliyet anlamına gelir. Oysa ki Türkçe kullanım kılavuzunda geçen cümleyi aşağıdaki gibi yazmış olsaydık;
“Makine kapaklarını açmadan önce içeride basınçlı havanın olmadığını kontrol edin.”
Aşağıdaki düzgün çeviriyi elde etmemiz daha kolay olacaktı.
“Before opening the machine hatches, check that there is no compressed air inside.”
Yukarıdaki örnekte de görüldüğü gibi kullanım kılavuzunda kullanılan dil hem anlaşılabilirliği sağlamak hem de olası çeviri maliyetlerini en uygun seviyede tutmak için oldukça önemlidir.
Kullanım Kılavuzunda Olması Gerekenler
Kullanım kılavuzu yalnızca metinlerden oluşmaz. Son kullanıcının anlatılan konuyu daha iyi kavrayabilmesi için mutlaka destekleyici görseller oluşturmalı ve kullanmalısınız. Anlatılan konuyu destekleyen görseller için fotoğraf ya da çizimler (illüstrasyon) kullanabilirsiniz. Kullanım amacı aynı olsa da her ikisinin de avantajları ve dezavantajları bulunmaktadır.
İster fotoğraf ister illüstrasyon kullanın, öncelikli amacınızın metin içeriğini pekiştirmek olduğunu unutmayın. Özel olarak ihtiyaç duyulmadıkça asla kullanım kılavuzlarınızda teknik resim kullanmayın.
Kullandığınız resimlerin sayfa yerleşimine uygun biçimde boyutlandırıldığından emin olun. Kâğıt düzlemine yatay olarak yerleştirilmiş bir kılavuzda dikey bir görsel kullanmaktan kaçının. Kılavuzunuzu bitirdikten sonra dijital ya da klasik bir matbaada bastıracaksanız baskı renk profillerine de dikkat etmeniz gerektiğini unutmayın.
Kullanım Kılavuzunda Yerleşim ve Sayfa Boyutu Nasıl Olmalı?
Kullanım kılavuzunu oluşturmaya başlamadan önce kâğıt düzenini yani yerleşim planını oluşturmanız gerekir. Oluşturacağınız dokümanın yerleşim planı; son kullanıcının ihtiyaçları, dokümanın dağıtım şekli, kullanmayı planladığınız görseller ve kurumsal kimlik kriterlerinizin tamamını birlikte karşılamalıdır.
Kullanım Kılavuzunda Sayfa Boyutu Ne Olmalı?
Hazırladığınız doküman yalnızca dijital olarak dağıtılacaksa ya da bir çevrimiçi dokümansa buradaki en önemli kriter dosya büyüklüğüdür. Ancak baskıya girecek bir dokümandan bahsedildiğinde işler biraz değişir. Örneğin;
- Kullanıcı dokümanı sürekli yanında bulundurmalı mı?
- Kullanıcı dokümanı nerede saklayacak, bunun yeterli yeri var mı?
- Makine / cihaz üzerindeki işlemi anlık olarak dokümana bakarak yapacak?
- Planladığımız kâğıt boyutunu kullandığımızda dokümandaki görseller ve metinler rahatlıkla algılanabiliyor mu?
Gibi sorulara cevap bulmalı ve sayfa boyutunuzu buna göre ayarlamalısınız. Sonradan problem yaşamamak için dokümanı oluşturmadan önce içerisinde örnek metin ve grafikler olan bir sayfa oluşturup bastırın. Dokümanda olması gereken minimum ve maksimum değer aralıklarınızı belirleyin ve bu adımdan sonra dokümanınızı oluşturun.