introkılavuzunu tanımlar . Belgeyi okumak ve dahil hangi bilgileri için ve hangi koşullarda demek değil kim yararlıdır kimin açıklayın . Ürün kılavuzları için ,okuyucuürünü satın ve nasıl kullanılacağını öğrenmek için hazırdır varsayalım . Kullanıcı mümkün olduğunca çabukkılavuzunteknik yönlerine alır bu yüzden kısatanıtım tutun .
Sıraladı
Teknik kılavuzlar genellikle bölümlere ve alt bölümlerde ortaya koydu , hangi de ideal bir taslağını yapmak . Kılavuzdaki tümplanlanan bölümleri listelemek ve gerekli olduğunda detaylı alt bölümler dahil. Eğer ilerleme olarakbölümleri yeniden düzenlemek için korkmayın . Eğer konu A düşündüm sırf ilkokuyucu ilk bilgilerin bu biraz ihtiyacı anlamına gelmez . Bölümlerinson siparişkonuyu öğrenirkenkullanıcı yapacakdoğal seyrini yansıtmalıdır . Bölümündeöğeyi ve eylem tanımlamak için başlıkbölümünde bir isim ve fiil kullanın .
teknik kılavuzunda her adımAktif talimatını olun diğer adımlara yapıldığında , tam bir eylem açan tek bir eylem okuyucu. Numaraadımlar veyaadımları göstermek için grafik " mermi " var. Bazı durumlarda ,adımlartemel adımlar altında sayı veya harf ile tanımlanır alt adımlar olabilir . Yazarlar adımları belirlemek konusunda bazı takdir yetkisine sahiptir , ancakkılavuzda tutarlı olmalıdır .
Basit
yeterlibilgileri aktarıyorbasit bir dil kullanın Keep It . Senkılavuzunu ve ne kadar iyikonununteknik jargon tecrübeli okuyacak kim bilmiyorum . Detay yüksek seviyelerde kaçının veyabilgiyi iletmek için gerekli değildir ayrıntıları. Uzun cümleler , 20'den fazla kelime , okuyucuları vazgeçirmek için eğilimindedir . Az 10 kelime Cümleler .
Belgeyi bir doğrama ses vermekTopic
konuyu göstermek için fotoğraflar, grafikler veya grafikler kullanın Illustrate edebilirsiniz . Bu görüntüler bin kelime değerinde olmalı veokuyucunun göz çizmek eğilimi olabilir . Grafik görüntüler mümkün değilse , açıklayıcı cümleler kullanın . Sözel örnekler ve çizimler deokuyucukonuyu görselleştirmek için izin verir.