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:
- LLVM Derleyici Altyapısı
- Teknik yazar:
- DR87
- Projenin adı:
- LLVM belgeleri dizinini ve belgeleme stil kılavuzunu yeniden yapılandırma
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu proje aşağıdaki görevleri içerir:
a.) Daha kullanıcı dostu bir deneyim sunmak için doküman dizini sayfasını yeniden yapılandırın. Bu görevde, mevcut sayfa değerlendirilecek ve bağımsız araştırma, KOBİ görüşmeleri ve kullanıcı geri bildirimlerinin bir kombinasyonuna göre yeniden yapılandırılacak. Olası seçenekler arasında kısa açıklamaların düzeltilmesi, mevcut sayfanın yeniden yapılandırılması ve/veya progresif bir bilgi açıklama modeli aracılığıyla daha fazla katman (sayfa) eklenmesi yer alır. İkinci seçenek, kullanıcıların belirli bilgileri/rehberleri daha kolay bulabilmesi için ana dizin sayfasındaki bağlantı sayısını azaltır. Örneğin, dizin; LLVM Tasarım ve Genel Bakış, Kullanıcı Kılavuzları, Alt Sistem Dokümanları ve Geliştirme Süreci Dokümanları için ayrı sayfaların bağlantılarını içerebilir.
b.) Açık kaynak katkıda bulunanlar için LLVM Sphinx stil kılavuzunu güncelleyin. Bu görev kapsamında mevcut kılavuz değerlendirilecek, bağımsız araştırmalar ve SME görüşmeleri aracılığıyla boşluklar tespit edilecek ve kılavuz, üzerinde anlaşmaya varılan şartlara göre güncellenecektir. Güncellemeler arasında kılavuzun düzeninin yeniden düzenlenmesi, yeni içerik eklenmesi ve katkıda bulunan rehberi gibi alakalı sayfalara bağlantılar eklenmesi yer alabilir. Nihai hedef, gönüllülerin mümkün olan en kısa sürede katkıda bulunmaya başlamalarını kolaylaştırmaktır.