Genellikle jargon, kısaltmalar ve doktora gerektiren yönergeler ile dolu olan yazılım kullanım kılavuzları bazen kullanıcı yerine geliştirici bakış açısıyla yazılır. Sonuç olarak, rehber okuyucunun beceri düzeyi hakkında genellikle yanlış olan varsayımlarda bulunabilir. İyi bir kullanım kılavuzu yazmanın ilk adımı, gerçek yazma sürecini mühendislerden mümkün olduğunca uzağa almaktır.
Yazılım geliştiricisi, yazılımı çalıştıran şeyi herkesten daha fazlasını bilir, ancak geliştiricinin kılavuzu yazması gerektiği anlamına gelmez. Aksine, belirgin bir dezavantajdır. Yazılımın iç işleyişinin derinlemesine anlaşılmasından daha önemli olan, son kullanıcının kim olacağı, eğitim seviyesinin ne olduğu ve bu son kullanıcının yazılımı nasıl kullanacağı anlayışıdır. Çoğu durumda, son kullanıcıların programlamanın daha ince noktalarını ve yazılımın arka uç çalışmalarını bilmeleri gerekmez - işleri kolaylaştırmak için nasıl kullanacaklarını bilmeleri yeterlidir.
Kullanıcı Testi
Kullanıcı el kitabı, yoğun bir şekilde tanımlayıcı değil, büyük ölçüde görev odaklı olmalıdır. Kılavuz, kullanıcıların belirli görevleri nasıl yerine getireceklerini anlamalarına yardımcı olmak için yazıldığından, yazar bu görevleri de anlamalıdır ve sonuç olarak, her bir özelliğin her ayrık adımından geçmek kesinlikle gereklidir. Yazarın, programın bir tasarım veya geliştirme bakış açısıyla nasıl oluşturulduğunu bilmesi şart değildir, ancak tüm özellikleri hakkında güçlü bir çalışma bilgisine sahip olmak önemlidir. Her görevi yerine getirirken, tıklama, açılır menü ve diğer eylemler dahil her adımı yazmak için zaman ayırın.
Görüşme Süreci
Geliştiricinin el kitabını yazan kişi olmamasına rağmen, yazar için değerli bir kaynak olacaktır ve yazmaya başlamadan önce, yazar, geliştirici ve mühendisler ile potansiyel son kullanıcılar arasında bilgilendirme konusunda yardımcı olacak bir başlangıç toplantısı planlayın. yazarın baştan çalışması. Konu uzmanları ve mühendislerle yapılan görüşmeler, daha sonra başvurmak üzere yapılan transkriptlerle kaydedilmelidir.
tasvirler
Bir kullanım kılavuzu metin ağırlıklı olmamalıdır. Aksine, grafik ve ekran kliplerinin liberal kullanımını içerir. Bir eylemin açıklaması, bu yönü açıkça gösteren bir ekran klibin eşlik ettiği metin tabanlı yönlerle daha açıktır. Her bir işlem yapmadan önce ekranın nasıl göründüğünü ve işlem yapıldıktan sonra ne olduğunu göstermek için görünümlerden önce ve sonra ekleyin. Microsoft Windows'ta bulunan Snipping Tool gibi basit bir ekran yakalama programı, bu görüntüleri yakalamak için iyi çalışır. Her görüntüyü numaralandırdığınızdan ve kısa bir şekilde anlatan bir başlık eklediğinizden emin olun. İlk olarak resimde gösterilen kavramı tanıtan paragrafın hemen altına yerleştirin.
Biçimlendirme
Teknik bir belgede açık bir şekilde iletişim kurmak, rehber boyunca standartlara planlama ve dikkatli bir şekilde bağlı kalmayı gerektirir. Hem sunum, dil hem de terminolojideki standartlar karışıklığı önlemeye yardımcı olur. Şablonlar mevcuttur ve tek biçimlilik için iyi bir başlangıç noktası olabilir, ancak bunlar kesinlikle her duruma uyacak şekilde adapte edilebilir. Tek bir sütunlu bir inç kenar boşluğunun kullanılması, grafik ekleme gereksinimine en uygun olanıdır; iki sütunlu bir ayar çok kalabalık görünebilir ve görüntülerin yerleştirilmesini kafa karıştırıcı hale getirebilir.
Sürüm Oluşturma ve İzleme
Diğer herhangi bir belge türünden çok, bir yazılım kullanım kılavuzunun tamamlanmadan önce birden fazla yinelemeden geçmesi ve birden fazla paydaş tarafından bir inceleme sürecinden geçmesi muhtemeldir. Microsoft Word'deki Değişiklikleri İzle özelliğini kullanmak, her bir bireyin yorumlarını ve değişikliklerini takip etmenin kolay bir yoludur. Her gözden geçirme döngüsünden sonra, her biri farklı bir dosya adına sahip birden fazla sürüm oluşturmak, sürecin ilerlemesine yardımcı olur ve tüm paydaşların nihai sonuçtan memnun olmalarını sağlar.
