Microsoft Learn stili ve sesli hızlı başlangıç

Bu hızlı başlangıç, Microsoft Learn'de yayımlanmak üzere teknik içerik yazmaya yönelik kısa bir kılavuzdur. Bu kılavuz, yeni bir belge oluştururken de mevcut belgeyi düzenlerken de geçerlidir.

En iyi yöntemler:

  • Denetlemek için Microsoft Word’e kopyalayıp yapıştırmanız gerekse bile makalelerinizin yazım ve dil bilgisi denetimini yapın.
  • Yüz yüze konuşuyormuşsunuz gibi günlük ve samimi bir dil kullanın.
  • Basit cümleler kullanın. Kolay okunabilen cümleler, okuyucuların paylaştığınız kılavuzu hızlı bir şekilde kullanabilmelerini sağlar.

Microsoft üslup ilkelerini kullanma

Microsoft Learn için teknik içerik yazarken bu ilkelere uymayı amaçlıyoruz. Her zaman başaramıyor olabiliriz ancak denemeye devam etmeliyiz!

  • Amaca odaklanın: Müşteriler, belirli bir amaçla belgelerimize başvurur. Yazmaya başlamadan önce müşterinin kim olduğunu ve ne yapmaya çalıştığını net olarak belirleyin. Daha sonra bu belirli müşterinin belirli görevi yerine getirmesine yardımcı olmak için makalenizi yazın.
  • Günlük kelimeler kullanın: Müşterilerinizin kullandığı kelimelerle doğal bir dil kullanmaya çalışın. Daha az resmi olun, ancak daha az teknik olmayın. Yeni kavramları açıklayan örnekler verin.
  • Kısaca yazın: Kelimeleri israf etmeyin. Olumlu cümleleri tercih edin ve fazla kelime veya niteleyici kullanmayın. Cümleleri kısa ve öz tutun. Makalenizin odağını kaybetmeyin. Bir görevin niteleyicisi varsa bunu cümlenin veya paragrafın başına koyun. Ayrıca olabildiğince az not ekleyin. Konuyu daha kısa bir şekilde anlatacaksa ekran görüntüsü kullanın.
  • Makalenizi kolay taranır yapın: En önemli şeyleri en başa koyun. Uzun yordamları daha yönetilebilir adım grupları halinde kümelemek için bölümler oluşturun. (12'den fazla adım içeren yordamlar büyük olasılıkla çok uzundur.) Netlik kattığında ekran görüntüsü kullanın.
  • Anlayışlı olun: Makale boyunca destekleyici bir üslup takının ve dürüst olun. Müşteriler için sinir bozucu olabilecek yerleri açık sözlülükle belirtin. Makalenin, müşteriler için önem taşıyan konulara odaklandığından emin olun, sadece teknik dersler vermeyin.

Yerelleştirme ve makine çevirisini göz önünde bulundurun

Teknik makalelerimiz pek çok dile çevrilir, bazıları ise belirli pazarlar ve coğrafyalar için değiştirilir. İnsanlar, makaleleri okumak için web’de makine çevirisi de kullanabilir. Bu nedenle makale yazarken aşağıdakilere dikkat edin:

  • Makalede hiçbir dil bilgisi, yazım veya noktalama hatası olmadığından emin olun: Bu, genel olarak yapmamız gereken bir şeydir. Markdown Pad 2.0 gibi bazı Markdown düzenleyicilerinin temel bir yazım denetleyicisi vardır ancak makaledeki işlenmiş HTML içeriğini kopyalayıp daha güçlü bir yazım ve dil bilgisi denetleyicisi olan Word’e yapıştırmak iyi bir uygulamadır.
  • Olabildiğince kısa cümleler kurun: Bileşik cümleler veya yan tümce zincirleri çeviriyi zorlaştırır. Çok fazla şey kaybetmeyecek veya tuhaf görünmeyecekse cümleleri ayırın. Makalelerin doğal olmayan bir dille yazılmasını istemeyiz.
  • Basit ve tutarlı bir cümle yapısı kullanın: Tutarlılık, çeviri için daha iyidir. Parantez içi cümlelerden kaçının ve özneyi mümkün olduğu sürece cümlenin başına koymaya çalışın. Yayımlanmış birkaç makaleye göz atın. Bir makale kolay ve okunaklı bir stile sahipse onu model olarak kullanın.
  • Tutarlı kelimeler ve büyük harfler kullanın: Tekrar belirtelim, tutarlılık çok önemlidir. Cümlenin başında veya özel isim olmayan hiçbir kelimeyi büyük harfle yazmayın.
  • “Küçük kelimeleri” unutmayın: Bağlama açıklık kazandırdığı için İngilizcede küçük ve önemsiz olarak değerlendirdiğimiz kelimeler (“a”, “the”, “that” ve “is” gibi) makine çevirisi için çok önemlidir. Bunları yazınıza eklediğinizden emin olun.

Dikkat edilmesi gereken diğer stil ve üslup sorunları

  • Yorum yapmak veya ekstra bilgi vermek için adımları bölmeyin.
  • Kod parçacıkları içeren adımlarda, adım hakkında ilave bilgileri koda yorum olarak girin. Böylece insanlar daha az metin okumak zorunda kalır. İnsanlar koda geri döndüğünde, kodun ne işe yaradığını öğrenebilmeleri için temel bilgiler kod projesine kopyalanır.
  • Tüm başlıklar ve bölüm başlıkları için normal cümle düzenini kullanın.
  • “Oturuma girmek” değil, “oturum açmak” ifadesini kullanın.
  • Başka yönergeler için bkz: Microsoft Yazma Stili Kılavuzu.

Yerelleştirilmiş belgeler

Not

Çoğu yerelleştirilmiş belge, GitHub aracılığıyla düzenleme veya geri bildirim sağlama olanağı sunmaz. Yerelleştirilmiş içerikle ilgili geri bildirim sağlamak için formu kullanın https://aka.ms/provide-feedback .

  • Last updated on