Teknik bir el kitabı yazmak, adımları düzenlemeyi ve net, özlü ifadeler oluşturmayı içeren basit bir iştir. Teknik el kitabının amacı, en az adımda ve mümkün olan en açık şekilde bir işlemin nasıl gerçekleştirileceği hakkında bilgi sağlamaktır. Teknik el kitapları, konu uzmanları, editörler ve teknik yazarlar dahil çoğu insanın işbirliğini içerir. Teknik el kitapları da sürekli gözden geçirilip güncellenebildiğinden, ilgili taraflar arasındaki iletişim bir el kitabının geliştirilmesi için çok önemlidir.
Teknik kılavuzun stilini, basitleştirilmiş bir stil kılavuzu oluşturarak veya Teknik Kılavuzlar için Microsoft Stil Kılavuzu gibi mevcut bir stil kılavuzunu izleyerek belirleyin. Stil rehberi, kılavuzun iskeletini oluşturmaya yardımcı olacak ve tutarlılığı sağlayacaktır.
Bir fiil ile başlayan prosedür için adımları yazın. Adımları yazmak için istişare gerekiyorsa, görüşme yapın ve konu uzmanlarının sorularını sorun. Bu işlemlerin geçerliliğini sağlayacaktır; Aksi takdirde, adımlar mantıklı ve / veya sıra dışı olmayabilir. Adımlar mantıksal olarak sıralanmalı ve mantıksal bölümlere veya bölümlere ayrılmalıdır.
Gerektiren adımlara grafik ve illüstrasyon ekleyin. Her grafiğe / resme şekil numaralandırma ve başlık eklemeyi unutmayın.
Kolay başvuru için bir içindekiler tablosu ve bir dizin oluşturun.
Her bir değişikliği kaydeden bir değişiklik günlüğü veya güncelleme sayfası ekleyin ve gelecekteki revizyon ve sürümler için kılavuza güncelleyin. Teknik kılavuzlar her zaman teknik yazardan başka biri tarafından, tercihen profesyonel bir editör tarafından düzenlenmelidir.
