Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- The Julia Language
- Teknik yazar:
- mkg33
- Projenin adı:
- Scientific Machine Learning'in birleşik dokümanları
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Bu alanda iyileştirme için çok fazla alan olduğu ve bu projenin tamamlanmasının hem Julia programcılarına hem de SciML'nin etkin katkıda bulunanlarına/yöneticilerine anında fayda sağlayacağı için SciML kuruluşunun birleştirilmesi üzerinde çalışmak istiyorum. SciML'de bulunan paketler gerçekten yararlı araçlar sunar ancak kullanıcının paketi keşfedememesi ve mevcut soruna uygulayamaması nedeniyle, bu paketlerin (özellikle yeni gelenler tarafından) gözden kaçma tehlikesi her zaman vardır.
Paketlerin temel amacı geniş bir programcı (yeni başlayanlar ve uzmanlar) kitlesine ulaşmak olduğundan bu oldukça sinir bozucu. Yukarıda açıklanan durumu önlemek için SciML dokümanlarının "ön sayfasını" ayrıntılı bir şekilde gözden geçirmeyi ve kullanıcıların ilgili paketlere göz atmak ve büyüyen ekosistemi keşfetmek için kullanabileceği bir tür merkez oluşturmayı öneriyorum. Ayrıca daha deneyimli kullanıcılar için değerli bir referans noktası olabilir ve daha verimli çalışmalarını sağlayabilir.
Öncelikle, tüm paketlerin mevcut belgelerinin en temel stil sorunlarına (yazım, noktalama, dil bilgisi vb.) göre düzeltilmesi gerekir. Stil tutarlılığını sağlamak için SciML'de somut bir stil kılavuzu olmalıdır (geçmişe dönük değişiklikler yapmak ve gelecekte referans olarak kullanmak için gereklidir). Baştan başlamak zaman kaybı olur. Bunun yerine, mevcut Julia kurallarına dayalı olmalı ve SciML'ye özgü sorunlar için yeni girişler içermelidir.
Stil kılavuzu tamamlandıktan sonra projenin ikinci aşamasında mevcut belgeleri gözden geçirmeyi planlıyorum. Belgelerin daha profesyonel ve istikrarlı görünmesini sağlar. Bu göreve yaklaşımımı gösteren birkaç çekme isteği oluşturdum. Bu aşamada, etkili bir alıntı sistemi de tasarlamak (ve uygulamak) istiyorum. İlk görev, eski alıntılar sayfasını güncellemektir.
Muhtemelen en önemlisi olan üçüncü aşama, dağılmış paketler arasındaki etkileşimi vurgulayacak SciML yol haritasını tasarlamayı içeriyor. İki paket arasındaki uyum ne kadar güçlü olursa (sorun veya kodun kendisiyle ilgili olarak) bunlar "bkz. ayrıca" listesinde görüntülenmelidir. Bir kod benzerliği ve bir sorun benzerliği olmak üzere iki öneri anahtarı oluşturmayı öneriyorum. Bu sayede kullanıcılar, ilgili depolara ve dokümanlara göz atarak bulmaktan çok daha hızlı bir şekilde yararlı olabilecek diğer paketleri belirleyebilir. Paketler arasındaki tüm olası bağlantıları listelemek yerine, daha büyük paketlere odaklanmayı ve bu paketlerin daha küçük paketlerle bağlantılarını sunmayı tercih ediyorum (bu yöntem, başka bir paketle bağlantının belirtilmesi gereken eğitici içeriklerin güncellenmesini de kapsayacak şekilde genişletilecek). Bu yaklaşım, "bkz." listelerinin paket kombinasyonlarının kapsamlı bir listesi olmadan bilgilendirici olmasını sağlar.