Kullanıcı Kılavuzları Yazma İpuçları

kafa karıştırıcı jargon kaçınmak ve açıklayanteknolojinin net , kesin bir açıklama üzerinde yoğunlaşarak ne olursa olsunkonu doğanın basit, sezgisel bir kullanıcı kılavuzu oluşturmanıza olanak sağlar . Manuel yazmadan önce , dikkatli biriçerik hazırlamak size öğretim nesir içine geliştirmek ve gerekli ayrıntıdüzeyini yargılayacak nasıl planlıyoruz . Her zamanokuyucu karmaşık , aşırı açıklamasına göre gömülmek hissettirmek için özen . İlk İzlenimler çizimler , espriler ve gereksiz ayrıntılarla dolu

bir çirkin , ağır , parlak renkli manuel bilegerekli sayfa açarak en okuyucuları kapalı koyacağız . Bu nedenle, kapak , büyüklüğü ve kılavuzun tasarımı ve ilk birkaç sayfa önemli bir rol oynamaktadır. Basit , bilgilendirici kapağı ve tanıtım oluşturun ve her zaman akıldagenel okuyucu tutmak . Etkili manuel hızlı ve kolay arama için ilgili bölüm başlıkları, sayfa numaraları ve alt doğru bir liste ile bir iyi yazılmış , kolay kullanımlı içindekiler sayfası olacaktır. Tasarımı ve Düzeni
Detayları

basit , geniş , siyah-beyaz ve - düzenleri ile sabit kopya kullanıcı kılavuzları okumak ve sindirimikolay olan . Bir manuelokuyucu söz konusuürün veya görev ( örneğin , talimatlar çalışmak ve bir mikrodalga onarmak için ) ile ilgili tümgerekli görevleri tamamlamak için izin için yeterli bilgi içermelidir , ama o olur o kadar büyük ve ayrıntılı teknik olmamalı ağır veev çevresinde taşımak için bu nedenle zor . Tasarım ve içerik arasındakidoğru dengeyi elde etmek için çalışıyoruz ; kötü tasarlanmış kavramlar ve kötü yazı ile güzel tasarlanmış bir kitabını oluşturmatuzağına düşmeyin . Aynı prensip herhangi diyagramlar ve görüntüler için de geçerli : basit, açık ,sayfa üzerinde iyi bir konuma ve ilgili tutun . PNG dosyaları küçük , yönetilebilir bir dosya boyutu var, ama netlik ve okunabilirlik içinyeniden görüntüyü kontrol etmeyi unutmayın.
Sizin Konu

Hepimiz kullanmış olamaz bilin aynı mikrodalga , bilgisayar veya kalemtıraş . Ekipman işin nasıl bir veya iki model net bir anlayış geliştirmek , daha sonra her bileşeni açıklayan nasıl iyi düşünmeye başlar . Standart terminoloji kullanın ve aslafarklı bileşenler için isimler makyaj. Bazı düzeydeöğenin bilgiye sahip amadetayları ile ekstra yardıma ihtiyacınız olursa her zaman olduğu gibi potansiyel okuyucuları tedavi ; aksi takdirde , kendi istihbarat hakaret ederek onları yabancılaştırmak riski olabilir . Mümkün olduğunca çok detay eklemek, ama basit ve samimi , yararlı bir şekilde sunmak .
Renk

Kodlama Eğertemel kılavuzuna ekleyebilir düşünüyorsanız , hafifçe renk kodu bazı gerçekleri oluşturulan vemetin boyunca onları bağlantı var . ( Floresan pembe kullanmak etmeyin, ışık sopa gibi pastel yeşil ve mavi gibi renkler basit . ) Bu bağlantı " indeksleme " türüdür ve insanların biliş kullanımı ve okumapsikolojisini yapar . Onları onlara düşünce bir basit veya "düz" manzara vermek yerine bir ekipman parçasınınişleyişi ve fonksiyonları daha iyi bir anlayış geliştirmek için olanak sağlar. Nesir
Farklı Stiller

geliştirilmesi ve yazı biraz farklı stilleri ile deney tarafından kılavuzunetkinliğini artırmak

. Katılanunsurların temel bir açıklama vererek ,giriş için kısa bir açıklayıcı paragraf halinde her bölüm ve aşağı alt bölümüne Break veilk paragraf belli tamamlamak için tam olarak nasılokuyucuya anlatmak için sonra sonra talimatlar adım adım kümesi ekleyebilirsiniz onarım veya fonksiyon . Kısa bir zaman alanı en bilgi aktarmanın Bu teknikel kitabı ve akışkan ilginç tutar. Bir kullanım kılavuzu oluşturmak için gelişmiş teknikler çalışıyor olsa bile , her zaman geritemelleri gitmek : bir düzenli olarak yazım , dilbilgisi , tutarlılık , dil ve biçimlendirmeyi kontrol

.