Toss, Technical Writing Rehberini Yayınladı

İyi teknik dokümantasyon yazmanın temel ilkeleri

1. Doküman türünü belirlemek

Dokümanın amacına göre daha etkili yazma yöntemi değişir

• Öğrenme odaklı doküman: Yeni bir teknoloji veya araçla ilk kez karşılaşıldığında, genel akışı kavrama amacı
• Sorun çözme dokümanı: Arka plan bilgisi varken belirli bir problemi çözme amacı
• Referans dokümanı: Kullanım yöntemini zaten bilirken, belirli bir özellik ya da API kullanımını doğrulama amacı
• Açıklayıcı doküman: Kavramları, ilkeleri ve arka plan bilgisini ayrıntılı olarak anlama amacı

2. Bilgi yapısı oluşturmak

Yeni bilgiyi anlamak çaba gerektirir, ancak bilgi yapılandırılırsa bu çaba azaltılabilir

• Bir sayfada yalnızca tek bir konu ele alınmalı
• Önce değer sunmak
• Etkili başlıklar yazmak
• Genel bakışı atlamamak
• Öngörülebilir hale getirmek

3. Cümleleri iyileştirmek

Cümlelerin anlatım gücü artırılırsa okuyucu içeriği daha kolay anlayabilir. Ayrıntılar anlaşılması zor cümlelerle ifade edilirse anlatım gücü büyük ölçüde düşer

• Cümlenin öznesini açık hale getirmek
• Yalnızca gerekli bilgiyi bırakmak
• Somut yazmak
• Doğal Türkçe ifadeler kullanmak
• Tutarlı yazmak

[tested]

Toss'un yaptığı bunun gibi sitelerin toplandığı bir yer yok mu?

[dontdieych]

-yo üslubuna alışmak zor.

[gera1d]

Kesinlikle doğru.

[winterjung]

Güzel olmuş, özellikle cümle düzeltme kısmını few-shot ile GPT'lerde oluşturup kullanmayı denemek istiyorum.

[mathgig]

Böyle yazılar bence güzel. LLM çağında bu tür yönergeler nasıl dönüşebilir?

[bluejoyq]

Gerçekten çok güzel bir proje ^^