Harika bir kılavuz, bir şirketin üretebileceği en yüksek kaldıraçlı varlıklardan biridir; bilgiyi, ihtiyaç duyan herkes için ölçekler. Trupeer ile ücretsiz kılavuz şablonlarıyla başlayarak, marka yönergeleriniz ile özelleştirerek ve herhangi bir kılavuzu video anlatıma dönüştürmek için AI kılavuz oluşturucumuzu kullanarak kılavuz yazma işinde saatler kazanabilirsiniz.

Kılavuz şablonu nedir ve hangisine ihtiyacınız var?

Kılavuz, birinin bir işi doğru şekilde yapmak için başvurduğu bir belgedir: bir makineyi çalıştırmak, yazılım kullanmak, bir süreci takip etmek veya bir işi öğrenmek. Kılavuz şablonu ise bunun arkasındaki yeniden kullanılabilir yapıdır; bir kılavuzu diğerine benzeten bölümleri, ön bilgileri ve yerleşik kuralları kapsar.

Daha zor soru, hangi kılavuzu yazdığınızdır; çünkü bu kelime, farklı okuyucuları, farklı kullanım ömürlerini ve farklı hukuki ağırlıkları olan en az sekiz farklı belgeyi kapsar. Bir web uygulaması için kullanıcı kılavuzu ile endüstriyel ekipman için işletim kılavuzu, ad dışında neredeyse hiçbir şey paylaşmaz.

Bunu yanlış yapmak belirli bir şekilde pahalıdır. Kötü bir belge üretmez. Aşağıda açıklanan arıza modunu üreten, dört olmaya çalışan tek bir belge üretir.

İki imzacısı olan bir kılavuz tek bir kılavuz değildir

İşte test; yaklaşık bir dakika sürer.

Kılavuzunuzda yapılacak bir değişikliği onaylamak zorunda olan herkesin listesini çıkarın. İncelemek değil. Belgenin onlarsız yeniden yayımlanamayacağı anlamda onaylamak.

Bu listenin tek bir adı varsa tek bir kılavuzunuz vardır. Dört ad varsa, birinin bağlayıp bir araya getirdiği dört kılavuzunuz vardır ve bu bağlama, hiçbirinin güncel tutulmamasının nedenidir.

Mekanizma basittir ve iyi niyetleri tamamen boşa çıkarır. Farklı kişilerin sahip olduğu içerikler farklı hızlarda değişir. Güvenlik beyanları nadiren değişir ve uyumluluk gerektirir. İşletim talimatları her sürümde değişir ve ürün gerektirir. Sorun giderme haftalık değişir ve servis ekibi gerekir. Bunları tek bir belgeye bağladığınızda, en ucuz değişiklik en yavaş onay yolunu devralır; bu yüzden dokuz sayfalık düzeltme, iki yüz sayfalık incelemeyi bekler.

Sürece dahil olan herkes her adımda makul davranır ve kılavuz yine de eskir. Bu arızanın bu kadar yaygın olmasının nedeni budur: Kimse yanlış bir şey yapmaz.

Dolayısıyla herhangi bir kılavuz projesindeki ilk karar şablon değildir. Kaç tane kılavuz olduğudur ve cevap imzacısı sayısıdır.

Trupeer’da bu şablon nasıl özelleştirilir

Adım 1: Şablonlar bölümünü açın

Ana navigasyondan Şablonlar bölümüne gidin.

Adım 2: Bir şablon seçin ve açın

Açmak istediğiniz herhangi bir şablonun üzerine tıklayın.

Adım 3: Şablon görünümünü genişletin

Gerekirse, tam düzeni ve ayrıntıları net şekilde görmek için şablon görünümünü genişletin.

Adım 4: Şablonu düzenleyin

Seçili şablonda değişiklik yapmaya başlamak için Düzenle’ye tıklayın.

Düzenleyicide şunları yapabilirsiniz:

• Yeni bölümler ekleyin

• Biçimlendirme kurallarını tanımlayın veya güncelleyin

• Bir logo ekleyin ve konumunu ile ilgili ayarları düzenleyin

Adım 5: Özelleştirilmiş şablonunuzu kaydedin

Gerekli tüm değişiklikleri yaptıktan sonra, güncellenmiş şablonu kendi şablonunuz olarak saklamak için Kaydet’e tıklayın.

