Wikimedia Foundation projesi

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:
Wikimedia Foundation
Teknik yazar:
Pavithra Eswaramoorthy
Projenin adı:
Wikimedia'nın teknik belgeselcileri ve kameramanları için belgeleri iyileştirme
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

1. Hakkımda

Açık kaynak yazılımla birkaç ay önce tanıştım ve sınırsız kapsamı yüzünden neredeyse bir anda aşırıya kaçtığımı hissettim. Milyonlarca projede ilerlemek için uğraşırken Google Summer of Code ve Outreachy gibi açık kaynaklı girişimler hakkında bilgi edindim. Google Dokümanlar Sezonu ilgimi çekti ve Wikimedia Vakfı'nın proje fikirleri merakımı uyandırdı ve daha fazlasını keşfetmeye başladım.

Şimdiye kadarki yolculuğum biraz heyecan verici ve kafa karıştırıcıydı. "Bekle, ne?", "Ah, anladım!" ve "Bununla ilgili bir yorumda bulunmalı mıyım?" gibi sorularla doluydu. Wikimedia topluluğu her adımda sizi destekliyor. Sayfaları düzenlemekten uzantı oluşturmaya kadar her gün yeni bir şeyler öğreniyorum.

Beklendiği gibi, uygulama işlemi açık kaynak topluluğuna açılan bir kapı işlevi gördü. Bu öneri, yeni başlayan biri olarak benim deneyimlerimden ilham alıyor.

2. Proje

2.1. Dış Çizgi

Bu proje, Wikimedia'daki teknik yazarlar ve potansiyel videografikerler için dokümanları iyileştirmeyi amaçlamaktadır. Olgunlaşmış bir dizi teknik doküman, genel dokümanların iyileştirilmesine yardımcı olur ve ekran video kaydı oluşturmaya yönelik referanslar, yazılım özelliklerinin etkili bir şekilde gösterilmesini sağlar. Bu alanlardaki mevcut belgeler, hem yeni kullanıcıları hem de deneyimli katkıda bulunanları daha iyi desteklemek için genişletilebilir. Kullanışlı kaynaklardan oluşan bu ağı geliştirmek için kademeli bir yaklaşım benimsenir.

