2 puan yazan GN⁺ 2024-04-07 | 1 yorum | WhatsApp'ta paylaş

Yazıyı düzenlerken düşündüğüm şeyler

  • Metni doğru aktarın

    • Yazmaya başlamadan önce ne söylemek istediğinize karar vermelisiniz.
    • Konu, hedef okur gibi unsurları göz önünde bulundurarak yazının amacını netleştirin ve bunu belgenin üst kısmına not edin.
    • Yazma ve düzenleme sürecinde bu amaçla karşılaştırarak tutarlılığı koruyun.
  • Makul sınırlar içinde tekrar edin

    • Okurun konuyu anlayabilmesi için yazının başında ve sonunda konuyu yeniden doğrulayın.
    • Netlik için fiiller yerine isimler kullanarak tekrar etmek faydalı olabilir.
  • Basitleştirin

    • Gereksiz kelimeleri çıkarın ve cümleleri kısa tutun.
    • "Siz" veya "yapabilirsiniz" gibi ifadeleri kısa emir cümleleriyle değiştirin.
    • Uzun cümleleri daha kısa parçalara bölün ve virgülü uygun şekilde kullanarak okurun anlamasını kolaylaştırın.
  • Edilgen yapıyı kaldırın

    • Edilgen yapı, eylemi yapanı belirsizleştirir ve cümleyi daha az açık hale getirir.
    • Etken yapıya çevirmek cümleyi daha açık ve daha kolay anlaşılır kılar.
  • Zarfları kullanmayın

    • Zarflar yerine daha somut fiiller kullanın veya açıklama ekleyerek anlatın.
    • Zarflar çoğu zaman okura tam anlamı aktaramaz ve belirsizlik bırakır.
  • Bilginin zaten bilindiğini varsaymayın

    • Okurun bilmeyebileceği bilgiler için uygun arka plan açıklaması sağlayın.
    • Kısaltmaları ilk kez kullanırken açık hâlini yazın ve ek açıklama yapın.
  • Tonu fark edin

    • Yazının tonu tutarlı olmalı; samimi bir ton ile resmî bir tonu karıştırmayın.
  • Jargon ve klişelerden kaçının

    • Okurun kolay anlayabilmesi için doğru ifadeler kullanın.
    • Jargon, okur belirli bir grubun parçası değilse anlaşılması zor olabilir.
  • Boşluğu kullanın

    • Uzun paragrafları bölün; ara başlıklar, listeler ve tablolar kullanarak okunabilirliği artırın.
    • Önemli içerikleri kalın yazarak okurun ana noktaları kaçırmamasını sağlayın.

Sonuç

  • Yazıyı düzenlemenin temel ilkesi, anlamı açık biçimde aktarmak ve gereksiz kelimeleri çıkarmaktır.
  • Bu ilkeleri izlerken kendi tarzınızı ve tercihlerinizi geliştirebilirsiniz.
  • Düzenlemenin amacı, dil kullanımını düşünmek ve mesajı iletmek için uygun seçimler yapmaktır.

GN⁺ görüşü

  • Düzenleme sürecinde yazının amacını ve tutarlılığını korumak, her türlü yazı için önemli bir ilkedir.
  • Edilgen yapı kullanımı özellikle teknik belgelerde kaçınılması gereken bir üsluptur; etken yapıya geçmek açıklığı artırmaya yardımcı olur.
  • Zarflardan kaçınıp somut ifadeler kullanmak, yalnızca teknik belgelerde değil her türlü yazıda etkilidir.
  • Okurun bilmeyebileceği bilgiler için arka plan açıklaması sağlamak özellikle teknik belgelerde önemlidir; bu, okurun kavrayışını artırır ve belgenin erişilebilirliğini iyileştirir.
  • Boşluk ve görsel ayrımlar kullanmak, çevrimiçi içeriğin okunabilirliğini artıran önemli bir unsurdur.

1 yorum

 
GN⁺ 2024-04-07
Hacker News görüşleri
  • İlk yorumun özeti:

    • Yazar, kendi yazısının birçok insanla ortak bir karşılık bulmasından onur duyduğunu söylüyor.
    • Merakının peşinden giderek yazılım mühendisi olmuş ve birkaç yıl çalıştıktan sonra yazı odaklı bir rolü özlediğini fark etmiş.
    • Teknik becerilerle iletişim yeteneklerini birleştiren bir rol arıyor; kendisine web sitesi ve LinkedIn üzerinden ulaşılabilir.
  • İkinci yorumun özeti:

    • Teknik dokümanlarda kısaltmaların tanıtılmadan kullanılmasının rahatsız edici olduğu belirtiliyor.
    • Bu durum proje dokümanlarında tekrarlandığında ve ekip üyeleri değiştiğinde, kısaltmanın ne anlama geldiğini bilen kimse kalmayabilir.
    • Bazen tek çözüm, kısaltmayı özel isim gibi kabul edip kullanmayı sürdürmek olabiliyor.
  • Üçüncü yorumun özeti:

    • Teknik doküman gözden geçiren biri olarak pek çok kılavuz kullanmış.
    • Ek olarak, aynı şeye farklı adlar vermemeyi öneriyor.
    • Birden fazla yazar olduğunda terimler değişebiliyor ve bu da okuyucu için kafa karıştırıcı olabiliyor.
  • Dördüncü yorumun özeti:

    • "Edilgen çatıdan kaçının" tavsiyesine katılmıyor.
    • Edilgen çatı, bir eyleme bakış açısını değiştirebilen bir araçtır.
    • Edilgen çatı kullanıldığında, eylemin kaynağından söz edilip edilmeyeceğini seçmek mümkündür.
  • Beşinci yorumun özeti:

    • Kimin için yazdığına karar vermenin zor olduğunu söylüyor.
    • Teknik okuyucular, genel okuyucular ve teknik olmayan okuyucular gibi farklı kitleleri hesaba katmak gerekiyor.
    • Yazıyı daha fazla okuyucu için erişilebilir kılma çabası ile uzunluğu azaltma kaygısı arasında kaldığını belirtiyor.
  • Altıncı yorumun özeti:

    • Yazıyı geliştirme konusundaki tutkusunu ifade ediyor.
    • Listelerin önemine ve doğru kullanımına dair tavsiyeler veriyor.
  • Yedinci yorumun özeti:

    • "just" kelimesinin kullanımından kaçınılmasını öneriyor.
    • "just" basitlik ima eder, ancak gerçekte durum böyle olmayabilir.
  • Sekizinci yorumun özeti:

    • Yalnızca teknik dokümanlarda değil, bloglarda, e-postalarda ve benzerlerinde de boşluk kullanımının önemini vurguluyor.
    • Uzun paragraflar okumayı zorlaştırır ve insanların dikkatini kolayca dağıtabilir.
  • Dokuzuncu yorumun özeti:

    • Geçmişte bir MSP'de çalışırken iyi yazılmış üretim kılavuzlarının önemini fark ettiğini söylüyor.
    • Gazetecilikten edindiği deneyime dayanarak, dokümantasyon yazımına yardımcı olabilecek yönergeler arıyor.
  • Onuncu yorumun özeti:

    • Gelecek zaman kullanımından kaçınılmasını öneriyor.
    • Dokümanlarda "bunu yaparsanız ... olacaktır" yerine "bunu yaparsanız ... olur" demenin daha iyi olduğunu savunuyor.