Adım 6: Önizleyin ve şablonu ince ayar yapın

Özelleştirilmiş şablonunuzun nasıl göründüğünü görmek istediğinizde Önizleme’yi açın.

Önizleme ekranından, gerekirse doğrudan ayarlamalar yapmaya devam edebilir; böylece şablonun tam olarak istediğiniz gibi göründüğünden emin olursunuz.

Trupeer’ın kılavuz şablonlarıyla şunları yapabilirsiniz:

• Yazma işinde saat kazanın: Her tür kılavuz için kanıtlanmış yapılarla boş sayfayı atlayın.

• Tüm kullanım senaryolarını kapsayın: Kullanıcı kılavuzları, eğitim, operasyon, talimat ve politika için şablonlar.

• Markanızda kalın: Trupeer’ın marka kitini kullanarak logonuzu, yazı tiplerinizi ve renklerinizi uygulayın.

• Desteği azaltın: Net kılavuzlar kullanıcıların kendi kendine hizmet almasını sağlar; talepleri ve yeniden çalışmayı azaltır.

• Video eğitimleri ekleyin: Metinle anlatılması zor olan adımlar için videoyu yerleştirin.

• Küresel kullanıcılara ulaşın: Kılavuzları tek tıkla 65+ dile çevirin.

Kılavuz türleri, her birini kim imzalar ve ne sıklıkla değişir

Onaylar sütununu aşağıdan okuyun. Kılavuz sorunu olduğunu düşünen neredeyse her kuruluşun aslında bunlardan üçü ya da dördü birleşmiş haldedir.

En sık yanlış birleşen iki satır eğitim kılavuzu ve kullanıcı kılavuzudur. Farklı okuyucular farklı işler yapar: biri görevin dışında öğrenir, diğeri onun tam ortasında kalır. İkisine de hizmet eden bir belge, danışmak için fazla uzun ve öğrenmek için fazla sığdır.

Ücretsiz kılavuz şablonu: Her kılavuzun paylaştığı yapı

Hangi türü yazıyor olursanız olun, ön bilgiler aynıdır ve taslakların en çok atladığı kısımdır. Buradan kopyalayın.

Başlık ve kapsamı. Bu kılavuzun uygulandığı ürün, sürüm veya süreç; okuyucunun biraz farklı bir şeyle karşılaştığında nerede duracağını anlayacak kadar net şekilde belirtilmelidir.

Kime yönelik. Rol ve varsayılan başlangıç bilgisi. "Eğitimli operatörler için" ile "İlk kez kullanan kullanıcı için" çok farklı belgeler üretir ve okuyucu, elinde hangisini tuttuğunu beş saniye içinde anlayabilmelidir.

Sahip ve onaylayan. Her biri için tek bir ad. Bunlar farklı kişilerse bunu not edin; çünkü bu fark, ne kadar hızlı değiştirilebileceğini belirleyen şeydir.

Sürüm ve tarih. Sürüm numarası, yayımlanma tarihi ve önceki sürümden bu yana nelerin değiştiği tek bir satırda.

Güvenlik ve sınırlamalar. Yalnızca yapılan iş risk taşıyorsa ve ek yerine talimatların önüne yerleştirilmelidir.

Bu kılavuz nasıl kullanılır. İki ya da üç satır: Baştan sona mı okunur yoksa araya mı girilir, dizin nerede, kılavuz sizin senaryonuzu kapsamıyorsa ne yapılır.

Gövde. Yukarıda seçtiğiniz satıra göre yapılandırılan, türe özel kısım.

Bu yardımcı olmazsa ne yapmalısınız. Adlandırılmış bir yol; genel bir destek adresi değil.

Buraya kopyalayın. Sürüm satırı ve iki ad, bir kılavuzu bir belgeden ayıran alanlardır ve biri acele ettiğinde ilk kesilen şeyler de bunlardır.

Zaten yazılmış bir kılavuz nasıl bölünür

Çoğu kişi bu sayfaya boş bir sayfa yerine, elinde mevcut bir belgeyle gelir; bu yüzden şablondan daha önemlidir.

Bastırın ya da içindekiler sayfasını açın. Her bölümün karşısına bir ad yazın: Bu değişikliği kim onaylamak zorunda. Kim yazdı değil.

