Üslup ve ton yönergeleri

BT uzmanları ve geliştiriciler dahil olmak üzere geniş bir kitle, .NET yazılımını öğrenmek ve bunu kendi işlerinde kullanmak için .NET belgelerini okumaktadır. Amacınız, kullanıcıya bu doğrultuda yardımcı olacak mükemmel belgeler oluşturmaktır. Yönergelerimiz size bu konuda yardımcı olur. Stil kılavuzumuzda aşağıdaki öneriler yer almaktadır:

Konuşma tonu kullanma

Aşağıdaki paragraf, konuşma stilinde yazılmıştır. Sonraki paragrafsa daha akademik bir stilde yazılmıştır.

Uygun stil

Belgelerimizin konuşma tonunda olmasını istiyoruz. Öğreticilerimizden veya açıklamalarımızdan birini okurken, yazarla muhabbet ediyormuş gibi hissetmelisiniz. Sizin için bu deneyim resmi olmamalı, konuşma havasında ve bilgi verici olmalıdır. Okuyucular, makaleyi yazan kişinin kavramları açıklamasını dinliyor gibi hissetmelidir.

Uygun olmayan stil

Teknik hususların konuşma stili ile ifadesi ve akademik olarak ele alınması arasındaki fark büyüktür. Bu kaynaklar da oldukça kullanışlı olmakla birlikte bu tür makalelerin yazar tarafından ele alınış şekli, belgelerimizde olmasını istediğimiz stilden çok uzaktır. Akademik bir dergiyi okurken çok farklı bir ton ve çok farklı bir yazılış stili göze çarpar. Okuyucu, sıkıcı bir konunun sıkıcı bir açıklamasını okuyor gibi hisseder.

İkinci şahıs kullanımı

Aşağıdaki paragrafta ikinci şahıs kullanılmaktadır. Sonrasındaki paragrafta üçüncü şahıs kullanılmaktadır. Lütfen ikinci şahıs kullanarak yazın.

Uygun stil

Makalelerinizi, doğrudan okuyucuyla konuşuyormuş gibi yazın. Sıklıkla ikinci şahıs ifadeleri kullanın (tıpkı bu iki cümlede olduğu gibi). İkinci şahıs, yalnızca “siz” sözcüğünü kullanmak demek değildir. Doğrudan okuyucuya yazın. Emir cümleleri yazın. Okuyucunuza ne öğrenmesini istediğinizi anlatın.

Uygun olmayan stil

Bir yazar, üçüncü şahsı kullanarak da yazmayı seçebilir. Bu durumda yazar, kullanıcıya hitap ederken kullanacak bir zamir veya isim bulmak zorunda kalır. Okuyucular bu üçüncü şahıs stilini genellikle pek cazip ve keyifli bulmazlar.

Etken çatı kullanımı

Makalelerinizi etken çatı kullanarak yazın. Etken çatı, cümlede eylemi (fiili) gerçekleştirenin özne olması anlamına gelir. Bunun zıttı edilgen çatıdır. Bu cümleler, özneyi eylemsiz kılacak şekilde oluşturulur. Şu iki örneği karşılaştırın:

Derleyici, kaynak kodunu yürütülebilir bir dosyaya dönüştürdü.

Kaynak kodu, derleyici tarafından yürütülebilir bir dosyaya dönüştürüldü.

İlk cümlede etken çatı kullanılmıştır. İkinci cümle ise edilgen çatıyla yazılmıştır. (Bu iki cümle de bu çatılara birer örnektir.)

Daha kolaylıkla okunduğundan, etken çatıyı öneriyoruz. Edilgen çatıyı okumak biraz daha zor olabilir.

Sözcük dağarcığı kısıtlı olabilecek okuyucuların anlayabileceği biçimde yazın

Makaleleriniz, uluslararası bir kitleye ulaşıyor. Okuyucularınızın çoğunun anadili İngilizce değildir ve sizin kadar zengin İngilizce kelime dağarcığı olmayabilir.

Bununla birlikte, yine de teknik uzmanlara yönelik makaleler yazıyorsunuz. Okuyucularınızın programlama bilgisine ve programlamayla ilgili kelime haznesine sahip olduğunu varsayabilirsiniz. Nesneye Dayalı Programlama, Sınıf, Nesne, İşlev ve Metot gibi terimlere okuyucular aşinadır. Ancak makalelerinizi okuyan herkesin bilgisayar bilimiyle ilgili resmi bir diploması olmayabilir. “Bir kez etkili” gibi terimleri kullanırken açıklama yapmanız gerekebilir; örneğin:

Close() metodu bir kez etkilidir, yani metoda birden fazla çağrı yapsanız bile metot, bir kez çağrı yapmış gibi etki gösterir.

Gelecek zaman kullanımından kaçınma

Bazı dillerde gelecek zaman kullanımı İngilizceyle aynı değildir. Gelecek zaman belgelerinizin okunmasını zorlaştırabilir. Ayrıca gelecek zaman kullanıldığında “Ne zaman?” sorusu ortaya çıkar. “PowerShell’i öğrenmek sizin için faydalı olacaktır” dediğinizde okuyucu doğal olarak bunun ne zaman faydalı olacağını merak eder. Bunun yerine sadece “PowerShell’i öğrenmek sizin için faydalıdır” deyin.

Bu nedir - Bu ne anlama geliyor?

Okuyucuya yeni bir kavram sunduğunuzda önce kavramı tanımlayın, bunun neden kullanışlı olduğunu ise daha sonra açıklayın. Okuyucunun bir şeyin faydalarından önce onun ne olduğunu anlaması önemlidir.