Bir mucit, programcı veya akılcı ne kadar usta olursa olsun, bazen yarattıkları amaçlanan amaç için kullanılamaz. Bunun nedeni, yanlış hazırlanmış kullanım kılavuzu veya tamamen yokluğudur. Ancak usta mucitler bile bazen öyle talimatlar yazarlar ki, dar uzmanlar dışında hiç kimse bu kağıtları okuyamaz. Peki bu kadar gerekli bir belgeyi nasıl düzgün bir şekilde hazırlarsınız?
Bu gerekli
- - kılavuzun yazıldığı cihaz veya yazılım ürünü hakkında yüzde yüz bilgi;
- - dilbilim alanında bilgi;
- - yazma Becerileri.
Talimatlar
Aşama 1
Kullanım kılavuzu veya başka bir deyişle kullanım kılavuzu, kullanıcılarına belirli bir sistemi kullanma konusunda yardım sağlamak için tasarlanmış bir belgedir. Bir kullanım kılavuzu derlemek için anlatılan sistemi yüzde yüz bilmeniz, ancak ona cahil bir öğrencinin gözünden bakmanız gerekir. Henüz benzeri olmayan bir yazılım yardımcı programı için bir kullanım kılavuzunun yazıldığını varsayalım. Bu programı ilk kez kullandığınızı hayal edin. Nereden başlarsın? Bilinmesi gereken ilk şey nedir? Bu bilgiyi önem kategorilerine göre düzenleyin.
Adım 2
Yaratılışınızla ilgili tüm bilgileri gruplara ayırarak bir kullanım kılavuzu yazmak için bir plan hazırladınız. Yeniden programlama özellikleri veya kritik hatalarla uğraşma gibi en zor ayrıntıları en sona bırakarak programınızdaki çalışmayı sıfırdan tanımlamaya başlayın. Bu aşamada, bu belgenin gerekli bölümlerinden biri olan kullanım kılavuzunun içeriği hazır olmalıdır.
Aşama 3
Oluşturduğunuz kılavuz büyük bir şirkette kullanılmak üzere tasarlanmışsa, orada benimsenen kurumsal standartlara dikkat etmelisiniz. Örneğin, birçok Rus şirketinde, açıklayıcı destek olmadan kullanım kılavuzları, başka bir deyişle yazılanları açıklayan resimler kabul edilmez. İçeriğe ek olarak, kullanım kılavuzu diğer zorunlu bölümleri içermelidir: - Açıklama, yani kılavuzun ve açıklanan ürünün genel amaçlarının bir açıklaması; - Kullanım kılavuzu ile ilgili belgeleri ve nasıl yapıldığını açıklayan bir giriş. kılavuzu kullanmak için; - örneğin, ilk adımlar, onarım veya bakım gibi, kullanımının farklı aşamalarında ürünün kullanımını açıklayan bölümler; - sık sorulan sorular ve bunlara verilen yanıtlar bölümü; - sözlük veya konu dizini.
4. Adım
Genellikle, teknik bir yazar, bir kullanım kılavuzunun oluşturulmasında yer alır - hem dilde hem de açıklanan üründe gerekli tüm bilgilere sahip bir kişi. Eğitimsiz bir teknik yazar olarak akılda tutulması gereken birkaç kural vardır. İlk olarak, sıradan bir kullanıcının anlayamayacağı özel terimleri kötüye kullanmamalısınız. İkinci olarak, kullanılan her terim ayrıntılı ve açıklanmalıdır. Üçüncüsü, mümkün olduğunca açık ve özlü bir şekilde yazmanız gerekir. Son olarak, teknik bir yazar, kendi metninin eksikliklerini görebilmek için sıradan bir kullanıcının gözünden kendi metnine bakabilmelidir.
Adım 5
Kullanım kılavuzunun bitmiş metnini, açıklanan ürünle ilgisi olmayan bir kişiye sunarak pratikte test etmek iyidir. Ortak çabalarla, belgenin tüm eksikliklerini ve tuzaklarını ortadan kaldırmak mümkündür.