Bölümleri bu ada göre gruplandırın. Bu gruplar sizin kılavuzlarınızdır. Uygulamada genellikle üç ya da dört grup ve kimsenin sahiplenmediği bir yetim bölüm bulursunuz; yetim bölüm normalde zaten güncel değildir.

En çok can yakan sırayla bölün; bu da neredeyse her zaman, en yavaş onaylayanın arkasında beklerken en sık değişen içerik hangisiyse odur. Değer genellikle burada olur ve çoğu zaman uyumluluğun arkasında sıkışmış işletim ya da sorun giderme içeriğidir.

Bölürken yeniden yazmayın. Metni olduğu gibi taşıyın, yeniden yayımlayın ve içeriği sonradan düzeltin. Aynı anda bölmek ve yeniden yazmak, bu tür projelerin yüzde kırkta takılı kalıp terk edilmesinin yoludur.

Her belgede diğerlerine işaret eden bir çapraz referans bırakın; çünkü okuyucunuz bunu hâlâ tek bir kılavuz gibi düşünür ve her zaman öyle düşünecektir.

Dokuz sayfayı değiştirmek için on bir hafta harcatan kılavuz

Kilnmore Systems, oteller ve hastaneler için ticari çamaşırhane ekipmanları üretir. Gönderilen her makine, yüz kırk sekiz sayfaya kadar uzanan bir İşletim ve Bakım Kılavuzu ile birlikte gelir.

İçinde; mühendislik tarafından onaylanan kurulum talimatları, uyumluluk tarafından onaylanan güvenlik uyarıları ve uygunluk beyanları, ürün tarafından yazılan işletim talimatları, ürün kaynaklı temizlik planları, servis ekibi tarafından sağlanan sorun giderme, tedarik zincirinden yedek parça listesi ve hukuk tarafından verilen garanti şartları vardı. Yedi katkıda bulunan, dört onaylayan, tek bir PDF.

2024’te bir ürün yazılımı sürümü işletim menüsünü değiştirdi. Kılavuzun yaklaşık dokuz sayfası yanlış oldu.

Bu dokuz sayfayı güncellemek, belgenin yeniden yayımlanması anlamına geliyordu ve belgenin yeniden yayımlanması aynı dosyaya bağlanmış uygunluk beyanları nedeniyle tam bir uyumluluk incelemesini tetikledi. Bu inceleme on bir hafta sürdü.

Bu on bir hafta boyunca, işletim bölümü makineyle eşleşmeyen bir kılavuza sahip yaklaşık üç yüz kırk makine sevk edildi. Menüyle ilgili servis çağrıları ayda yaklaşık dörtten yaklaşık otuz seviyesine çıktı ve iki çeyrek boyunca orada kaldı. Bu, her biri yaklaşık seksen beş pound olan yaklaşık yüz altmış çağrıya denk gelir; yani lansmana verdiği etkiyi saymadan, on dört bin poundun biraz altı.

Kılavuzda hiçbir şey kötü yazılmamıştı. Belge doğruydu, kapsamlıydı ve iyi hazırlanmıştı. Sadece ucuza değiştirilemiyordu ve ucuza değiştirilemeyen bir belge, ömrünün çoğu boyunca yanlış kalır.

Çözüm yapısaldı. Onaylayana göre dört belgeye bölündü: uyumluluk altında kurulum ve güvenlik, ürün altında işletim kılavuzu, servis ekibi altında servis ve sorun giderme, tedarik zinciri ve hukuk altında parçalar ve garanti. Aralarında çapraz referanslar ve dördünü de listeleyen tek bir kapak sayfası vardı.

Bir sonraki ürün yazılımı sürümünde işletim kılavuzu dört gün içinde güncellendi ve yeniden yayımlandı. Uyumluluk belgesi dokunulmadı; çünkü içinde değişen hiçbir şey yoktu.

İnsanların gerçekten açacağı bir kılavuz nasıl yazılır

Önce içindekiler sayfasını yazın ve bunu kılavuzu kullanacak birine gösterin. Yapısal hataların yarısı, herhangi bir yazma işi boşa harcanmadan önce bu görüşmede ortaya çıkar.

