Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Kolibri
- Teknik yazar:
- StephDix
- Proje adı:
- Kolibri Ekosistemi Belgeleme Stili ve İş Akışı Kuralları
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
Özet
Bu belgede, Kolibri Ekosistem projesi için Learning Equality'nin belgelenmiş bilgilerine stil yönergelerinin ve iş akışı yönetiminin uygulanması ayrıntılı bir şekilde anlatılmıştır.
Genel bakış
Teklifim dört aşamadan oluşuyor. İlk aşamada erişilebilirlik yönergeleri, yazım ve biçim önerileri içeren LE Dokümantasyon Stil Kılavuzu'nu tamamlayacağım. Burada yazılım geliştirmede LE kavramları ve stil yönergeleri takip edilecek. İkinci aşamada ReadTheDocuments ve GoogleDokümanlar dokümanları üzerinde bir Kalite Denetimi gerçekleştireceğim. Denetim planında, Stil kurallarına uygunluğu değerlendirmek için kontrol listeleri kullanımı entegre edilir. Bu kontrol listeleri, bulguları kaydetmeye ve değişiklikleri belgelere uygulamaya yardımcı olur. Üçüncü aşamada, ReadTheDokümanlar ve GoogleDokümanlar dokümanlarındaki ş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. Pull isteği incelemelerinde kolayca tanımlanabilmesi amacıyla doküman sorunlarını göndermek için şablonlar oluşturarak bu görevi tamamlayacağım. Son olarak, her bir ortak çalışan grubunun bilgiye erişme deneyimini geliştirmek için 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 yapmaları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 bir birincil kitle. Üretimleri ve Kolibri belgelerinin kullanımı için ekip üyeleri ve ortak çalışanlardan oluşan ikincil bir kitle.
Hedefler
Kolibri Ekosistem Belgeleri için Stil Kılavuzu ve iş akışı sistemi, kullanıcıların: Erişilebilir dil ve tutarlı bir düzenle kolay anlaşılır belgeler oluşturmalarını bekler. Kalite uygulamalarının belgelenmesinden sonraki aşamalarına özen gösterin. Belgeleme kanalları arasında bilgiye kolay erişim sağlayın. Kolibri açık kaynak topluluğundaki ortak çalışmaya dayalı girişimleri güçlendirin.
Bilgi kaynakları
Bilgi kaynaklarım Kolibri, Kolibri Studio, Kolibri Development RTD dokümanları ve Google Drive'daki Kolibri Toolkit'leriydi.
Muhteşem Radina Matic, ısınma aktivitelerinin yanı sıra projeye özel etkinlikler sağlamada da çok yardımcı oldu. Kuruluşun "Yönergeler" ve "Kılavuzlar" olarak tanımladığı görüşler ve katkıda bulunanlar için bir Rehber'in varlığı hakkındaki görüşlerim fikirlerimi düzenlememe ve çıkarımlarda bulunmama yardımcı oldu.
Yazılım
Google Dokümanlar'da Stil Kılavuzu taslağını geliştireceğim. Bu belge platformu, yayınlanmaya hazır olduğunda iterasyon için mükemmeldir. KG Denetimi için dokümanları yürütmek ve değerlendirmek için Google Formlar'ı kullanacağım. Doküman kontrolü için form yanıtları e-tabloda depolanır. RTD dokümanlarını GitHub'ı kullanarak yeniden düzenleyeceğim. Git, Gitkraken, GitHub ve Gitlab'de çalıştım. Markdown ve birkaç ReconfiguredText konusunda bilgim var. Söz dizimini öğrenmeye devam edebilmek için belge düzeltmelerine katkıda bulunmayı planlıyorum. Resimler ve GIF'ler için Sharex'i kullanacağım. Farklı çıktı biçimlerinde oluşturulduğu için bu aracı 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 ş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üzen, tipografi, resim kullanımında tutarsızlıklar ve ayrıca 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 İçindekiler ağacını kullanabilirler.
"Sorun Giderme" bölümüne erişmek için, söz konusu bölümü aramanız veya "Kolibri'yi Yönetin"i genişleterek söz konusu belgenin bir parçası olan Sorun Giderme Aracı'nı seçmeniz gerekir. Rehber 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, önerilen konu özetlerim ve Dokümantasyon planım ile ilgili öneriler ve yorumlar yaptım. Ayrıca Rehber'de iyileştirilmesi gereken diğer birkaç noktayı ele aldı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 dokümanlar arasındaki yanlış kanı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ış. Doküman bir Yönerge değil, Rehber. Tutarsız tipografi. Başlık ve başlıkların yanlış kullanımı, Uygunsuz dil kullanımı ve kısaltmaların hatalı kullanımı. Alternatif metinlerin uygunsuz kullanımı. Tekrarlanan ifadelerin veya talimatların üstünde.
Her iki belgeyle ilgili bulgular, bu teklifin Teslim edilecek bölümünün bir parçasıdır.
Projeye özgü görevler
- LE Kullanıcı Belgeleri Stil Kılavuzu önerileri (yorumlar)
- Yeni stil ve biçimle LE Çeviri Yönergeleri.
- Konu Özeti
- Proje takvimi
- Belgeleme görevleri