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:
- Kolibri
- Teknik yazar:
- StephDix
- Proje adı:
- Kolibri Ekosistem Dokümantasyon Stil ve İş Akışları kuralları
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Soyut
Bu belgede, Learning Equality'nin Kolibri Ekosistemi projesi için belgelenen bilgilerine Stil yönergeleri ve iş akışı yönetiminin uygulanması anlatılmaktadır.
Genel Bakış
Teklifimiz dört aşamadan oluşuyor. İlk aşamada, LE dokümantasyon stil kılavuzunu, yazılım geliştirmedeki LE kavramlarına ve stil kurallarına uygun erişilebilirlik yönergeleri, yazım ve biçim önerileriyle tamamlayacağım. İkinci aşamada ReadTheDocuments ve Google Docs belgeleri üzerinde bir Kalite Denetimi gerçekleştireceğim. Denetim planında Stil yönergelerine uygunluğun değerlendirilmesi için kontrol listelerinden yararlanılır. Bu kontrol listeleri bulguların kaydedilmesine ve değişikliklerin belgelere uygulanmasına yardımcı olacaktır. Üçüncü aşamada, ReadTheDocs ve Google Dokümanlar dokümanlarındaki şablonların yapısı, görünümü ve tarzı üzerinde çalışacağım. Yaklaşan uygulamalarda yeniden kullanılmak üzere ana doküman türlerinin her şablon kategorisini tanımlayan bir şablon ve resim deposu oluşturacağım. Bu görevi, çekme isteğinde bulunma incelemelerinde kolayca tanımlanabilmeleri için doküman sorunlarını göndermek üzere şablonlar oluşturarak tamamlayacağım. Son olarak, bilgi erişimi deneyimlerini iyileştirmek için her ortak çalışan grubuna yönelik faydalı kaynakları gruplandıracak bir Katkıda Bulunanlar Rehberi oluşturacağım.
Amaç ve kapsam
Bu uygulama planının amacı, Kolibri'nin dokümanlarını kullanan son kullanıcıların deneyimini iyileştirmek ve ekip üyelerinin ve katkıda bulunanların daha iyi dokümanlar oluşturmasına ve toplulukta aktif bir şekilde 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
Uygulayanlar, yöneticiler ve son kullanıcılardan oluşan birincil hedef kitle, Kolibri belgelerinin en kritik tüketicileridir. Kolibri dokümanlarını üreten ve kullanan ekip üyelerinden ve ortak çalışanlardan oluşan ikincil kitle.
Hedefler
Kolibri Ekosistemi Dokümanları için Stil Kılavuzu ve iş akışı sistemi, kullanıcılardan şunları yapmasını bekler: Erişilebilir bir dil ve tutarlı bir düzenle kolayca anlaşılır dokümanlar oluşturma. Belgelerde kalite uygulamalarının korunmasını sağlayın. Doküman kanalları arasında bilgilere kolayca erişilmesini sağlayın. Kolibri açık kaynak topluluğundaki ortak çalışma girişimlerini güçlendirin.
Bilgi kaynakları
Bilgi kaynaklarım Kolibri, Kolibri Studio, Kolibri Development RTD dokümanları ve Google Drive'daki Kolibri Toolkits'ti.
Mükemmel Radina Matic, ısınma etkinlikleri ve projeye özel etkinlikler sunma konusunda bize çok yardımcı oldu. Kuruluşun "Kurallar" ve "Rehberler" olarak neleri düşündüğü ve katkıda bulunanlara yönelik bir rehberin varlığıyla ilgili olarak verdiği bilgiler, fikirlerimi düzenlememe ve sonuç taslağı oluşturmama yardımcı oldu.
Yazılım
Stil Kılavuzu taslağını Google Dokümanlar'da geliştireceğim. Bu doküman platformu, yayınlanmaya hazırken iterasyon yapmak için mükemmeldir. Kalite Kontrol Denetimi için dokümanları yürütmek ve değerlendirmek üzere Google Formlar'ı kullanacağım. Bir e-tabloda, doküman kontrolü için form yanıtları depolanır. GitHub'ı kullanarak RTD dokümanlarını yeniden yapılandıracağım. Git, Gitkraken, GitHub ve Gitlab ile çalıştım. Markdown ve RestructuredText hakkında bilgi sahibiyim. Söz dizimi öğrenmeye devam etmek için doküman düzeltmelerine katkıda bulunmayı planlıyorum. Resimler ve GIF'ler için Sharex'i kullanacağım. Farklı çıkış biçimlerinde oluşturma özelliğinden dolayı bu aracı seviyorum. Diyagramları diyagram ve görüntü sürümü için kullanacağım. Şemalar yazılımı Google Dokümanlar, Google Drive ve LibreOffice ile mükemmel bir şekilde entegre olur. Dokümanların durumu Keşif aşamasında, Kolibri'nin dokümanlarının çoğunu düzelttim. Proje dokümanlarının çoğunda dil bilgisi hataları, yazım hataları, düzen, yazı tipi ve resim kullanımıyla ilgili tutarsızlıklar ve ayrıca kafa karıştırıcı doküman yolları tespit ettik. Örneğin, Kolibri'nin Kullanıcı Kılavuzu'nda sorun giderme bölümü bir konu değil, alt konudur. Bu bilgiler, son kullanıcıların içindekiler bölümünden erişebileceği kadar önemli bilgilerdir. İ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 bu bölümü aramanız veya "Kolibri'yi yönetin"i genişleterek "Sorun giderme"nin dokümanın bir parçası olduğunu fark etmeniz gerekir. Kılavuz ve yönergeler Bu proje önerisi için iki belgeyi analiz ettim: LE Kolibri Kullanıcı Dokümanları Stil Kılavuzu ve LE çeviri yönergeleri. LE Kolibri Kılavuzu'nda, önerdiğim konu ana hatları ve doküman planı ile birlikte kılavuzda iyileştirilmesi gereken diğer birkaç konuda öneri ve yorumda bulundum. LE Çeviri Kuralları için biçim ve stili, önerilerime ve Stil Kılavuzu'ndaki mevcut kurallara göre değiştirdim. Analiz sırasında en çok dikkatimi çeken şey, Rehber ve Yönergeler olarak sınıflandırılan belgeler arasında bulunan yanlış kanıydı.
Sonuçlar
Ön form kullanarak öneri ve yorumlara ek olarak LE Çeviri Kılavuzu'nda kalite kontrolü yaptım. Bu ön formu, QA denetimi görevinde daha ayrıntılı olarak açıklayacağım. Değerlendirmeden elde edilen bazı nihai yorumlar şunlardır: ICU Syntax .js web sitesi için bozuk bağlantılar Bu yönergeleri oluşturmak için kullanılan biçim yanlıştır. Doküman Kurallar değil, Rehber'dir. Tutarsız yazı tipi. Başlıkların ve başlıkların yanlış kullanımı, dilin ve kısaltmaların yanlış kullanımı. Alternatif metinlerin uygunsuz kullanımı. Yinelenen ifadeler/ talimatlar.
Her iki dokümanla ilgili bulgular, bu teklifin "Teslim Edilecek Ürünler" bölümünün bir parçasıdır.
Projeye özel görevler
- LE Kullanıcı Dokümanları Stil Kılavuzu önerileri (yorumlar)
- Yeni stiller ve biçimle LE Çeviri Kuralları.
- Konu Özeti
- Proje zaman çizelgesi
- Belgeleme görevleri