Bir okuyucunun en muhtemel ihtiyaç duyacağı bölümü önce yazın; mantıksal olarak ilk gelen bölümü değil. Çoğu kılavuzda bunlar farklıdır ve ürünün mimarisini izleyen sıralama, okuyucunun sorununu izleyen sıralama neredeyse hiç değildir.

Başlıklar için okuyucunun kullandığı kelimeleri kullanın. İnsanlar bir kılavuzu, kendilerine olan şeyin adını değil; kendilerine olan şey için arar.

Sadece sıra gerçekten önemliyse adımları numaralandırın. Numaralı liste bir sıra ima eder ve okuyucular, yanlış olsa bile ima edilen sıraları takip eder.

Her uyarıyı, uygulandığı adımın hemen önüne koyun. Baştaki bir uyarılar bölümü yasal bir belgedir; talimat değildir ve bir kez okunur, bir daha okunmaz.

Yardım etmeden bir kişinin kullanmasını izleyerek test edin. Her tereddüt bir kusurdur. Bu, kırk dakika sürer ve üçten fazla inceleme turundan daha fazlasını bulur.

Kılavuz şablonunda neler yer almalı?

En azından: kapsamı, kime yönelik olduğu, bir sahip ve bir onaylayan, tarihli bir sürüm, okuyucunun durumuna göre yapılandırılmış bir gövde ve kılavuz soruyu yanıtlamadığında kullanılacak adlandırılmış bir yol.

Bunun dışındaki her şey türe özeldir. Bir yazılım kullanıcı kılavuzu ekran görüntüleri ve arama yapılabilir bir yapı gerektirir. Bir işletim kılavuzu, satır içi yerleştirilmiş uyarılar, bakım planı ve uygunluk bilgileri gerektirir. Bir eğitim kılavuzu hedefler ve okuyucunun anladığını kontrol etmenin bir yolunu gerektirir; diğerlerinin hiçbiri bunu hiç ihtiyaç duymaz.

İnsanların atladığı ve atlamaması gereken alan, bu sayfanın tamamının nedeni olan onaylayanın adıdır.

Yazılım ve web uygulaması kullanıcı kılavuzu şablonları

Yazılım kılavuzlarının diğerlerinde olmayan tek bir özelliği vardır: ürün, belgenin altında sürekli değişir; bu nedenle yazdığınız her şey, yayımlandığı gün bozulmaya başlar.

Bu da üç şeyi gerektirir. Menüye göre değil göreve göre yapılandırın; çünkü menüler yeniden düzenlenir, görevler ise yeniden düzenlenmez. Her konuyu tek başına güncellenebilecek kadar kısa tutun; bu da bağlı bir belge yerine arama yapılabilir bir makale seti anlamına gelir. Ve sık sık değişen hiçbir şeyi ekran görüntüsü olarak eklemeyin; kontrolün adını verin, konumunu gösterin.

Özellikle bir web uygulaması için kılavuz büyük ölçüde ürün içi yardım ve arama yapılabilir bir yardım merkeziyle yer değiştirmiştir ve bunu indirilebilir bir PDF gibi ele almak genellikle bir hatadır. Bunun için gereken yapılar, bir kılavuz şablonunun yapabileceğinden daha iyi şekilde sürümleme sorununu yöneten bilgi bankası makalesi şablonlarımızda yaşar.

Gerçekten tek bir belgeye ihtiyacınız olduğu durumlarda; satın alma, erişilebilirlik uyumluluğu veya tek bir belge isteyen bir kurumsal müşteri için, bunu ayrı ayrı sürdürmek yerine makalelerden üretin.

Eğitim kılavuzu şablonları ve kullanıcı kılavuzlarından farkları

Eğitim kılavuzu, işin dışında, sırayla bir kez okunur; işi henüz yapamayan biri tarafından. Kullanıcı kılavuzu ise çalışma noktasında, çoğunlukla yapabilen biri tarafından araya girilerek okunur.

Bu tek fark neredeyse her şeyi değiştirir. Eğitim kılavuzları bağlam, çalışılmış örnekler ve anlama kontrolü için bir yol gerektirir. Kullanıcı kılavuzları bulunabilirlik ve kısalık ister; içlerindeki bağlam ise gürültüdür.

Pratik sonuç şudur: Bir kullanıcı kılavuzuna giriş ekleyerek bir eğitim kılavuzu oluşturamazsınız; çoğu denemenin yaptığı da budur. Önce kullanıcı kılavuzunu yazın, sonra onun etrafında eğitim kılavuzunu yazın; tekrar etmek yerine dışarıdan referans verin.

