Proxmox teknik dokümantasyon için stil kılavuzunu paylaştı
Öne çıkanlar
- Teknik metinlerde Amerikan İngilizcesi ve etken çatı kullanımı standart olarak belirlendi.
- Okunabilirliği korumak için cümle uzunluğunun 15-20 kelime arasında tutulması tavsiye ediliyor.
- Yönerge adımlarında hedefin eylemden önce belirtilmesi ve emir kipi kullanılması kurala bağlandı.
Açık kaynaklı sanallaştırma platformu Proxmox, teknik dokümantasyon süreçlerini standartlaştırmak amacıyla resmi yazım stil kılavuzunu yayımladı. Kılavuz; açık, doğrudan ve gereksiz teknik terimlerden arındırılmış metin üretimini hedefleyen temel kuralları bir araya getiriyor.
Yayımlanan rehberde Amerikan İngilizcesi kullanımı zorunlu tutulurken etken çatı ve kısa cümle yapısı tavsiye ediliyor. Cümle uzunluklarının ortalama 15 ile 20 kelime arasında tutulması, işlem adımlarında hedefin eylemden önce belirtilmesi ve emir kipinin tercih edilmesi gerektiği aktarılıyor. Ayrıca başlıklandırma kuralları, Oxford virgülü kullanımı ve metin akışını bağlayan geçiş kelimelerine dair somut şablonlar yer alıyor.
Bu özet yapay zekâ ile hazırlanmıştır; ayrıntılar ve doğrulama için orijinal kaynağa başvurun.