2.2. Teslim edilecek materyaller

  • T197006 [https://phabricator.wikimedia.org/T197006] - Wikimedia belgeselcileri için dokümanları iyileştirin:

    • Belgeleme/Stil kılavuzuna ipuçları ve örnekler ekleyin. [https://www.mediawiki.org/wiki/Documentation/Style_guide]
    • Teknik doküman şablonları ve öneriler aracılığıyla belirli türlere MediaWiki'ye özgü bilgiler ekleyebilirsiniz: Kullanıcı kılavuzları, "Nasıl Yapılır?" kılavuzları, hızlı başlangıç kılavuzları, sürüm notları ve README'ler. [https://www.mediawiki.org/wiki/Technical_documentation_templates_and_suggestions]
    • Teknik belge önceliklendirme yönergelerini test edin ve iyileştirin. [https://www.mediawiki.org/wiki/Technical_documentation_prioritization]
    • Farklı belge türleri için içerik toplama stratejisi tasarlayın.
    • MediaWiki'nin dokümanları için bir iletişim ve ortak çalışma stratejisi tasarlayın.
    • Yazarların yayınlamadan önce dokümanlarını inceleyebilecekleri bir kontrol listesi oluşturun.
    • Yeni teknik yazarlar için belge yapısını genişletin. [https://www.mediawiki.org/wiki/User:Pavithraes/Sandbox/New_Technical_Writers]
    • Hackathon'lara uygun teknik belge görevlerinden oluşan bir liste hazırlama. [https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons]
    • Yararlı kaynaklara yönlendiren bir teknik yazar merkezi oluşturun.

  • MediaWiki'nin kameramanları için dokümanları iyileştirin:

    • Genel bir ekran video kaydı oluşturmak için hızlı kullanıcı kılavuzu oluşturun.
    • Adım adım açıklamalı kılavuzlar ve eğiticiler için MediaWiki'ye özel ekran video kaydı şablonları tasarlayın.

  • T214522 [https://phabricator.wikimedia.org/T214522]- "Pabricator'a Giriş" ekran video kaydı oluşturun.

2.3. Uzat Hedefi

  • İçeriği tekrar kontrol edin ve WikiProject Ekran Kaydı dokümanlarını güncelleyin. (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Screencast)

3. Mentorlar

Mentorlarımla kuracağım birincil iletişim yöntemi Zulip olacak. Wikimedia'nın IRC kanalları ve e-posta hizmeti, toplulukla yapılacak görüşmeler için kullanılacaktır. Belirli görevlerle ilgili tartışmalar, Phabricator görevlerinin yorumlar bölümünde yapılır.

4. Tartışma

Bu proje genel olarak iki aşamadan oluşur:

(i) Wikimedia'nın teknik yazarları için mevcut kaynakları iyileştirmek.

(ii) Potansiyel videografikerler için yararlı şablonlar oluşturma.

(i) Wikimedia'nın teknik yazarları için mevcut kaynakları iyileştirmek.

Geçmişte, MediaWiki'nin belgelerini çeşitli başarı dereceleriyle iyileştirmek için birçok girişimde bulunuldu. Birkaç örnek verecek olursak:

  • https://www.mediawiki.org/wiki/User:Zakgreant/Tech_DocsPlan(2011--01/P6M)
  • https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan
  • https://www.mediawiki.org/wiki/Thread:Project:Current_issues/RestructureMediaWiki.org(or:_Document_how_it_was_and_execute_it)
  • https://www.mediawiki.org/wiki/User:Waldir/Docs

Bu çalışmalar sonucunda, teknik yazarlar için daha iyi bir kaynak grubunun, söz konusu yazarlar tarafından oluşturulan dokümanlar üzerinde doğrudan etkisi olacağını anlayabiliriz.

Aşağıda, Sosyal Yardım 2018'de stajyer olarak görev yapan Anna e só https://anna.flourishing.stream/2018/01/18/bringing-documentation-to-light/ adlı iki haftalık stajyerin raporundan bir snippet yer almaktadır:

"MediaWiki'nin stil kılavuzu, özellikle de en iyi olduğunu düşündüğü uygulamaları vurgulamadan dış referanslara çok fazla dayandığı için mükemmel olmaktan çok uzak. Ne yazık ki bu, Çeviri en iyi uygulamaları gibi diğer dokümanlarda da görüldüğü gibi yalnızca MediaWiki'yle sınırlı olmayan bir sorun. Yazarlar işlerini yapmak için iyi ve güvenilir kaynaklara sahip olamıyor, bu da bir hedef kitle ve uygun bir yazı stili belirlemede güçlüklere yol açıyor. Kullanıcılar, özellikle yeni kullanıcılar ise yeni kavramları ve süreçleri anlama konusunda sorun yaşayabilir."

T197006 [https://phabricator.wikimedia.org/T197006] da teknik yazım belgelerinin iyileştirilmesi gereken belirli alanlarına ışık tutar. Açıkçası, Documentation/Style_guide ile başlayabilirsiniz.

Daha iyi bir stil kılavuzu edindikten sonra, teknik yazarlara teknik yazının farklı aşamalarında rehberlik edecek bir sonraki doküman seti planlanmaktadır. Belgelerin yeni başlayanlar için uygun olması ve aynı zamanda, yazarların başvurması gereken tüm gerekli bilgileri sağlaması gerekir.

Hazırlık aşaması belgenin temelini oluşturduğu için muhtemelen en önemli aşamadır. Bu aşamada teknik yazarları desteklemek için alakalı bilgileri toplamanın etkili yollarını açıklayan ve şablonlar kullanarak bu bilgileri yapılandırmaya yönelik ipuçlarının açıklandığı referans dokümanlar geliştirilir.

Sonra yazma aşaması gelir. Yazarlara çıtayı otomatik olarak yüksek tutmak için yapılan başarılı çalışmaların örnekleri sunulur. Ayrıca, her dokümanın uyması gereken temel ölçütleri içeren bir kontrol listesi oluşturulur. Bu, yazarların dokümanlarını yayınlamadan önce incelemelerine yardımcı olur.

Bu belgelere rağmen yeni teknik yazarların ekstra yardıma ihtiyacı olacak ve bizim de bunu onlara vermemiz gerekiyor. Yeni teknik yazarlar için hazırlanmış kılavuzda, hackathon'lara uygun görevlerin bir listesi, zorluk seviyesine göre hazırlanmış.

Son olarak, dokümantasyonu yönetme ve sürdürme sürecini anlamanızı sağlayacak bir belge ("Teknik belge önceliklendirme") test edilip iyileştirilmiştir.

Bu aşamanın sonunda, teknik yazım kılavuzları, kaynaklar, örnekler, öneriler ve şablonlardan oluşan, belgeleme stil kılavuzunu destekleyen bir merkez oluşturulacaktır.

(ii) Potansiyel videografikerler için yararlı şablonlar oluşturma.

"Grafik içeren herhangi bir şeyi öğrenmenin en zor yollarından biri düz metin okumaktır. Kılavuzunuz yazılımın yanlış bir sürümüne atıfta bulunduğunda ne olacağını da hayal edin. Yalnızca metinden oluşan kılavuzlarda, normalde kullandığımız tüm işaretler olmadığından uygulamadaki menüler ve ifadeler değiştiğinde bir dizi işlemi yeniden oluşturmak genellikle imkansız hale gelir.

Bunu öğrenmenin en iyi yolu, hemen yanı başınızda olan bir uzmanla çalışmaktır. Ekran video kayıtları, statik grafiklerle ve uzmanın yakınında bulunan bir merkezde yer alır. Samimi bir sesle, görsel ve hareketli bir demo elde ederiz. Ekranda metin açıklamaları ve animasyonlar da bulunabilir. Ekran video kayıtlarının bir uzmana göre avantajı, her günün her saatinde tekrar oynatılabilmesidir.

Ayrıca, ekran video kaydına çevrilmiş altyazılar da ekleyebiliyoruz. Böylece, ana dili konuşmayan kullanıcılar tarafından görüntülenebilir veya ses parçasını alternatif dillerle değiştirebiliriz."

Ian Ozsvald, "The Screencasting Handbook"" (Ekran Kaydı El Kitabı) adlı yukarıdaki snippet'te [https://thescreencastinghandbook.com/wp-content/uploads/The_Screencasting_Handbook_rel10_20100502_v6.pdf] ekran video kayıtlarının önemini açıklıyor. Bu dosya özellikle MediaWiki geliştirme ortamını ayarlama, uzantı yazma, Gerrit kullanma ve diğer konulardaki eğiticiler için faydalı olabilir.

Doküman şablonlarına benzer şekilde, ekran video kayıtları için standart bir şablona sahip olmak tek tipliği artırır ve böylece görüntüleyenin deneyimini iyileştirir. Ayrıca, potansiyel videografikerlere başlangıç için bir çerçeve sunar. Bu nedenle, tanıtım videoları ve eğitim videoları oluşturmaya ilişkin şablonların takip ettiği bir hızlı kullanıcı kılavuzu geliştirilmiştir. Dokümanlar, işlenecek kavramların derinliğiyle ilgili işaretçiler ve MediaWiki için birkaç ekran video kaydı fikri içeriyor.

Yukarıdaki şablonu test etmenin ve zorlayıcı hedefe hazırlanmanın en iyi yolu, araçları ve şablonları kullanarak bir ekran video kaydı oluşturmaktır. Bu nedenle, Phabricator'ı kullanmayla ilgili temel bilgilerin ele alındığı bir "Fibricator'a Giriş" ekran video kaydı oluşturulmuştur. Bu süreç ayrıca tartışılması gereken alanları da vurgular.

Son olarak, Wikimedia'nın videografikerlerinin merkezi referans kaynağı olan WikiProject Screencast incelenip güncellenir.

5. Kesinleşmemiş zaman çizelgesi

Toplulukla bağ dönemi (1 Ağustos - 1 Eylül)

  • Mentorlarımla birlikte projeyi ayrıntılı olarak incelemek.

  • Şu konuları tartışın:

    • Görevlerin ne sıklıkta gözden geçirilmesi gerektiği.
    • Zaman planlamalarını paylaşın ve haftalık/günlük iş akışı üzerinde karar kılın.
    • Kullanılabilecek araç ve kaynaklar.
    • İki haftalık ve günlük proje raporları.

  • Phabricator'da gerekli ve alt görevleri oluşturun.

  • Belge geliştirme aşamasında kişisel taahhütlerinizi telafi etmek için taslaklar oluşturmak.

1. Hafta (2-8 Eylül)

  • Documentation/Style_guide öğesini iyileştirin:

    • MediaWiki'deki en iyi uygulamaları ve standartları göstermek için ana odağı kaydırın.
    • İyi çalışma örnekleri ekleyin ve ilişkili sayfaların görünürlüğünü artırın.

  • Yeni teknik yazarlar için kılavuzu iyileştirin:

    • Belge yapısını genişletin.

2. Hafta (9-15 Eylül)

  • Teknik belge önceliklendirme çalışmaları:

    • Belge çalışma panosunu değerlendirin; iyi görev tanımları ve önceliklendirme örnekleri bulun.
    • Trendleri inceleyin ve yaygın zorlukları not edin.
    • Önceliklendirme standartlarını belgelemek için bu bilgilerden ve örneklerden yararlanın.

3. Hafta (16-22 Eylül)

  • Teknik yazarlar için aşağıdaki ek dokümanları oluşturun:

    • Yayınlamadan önce teknik belgeleri incelemeye yardımcı olacak bir kontrol listesi.
    • Farklı belge türleri için etkili içerik toplama yöntemleri.

4. Hafta (23-29 Eylül)

  • Teknik doküman şablonlarına ve önerilere en yaygın MediaWiki türlerinde yazmayla ilgili bilgi ekleyin:

    • Kullanıcı kılavuzları, hızlı başlangıç kılavuzları, README'ler, sürüm notları ve nasıl yapılır yazmak için en iyi uygulamaları MediaWiki'de belgeleyin.

  • Teknik iletişimin olgunluğunu artırmaya yönelik talimatlar ekleme. [https://www.mediawiki.org/wiki/User:SRodlund_(WMF)/Maturity_model_for_MediaWiki_technical_documentation#Increasingmaturity--_strategic_directions]

5. Hafta (30 Eylül - 6 Ekim)

  • Yeni ortak çalışanların katılımıyla ilgili dokümanları iyileştirin:

    • Sayfayı güncelleyin: Hackathon'lar için teknik belge görevleri. (Yapılacaklar: Proje dönemi boyunca bu sayfaya uygun görevler ekleyin)

  • Teknik yazı yazma merkezi oluşturun

    • Yararlı sayfalara ve kaynaklara bağlantılar içeren bir açılış sayfası oluşturun.
    • Yeni ve mevcut sayfalar arasında daha kolay gezinme için gerekli bağlantıları ekleyin.

6. Hafta (7-13 Ekim)

  • MediaWiki için video yapımıyla ilgili aşağıdaki belgeleri oluşturun:

    • Ekran Kaydı Projesi'ne işaret eden "genel bir ekran video kaydı oluşturma" ile ilgili hızlı kullanıcı kılavuzu.
    • Şablonlar: Yazılım/araç kullanmayla ilgili adım adım açıklamalı kılavuzlar, Yeni araç geliştirmeyle ilgili eğiticiler

  • MediaWiki için ekran video kaydı fikirleri listesi oluşturun.

7. Hafta (14-20 Ekim)

  • ""Pabricator'a Giriş" videosu üzerinde çalışın:

    • Komut dosyası taslağı oluşturmak için önceki hafta oluşturulan şablonu kullanın.
    • Şablonun verimliliğini tahmin edin ve gerekiyorsa şablonu iyileştirin.
    • Geri bildirim alın ve taslağınızı tamamlayın.

8. Hafta (21 - 27 Ekim)

  • "Fibricator'a Giriş" videosunu yayınlayın:

    • Yazılımı seçin ve yükleyin.
    • Ortamı ayarlayın ve ekran video kaydını oluşturun.
    • Karşılaşılan sorunları ve çözümlerini not edin.

9. Hafta (28 Ekim - 3 Kasım)

  • Ekran Kaydı proje belgelerini iyileştirmek için çalışma:

    • Yapıyı inceleyin ve değişikliğe ihtiyaç olup olmadığını tartışın.
    • Bahsedilen yazılımları inceleyin.
    • Yazılım listesini araştırın ve güncelleyin.

10. Hafta (4 - 10 Kasım)

  • Ekran Kaydı proje belgelerini iyileştirmeye devam edin:

    • Eğitimi ve komut dosyalarını değerlendirin ve iyileştirin.
    • Ekran video kaydı galerisini inceleyin.

11. Hafta (11 - 17 Kasım)

  • Ekran Kaydı proje belgelerindeki çalışmaları tamamlayın:

    • Daha yeni videolar bulup galeriye ekleyebilirsiniz.
    • Gerekli yapısal değişiklikleri yapın.

12. Hafta (18 - 24 Kasım)

  • Beklemedeki görevler üzerinde çalışın.

  • Nihai raporu yazın:

    • İki haftada bir/günlük raporlara göz atın ve gerekli bilgileri toplayın.
    • Rapor yapısını planlayın ve bir taslak yazın.
    • Mentorun geri bildirimine göre taslağı iyileştirip son haline getirmek.

13. Hafta (25 - 29 Kasım)

  • Nihai raporu ve mentor değerlendirmesini göndermek.

6. İlerleme Durumunu İzleme

İlerlemeyle ilgili günlük güncellemeler Zulip üzerinden mentorlarıma iletilecek. Wikimedia topluluğu ilerlememi Phabricator aracılığıyla ya da iki haftada bir yayınlanan proje raporlarından takip edebiliyor.

7. Diğer Taahhütler

Tam zamanlı bir üniversite öğrencisiyim ve akademik güz dönemim, Dokümanlar Dönemi zaman çizelgesiyle çakışıyor. Bu nedenle taahhütlerim üniversite sınavlarını içeriyor.

İlk dahili sınav: 18 - 24 Ağustos

İkinci dahili sınav: 29 Eylül - 6 Ekim

Yarıyıl sonu sınavı: 11-30 Kasım

İlk halka açık konferansım PyCon India'ya 12-15 Ekim tarihleri arasında katılmayı da planlıyorum. Bu etkinliğe, oldukça uygun bir mekan da bu yıl katılacak. Yeni insanlarla tanışmak ve bilgilendirici sohbetler gerçekleştirmek için harika bir fırsat olacağına inanıyorum.

Bu taahhütleri yönetmek için geçici zaman çizelgesi, ilgili haftalarda daha az ağır görevleri içerir. Belgeyi geliştirmek için yeterli zamana sahip olmak amacıyla, güz döneminde en fazla 20 temel krediye yer vermeyi planlıyorum. (Düzenli bir öğrenci dönem başına ortalama 25 krediyi tamamlar)