Eğitim tarafını tek bir işlev için ayrıntılı şekilde ele alan müşteri hizmetleri eğitim kılavuzu şablonumuz vardır ve aynı yapı diğerlerine de uyarlanır.

Ekipman ve düzenlemeye tabi işler için işletim kılavuzu şablonları

İşletim kılavuzları diğerlerinin taşımadığı bir ağırlık taşır. Ekipman, makine, basınç, elektrik veya tıbbi cihaz düzenlemeleriyle kapsanıyorsa kılavuz, onunla ilgili dokümantasyon değil; ürünün uyumluluğunun bir parçasıdır. İçerik, dil, saklama ve taşıdığı uygunluk bilgileri hepsi belirtilebilir.

Başlamadan önce bilmeye değer pratik sonuçlar. Kılavuz genellikle kullanım ülkesinin dilinde sağlanmak zorundadır; bu da çeviriyi “olsa iyi olur”dan ziyade bir uyumluluk sorusu haline getirir. Uyarılar adımla birlikte durmalı ve ifadeleri belirlenmiş olabilir. Hangi sürümün hangi seri numarasıyla gönderildiğine dair kayıtların yıllarca saklanması gerekebilir. Ve ekipmanda yapılacak her değişiklik, kılavuzun yeniden yayımlanmasını ve yeniden değerlendirilmesini gerektirebilir.

Bunların hiçbiri hukuki tavsiye değildir ve gereklilikler yargı alanına ve ürün sınıfına göre değişir. Yayımlamadan önce uyumluluk biriminizin veya harici bir uzmanın neyin geçerli olduğunu doğrulamasını sağlayın ve rutin bir işletim değişikliği onu inceleme sürecine geri çekmesin diye uyumluluk onaylı içeriği kendi belgesinde tutun.

Word, Canva veya Google Docs’ta kılavuz şablonu alabilir miyim?

Word, basılacak veya PDF olarak gönderilecek uzun biçimli kılavuzlar için uygundur; çünkü numaralı bölümleri, çapraz referansları ve oluşturulan içindekiler sayfasını yönetir; bu üç şey, otuz sayfayı geçtikten sonra can sıkıcı hale gelir.

Google Docs, iş birliğiyle yazılan ve çevrimiçi okunan kılavuzlar için uygundur; yorum iş parçacıkları inceleme sırasında gerçekten faydalıdır. Uzunlukta zorlaşır; bu nedenle iki yüz sayfalık bir işletim kılavuzundan ziyade eğitim kılavuzlarına ve kısa kullanıcı rehberlerine daha iyi uyar.

Canva, anlamın bir kısmını görünüşün taşıdığı kılavuzlar için uygundur: hızlı başlangıç rehberleri, tek sayfalık işletim talimatları, duvara asılacak her şey. Yüzlerce çapraz referansı olan bir belge için doğru araç değildir.

Tercihe göre değil, uzunluğa ve hedefe göre seçin. Hangisini seçerseniz seçin, onaylayıcınızın imzalayabileceği yerde tutun; bu genellikle geri kalanının bulunduğu yerle aynı değildir.

Yeniden yazma projesi olmadan kılavuzu güncel nasıl tutarsınız

Belgeyi bölmek onay sorununu çözer. Yazma sorununu çözmez; çünkü bir kılavuzu güncellemek, birinin zaten bildiği adımları ekran görüntüsü alıp kırpıp yeniden yazması anlamına gelir ve bu iş hiçbir zaman acil olanın karşısında kazanamaz.

Trupeer AI bu maliyetin çoğunu ortadan kaldırır. Mevcut süreci bilen kişi, bunu bir kez kaydeder; çıktı ise adımlar ve görselleri zaten yerinde olan, düzenlemeye hazır biçimlendirilmiş bir kılavuz bölümü olur; yazmak yerine düzenlersiniz. Dokuz sayfalık bir işletim değişikliği bir öğleden sonrayı alır.

Kaydedin. Markalayın. Çevirin. Trupeer’layın.

