Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- LLVM Derleyici Altyapısı
- Teknik yazar:
- DR87
- Projenin adı:
- LLVM belge dizinini ve belgeleme stil kılavuzunu yeniden yapılandırma
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu proje aşağıdaki görevleri içerir:
a.) Belge dizini sayfasını daha kullanıcı dostu bir deneyim sunacak şekilde yeniden yapılandırın. Bu görev, mevcut sayfanın değerlendirilmesini ve bağımsız araştırmaların, SME görüşmelerinin ve kullanıcı geri bildirimlerinin bir kombinasyonuna göre yeniden yapılandırılmasını içerecektir. Olası seçenekler arasında kısa açıklamaların düzeltilmesi, mevcut sayfanın yeniden yapılandırılması ve/veya progresif bilgi açıklama modeliyle ek katmanlar (sayfalar) eklenmesi yer alır. İkincisi ise kullanıcıların belirli bilgileri/kılavuzları bulmalarını kolaylaştırmak için ana dizin sayfasındaki bağlantıların sayısını azaltır. Örneğin dizin, LLVM Tasarım ve Genel Bakış, Kullanıcı Kılavuzları, Alt Sistem Belgeleri ve Geliştirme Süreci Belgeleri için ayrı sayfalara bağlantılar içerebilir.
b.) Açık kaynaklı katkıda bulunanlar için LLVM Sphinx stil kılavuzunu güncelleyin. Bu görev mevcut rehberi değerlendirmeyi, bağımsız araştırmalar ve SME görüşmeleriyle boşlukları tanımlamayı ve üzerinde anlaşılan koşullara göre rehberi güncellemeyi içerir. Rehberin düzenini yeniden düzenleyebilir, yeni içerikler ekleyebilir ve katkıda bulunanlar rehberi gibi alakalı sayfalara bağlantı verebilirsiniz. Nihai hedef, gönüllülerin en kısa sürede katkıda bulunmaya başlamasını kolaylaştırmaktır.