Başka birine bir şeyi nasıl yapması gerektiğini söylemesi gereken bir belge yazmakla suçlandıysanız, bugünün yöntemini aşağı yukarı yapmak eski yöntemleri pencereden dışarı atar.
1. Büyük Bombastik Başlıklar
PCMech'teki başlıkların, bu cümlenin sağındaki gibi, çok büyük olduğunu fark edeceksiniz. Bunun nedeni, belgede nerede olduğunuzu görmeniz, okumanız ve bilmeniz daha kolay.
2. Daha Az Kelime
Yanlış yol:
Aşağıdaki belgeler Fanny Whacker 2000'in nasıl kullanılacağını ve kullanılacağını açıklamaktadır.
Doğru yol:
Fanny Whacker 2000'in kullanımı hakkında talimatlar
Dokümanları yazarken daima bu cümleyi hatırlayın: Mümkün olduğunca hızlı olarak noktaya gidin.
3. Yararsız referansları atla
Referansın, tarif etmeye çalıştığınız şeyin temel talimatıyla hiçbir ilgisi yoksa, örneğin:
Fanny Whacker 2000'in Şalgam Twaddler'ı hakkında daha fazla bilgi için, lütfen FU, ID10T altbölümüne bakınız.
… Bunu yapma.
4. Tarihleyin. Her zaman.
Belgelerin yazıldığı tarih, her sayfanın altbilgi alanında olmalıdır. Elektronik bir belge ise, tarih iki kez gösterilir. Bir kere başında, sonunda bir kere.
Bunu "Son Gözden Geçirilmiş (buraya tarih girin)" olarak yazabilirsiniz.
5. Uyarılar her zaman geri dönüş olmayan noktalara gönderilmelidir.
Dokümantasyonunuzda, yanlış yapıldığında bir şeyi potansiyel olarak hasara uğratabilecek / tahrip edebilecek / ortadan kaldırabilecek bir şey varsa, bu bilgiler doğrudan belirtilen talimattan sonra yerleştirilmeli, görüşün açık olmalı (aynı sayfada anlam ifade etmeli) ve vurgulanmalıdır.
Örnek:
Adım 5. Fanny Whacker 2000'in Temizlenmesi
FW2000'in kanatları aşındırıcı olmayan yumuşak bir bez kullanarak nazikçe temizlenmelidir.
UYARI: FW2000'in patlamasını ve zamansız ölümünüzle sonuçlanmasını önlemek için yalnızca amonyak içermeyen çözücü kullanın.
Son bir notta, iyi bir dokümantasyon hayal edilebilecek her şey hakkında süper tanımlayıcı olmaktan ibaret değildir. Belgelerinizi okuyun ve kendinize sorun, doğru talimat veriyor mu? Cevap evetse, bir sonraki soru hızlı bir şekilde talimat veriyor mu? Evetse, belgeler iyidir.