kılavuz oluşturucu tam olarak bunun için tasarlanmıştır ve aynı kayıt, eğitim için bir video ile tutarlı markalamaya sahip bilgi bankası için bir doküman üretir. Ekipman sınırlar arası satıldığında yerel dil sürümü çoğu zaman bir nezaket değil gereklilik olduğundan, çeviri burada çoğu belgeden daha önemlidir. Kurulum talimatları belge şablonu kurulum kılavuzunda yer alır.

Sık Sorulan Sorular

Ücretsiz olarak Word’de adım adım kullanıcı kılavuzu şablonu var mı?

Yukarıdaki ön bilgiler yapısı Word’e yapıştırılır ve her tür kılavuz için bir “ev kabuğu” gibi çalışır. Adım adım bir rehberin gövdesi için her adımı tek bir eylem ve beklenen sonucu olacak şekilde tutun ve ikinci bir konuya bölmeden önce yaklaşık dokuz adımda durun. Kilitli bir indirme yoktur ve form yoktur.

Word’de ücretsiz bir eğitim kılavuzu şablonu var mı?

Aynı ön bilgileri kullanın; ardından gövdeyi, okuyucunun ürünün özellikleri yerine neleri yapabilir hale geleceği etrafında yapılandırın. Önce hedefler, sonra çalışılmış örnek, ardından pratik ve en son kontrol. Eğitim kılavuzları genellikle sırayla okunur ve çoğu zaman basılır; Word bu nedenle burada iyi çalışır.

Canva için kullanıcı kılavuzu şablonu var mı?

Canva, kısa görsel kılavuzlar için iyi çalışır: hızlı başlangıç sayfaları, tek sayfalık işletim talimatları, duvara asılacak her şey. Bu sayfadaki ön bilgi alanlarını buradan alıp oraya yerleştirin. İçindekiler sayfası veya çapraz referans gerektirecek kadar uzun olan her şey için bunun yerine Word veya Google Docs kullanın.

Google Docs için kullanıcı kılavuzu şablonu var mı?

Yukarıdaki yapıyı bir Google Doküman’a kopyalayın ve şablon olarak ekip sürücünüze kaydedin. İş birliğiyle taslak hazırlamaya ve çevrimiçi okumaya uygundur; inceleme yorumları da gerçek bir avantajdır. Çok uzun kılavuzlarda Docs yavaşlayıp hantal hale geldiği için uzunluğu takip edin.

Bir kılavuz, rehber ve SOP arasındaki fark nedir?

Kılavuz kapsamlıdır ve tüm bir ürün ya da işi kapsar. Rehber, bir görevi baştan sona kapsar. SOP, kuruluşunuzun bir şeyi nasıl yaptığını belirleyen yetkili prosedürdür; okuyucunun öğrenmesi için değil, dahili uyumluluk için yazılır. Kılavuzlar genellikle rehberler içerir. SOP’ler, farklı bir onaylayıcıları olduğu için yan yana durur; kılavuzun içinde yer almaz.

Bir kılavuz ne kadar uzun olmalı?

Türünün gerektirdiği kadar uzun olmalı; bu işe yarar bir cevap değildir, o yüzden daha iyi bir test sunuyoruz. Bir haftadan kısa sürede güncelleyemediğiniz her kılavuz çok uzundur; çünkü güncellenmeyecektir. Bu genellikle içeriği kesmek yerine bölmeniz gerektiğine dair bir işarettir.

Kılavuzu kim yazmalı?

İşi kim yapıyorsa o yazmalı; belgeye kimin sahip olduğu belirliyse onun tarafından düzenlenmelidir. Görüşmelerden tamamen bir dokümantasyon ekibi tarafından yazılan kılavuzlar genellikle iyi yapılandırılır ama ayrıntılarda ince ince yanlış olur; uygulayıcılar tarafından tamamen yazılan kılavuzlar ise doğru olabilir ama kullanılamaz hale gelir. İkisi birlikte çalıştığında sonuç budur.

Kılavuz ne sıklıkla gözden geçirilmeli?

Takvime göre değil, tetikleyicilere göre. Açıklanan şey değiştiğinde, bir destek ya da servis modeli kılavuzun başarısız olduğunu düşündürdüğünde, bir düzenleme değiştiğinde ve kılavuzun sahibi ayrıldığında. Takvimli bir gözden geçirme, hiçbir şey değişmediğinde gelir ve bir şeyin değiştiği anı kaçırır.