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 Linux Foundation
- Teknik yazar:
- xiaoya
- Proje adı:
- CHAOSS D&I Rozet Projesi için Yapım Dokümanları
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Ana içeriği şu şekilde ekliyorum: Ana hedefler; iş akışı içinde belgeyle ilgili çalışmaları zenginleştirmek, topluluğun ilgisine yönelik bir D&I rozeti belgeleri yazmak ve çok dilli işlenmiş belgeleri özel platform üzerinde barındırmak. Bunlar, şu mikro görevlere ayrılabilir: Daha fazla D&I metriğinin kullanılması ve çeşitli soruların sorulması için mevcut Halkla İlişkiler şablonunu güncelleme ve entegre etme. D&I rozeti programını tanıtmak için kavramsal bir genel bakış taslağı hazırlayın Referans olarak JOSS dokümanlarını kullanarak başvuru sahibi yönergelerini hazırlayın Referans olarak JOSS dokümanlarını kullanarak inceleme uzmanı yönergelerini hazırlayın İş akışında farklı rolleri ve ilgili sorumlulukları açıklayan bir doküman. GitHub probot'un iş akışı için nasıl uygulandığını açıklayan bir doküman. Yeni katılanların projeye veya dokümana nasıl katkıda bulunabileceğini gösteren bir katkıda bulunan yönergesi. Belgelerin çeviri çalışmalarına yardımcı olma, özellikle Çince'de otomatik çevirinin performansını kontrol etme ve gerekirse manuel çeviri çalışmaları yapma. Çeviriyi esas alarak dokümanları çok dilli bir biçimde düzenlemek. Belgeyi barındırmak için Gitbook, Read the Doc veya GitHub Wiki'yi kullanın.
Teslim edilecek materyal 1. Proje ve etkinlik PR şablonunu daha fazla metrik ve çeşitli sorularla zenginleştirin. Bu teslimat, iş akışı içindeki tüm belgeyle ilgili çalışmaları, özellikle de başvuru sahiplerinin tamamlaması için hazırlanan PR şablonunu içeriyor. İnceleyenlerin değerlendirmesinde belirleyici bir rol oynadığı için iş akışının temel bileşeninin bu olduğunu düşünüyorum. Böylece, iş akışının yapısı boyunca soruların biçimi ve içeriği mükemmel hale gelecek.
Teslim edilecek materyal 2. Aşağıda, topluluğa yönelik bir doküman yapısı taslağı verilmiştir
D&I rozetine genel bakış
Giriş
Hedef
Rozet seviyeleri
Rozet başvurusu yapma
Etkinlik rozeti başvurusu yapma
Etkinlik PR şablonu
Proje rozeti başvurusu yapma
Proje PR şablonu
İnceleme
İnceleyici olma
D&I rozeti çıkar çatışması politikası
İnceleme ölçütleri
İnceleme yapılacaklar listesi
Roller ve sorumluluklar
Başvuranlar - PR oluşturma
İnceleyenler - PR'yi inceleme
Moderatörler - İncelemeleri ve inceleme atamalarını inceleme
Geliştirici - Son kontrol ve PR birleştirme
Probot
D&I rozeti davranış kuralları
Katkıda bulunma
Teslimat 3. Dokümanları çok dilli bir biçimde düzenleyin ve Read the Docs veya Gitbook gibi platformlarda barındırın.
Mevcut iş akışında bazı otomatik çeviri çalışmaları araştırılıyor. Özellikle Çince'de çevirinin doğruluğu ve akıcılığı gibi çeviri sonucunun ne kadar iyi gerçekleştirildiğini kontrol etmenize yardımcı olacağım. Belge bir formatta olacak. "Dokümanları okuyun, Gitbook ve GitHub wiki gibi teknik doküman barındırma platformlarını araştıracağım ve topluluğun gördüğü açık dokümanları barındırmak için en uygun platformu seçeceğim.