Teknik Yazı Belgelerinin Ana Hatları. İyi yazılmış bir belge tesadüfen yaratılmamıştır. Raporda yer alan materyal, el kitabı veya başka bir teknik belge planlanır, düzenlenir ve ardından yazılır. Bir belgenin ana hatları önemli bir adımdır ve eğer bir taslak oluşturulmazsa, bilgiler mantıksal olarak sunulmayacaktır. Taslak, yazara dahil edilmesi ve içermemesi gereken bilgiler hakkında düşünme fırsatı verir.
Fikirlerinizi beyin fırtınası. Anahatınıza teknik belgeye dahil edilmesi gerektiğini düşündüğünüz herhangi bir fikri yazın. Bilginin sırası ile ilgilenme. Sadece tüm bilgilerin beyin fırtınası sürecine dahil edilmesi önemlidir.
Teknik belgenin amacını belirleyin. Kendinize belgeyi kimin okuyacağı, neden okunacağı ve nasıl kullanılacağı gibi sorular sorun.
Ne tür bir taslak oluşturmak istediğinize karar verin: tarihsel, kronolojik, geneline özgü, küçükten büyüğe, karmaşıktan basit veya içeriğe uygun başka bir form. İzleyicileri ve sunmak istediğiniz bilgileri düşünün. Bilginin düzenlenme şeklinin, sunulan bilginin türüne ve teknik belgeyi okuyacak olan izleyiciye en anlamlı olduğundan emin olun.
Bilgileri uygun sıraya göre düzenleyin. Bir taslak, bilgiyi mantıksal bölümlere ve seviyelere ayırmayı içerir. Ana başlıklar, alt başlıklar ve alt alt başlıklar oluşturabilirsiniz.
Konuların uygun ve mantıklı bir şekilde organize edildiğini doğrulamak için bilgileri gözden geçirerek taslağı tamamlayın. Önemli gerçekleri kaçırmadığınızdan emin olun. Teknik dokümanla ilgili olmayan bilgileri silin.
