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:
- Kolibri
- Teknik yazar:
- StephDix
- Projenin adı:
- Kolibri Ekosistemi Belgeleme Stili ve İş Akışı Kuralları
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
Özet
Bu belgede, Stil yönergelerinin ve iş akışı yönetiminin, Learning Equality'nin Kolibri Ekosistem projesi için kaydettiği bilgilere uygulanması ayrıntılı bir şekilde açıklanmaktadır.
Genel bakış
Teklifim dört aşamadan oluşuyor. İlk aşamada, yazılım geliştirmede LE kavramlarını ve stil yönergelerini izleyerek erişilebilirlik yönergeleri, yazma ve biçim önerileri içeren LE Dokümanları Stil Kılavuzu'nu tamamlayacağım. İkinci aşamada ReadTheDokümanlar ve GoogleDokümanlar belgeleri üzerinde Kalite Denetimi gerçekleştireceğim. Denetim planı, Stil yönergeleriyle uyumluluğu değerlendirmek için kontrol listelerinin kullanımını entegre eder. Bu kontrol listeleri, bulguları kaydetmenize ve değişiklikleri belgelere uygulamanıza yardımcı olur. Üçüncü aşamada ReadTheDokümanlar ve GoogleDokümanlar belgelerindeki şablonların yapısı, görünümü ve tarzı üzerinde çalışacağım. Google Drive'da, gelecekteki uygulamalarda yeniden kullanılabilecek ana doküman türlerinin her şablon kategorisini tanımlayan bir şablon ve görüntü deposu oluşturacağım. Bu görevi, pull isteği incelemelerinde kolay tanımlama amacıyla belge sorunlarını göndermek için şablonlar oluşturarak tamamlayacağım. Son olarak, her bir ortak çalışan grubunun bilgiye erişim deneyimini geliştirmek üzere faydalı kaynakları gruplayacak bir Katkıda Bulunanlar Kılavuzu oluşturacağım.
Amaç ve kapsam
Bu uygulama planının amacı, Kolibri'nin belgelerini kullanan son kullanıcıların deneyimini iyileştirmek, ekip üyelerinin ve katkıda bulunanların daha iyi dokümanlar oluşturmalarına ve topluluk içinde aktif işbirliği yapmasına yardımcı olmaktır. Bu uygulama, ReadTheDokümanlar ve Kolibri Ekosistemi'ndeki Google Dokümanlar dokümanlarının alt kümeleri için geçerlidir.
Kitle
Kolibri belgelerinin en kritik tüketicileri olan uygulayıcılar, yöneticiler ve son kullanıcılardan oluşan birincil kitle. Kolibri belgelerinin üretimi ve kullanımı için ekip üyeleri ve ortak çalışanlardan oluşan ikincil kitle.
Hedefler
Kolibri Ekosistem Belgeleri için Stil Kılavuzu ve iş akışı sistemi, kullanıcıların: Erişilebilir bir dil ve tutarlı bir düzenle kolay anlaşılır belgeler oluşturmalarını bekler. Kalite uygulamalarının belgelenme üzerine sürdürülmesini sağlayın. Belgeleme kanalları arasında bilgiye kolay erişim sağlayın. Kolibri açık kaynak topluluğundaki iş birliğine dayalı girişimleri güçlendirin.
Bilgi kaynakları
Bilgi kaynaklarım, Google Drive'daki Kolibri, Kolibri Studio, Kolibri Development RTD dokümanları ve Kolibri Toolkit'ti.
Muhteşem Radina Matic, ısınma aktivitelerinin ve projeye özgü faaliyetlerin sağlanmasında çok yardımcı oldu. Kuruluşun "Yönergeler" ve "Rehberler" olarak tanımladığı kavramların yanı sıra katkıda bulunanlar için bir Rehber'in varlığıyla ilgili düşüncelerimi düzenlememe ve sonuç taslağı hazırlamama yardımcı oldu.
Yazılım
Stil Kılavuzu taslağını Google Dokümanlar'da geliştireceğim. Bu belge platformu, yayına hazır olduğunda yineleme işlemi için mükemmeldir. KG Denetimi için dokümanları yürütmek ve değerlendirmek için Google Formlar'ı kullanacağım. Bir e-tablo, doküman kontrolü için form yanıtlarını saklar. RTD belgelerini GitHub kullanarak yeniden düzenleyeceğim. Git, Gitkraken, GitHub ve Gitlab ile çalıştım. Markdown ve birkaç ReconfiguredText hakkında bilgi sahibiyim. Söz dizimini öğrenmeye devam edebilmek için doküman düzeltmelerine katkıda bulunmayı planlıyorum. Resimler ve gif'ler için Sharex'i kullanacağım. Bu aracı farklı çıktı biçimlerinde oluşturulduğu için seviyorum. Diyagramları diyagram oluşturma ve görsel basımı için kullanacağım. Diyagram yazılımı GoogleDokümanlar, Google Drive ve LibreOffice ile mükemmel bir şekilde entegre olur. Belgelerin durumu Keşif aşamasında, Kolibri'nin belgelerinin çoğunu gözden geçirdim. Proje belgelerinin çoğunda dil bilgisi hataları, yazım hataları, düzende tutarsızlıklar, tipografi ve resim kullanımı ile birlikte kafa karıştırıcı belge yolları buldum. Örneğin, Kolibri Kullanıcı Kılavuzu'ndaki sorun giderme bölümü bir konu değil, bir alt konudur. Bu bilgiler, son kullanıcıların içindekiler bölümünden bu bilgilere erişebilmeleri için yeterince kritik öneme sahiptir. İkinci bir alternatif olarak, diğer konuları genişletmek ve sorun giderme makalelerini bulmak için arama çubuğunu ve içindekiler ağacını kullanabilirler.
"Sorun Giderme" bölümüne erişmek için bölümü aramanız veya "Kolibri'yi Yönet"i genişleterek Sorun Giderme'nin dokümanın bir parçası olduğunu görürsünüz. Kılavuz ve Yönergeler Bu proje teklifi için iki belgeyi analiz ettim: LE Kolibri Kullanıcı Belgeleri Stil Kılavuzu ve LE Çeviri Yönergeleri. LE Kolibri Kılavuzu'nda, teklif ettiğim konu ana hatları ile Dokümantasyon planıma ve Rehber'de iyileştirilmesi gereken diğer birkaç noktaya dayalı öneriler ve yorumlar yaptım. LE Çeviri Yönergeleri için biçimi ve stili, önerilerime ve Stil Kılavuzu'ndaki mevcut kurallara göre değiştirdim. Analiz sırasında dikkatimi en çok çeken şey, Rehber ve Yönergeler olarak sınıflandırılan belgeler arasındaki yanılgıydı.
Sonuçlar
LE Çeviri Kılavuzu'nda kalite kontrolüne ek olarak, KG Denetimi görevinde daha ayrıntılı olarak açıkladığım bir ön formla öneri ve yorumlar yaptım. Değerlendirmeden elde edilen son yorumlardan bazıları şunlardır: ICU Söz Dizimi .js web sitesi için bozuk bağlantılar Bu Yönergeleri oluşturmak için kullanılan biçim yanlıştır. Belge Yönergeler değil, Rehberdir. Tutarsız tipografi. Başlıkların yanlış kullanımı, Dilin uygunsuz kullanımı ve kısaltmaların hatalı kullanımı. Alternatif metinlerin uygunsuz kullanımı. Aşırı tekrarlanan ifadeler/ talimatlar.
Her iki dokümanla ilgili bulgular, bu teklifin Teslimatlarının bir parçasıdır.
Projeye özgü görevler
- LE Kullanıcı Belgeleri Stil Kılavuzu önerileri (yorumlar)
- Yeni stil ve biçime sahip LE Çeviri Yönergeleri.
- Konu Özeti
- Proje takvimi
- Belgeleme görevleri