VideoLAN 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:
VideoLAN
Teknik yazar:
Edidiong Anny Asikpo
Projenin adı:
VLC kullanıcı belgelerini modernleştirme (yeniden yazma)
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

ÖZET

Kullanıcı dokümanları, son kullanıcıların bir ürün veya hizmeti kullanmasına yardımcı olmak için tasarlanmıştır. İyi kullanıcı belgeleri, kullanıcılara bir yazılımı, özelliklerini, ipuçlarını ve püf noktalarını öğrenmeleri ve yazılımı kullanırken karşılaşılan yaygın sorunları çözmeleri için bir yol sağladığından çok önemlidir. Aynı zamanda destek maliyetini azaltır ve ürünün kurumsal kimliğinin bir parçasıdır: İyi bir kullanıcı belgesi, geliştirici ekibi olarak ürünün sağlıklı olduğuna işaret eder.

İyi bir kullanıcı dokümantasyonu olmadan kullanıcı yukarıdakilerin nasıl etkili ve verimli bir şekilde yapılacağını bilemeyebilir. Kullanıcı belgeleri bir ürünün başarılı olmasında çok önemli bir rol oynayabilir. Çünkü başarılı iletişim, her zaman işletme veya ürünün merkezinde yer alır. Mükemmel bir belge ise bu iletişimi alır ve herkesin başarıya ulaşmak için erişebileceği yönetilebilir bir çerçeveye sokar.

Bu yazı yazıldığında, VLC kullanıcı dokümanlarına 4.634.065 kez erişilmiş ve VLC medya oynatıcısı ana web sitesinden her ay yaklaşık 23 milyon kez indirilmiştir. Bu da, dünyanın her yerinden pek çok kişinin VLC Media Player'ı kullandığını ve medya oynatıcının nasıl kullanılacağına ilişkin yol gösterici bilgiler için kullanıcı dokümanlarını okumak isteyebileceğini gösterir. Ancak, VLC medya oynatıcı kullanıcı dokümanları şu anda eski ve eksik (en son 28 Ekim 2015'te değiştirilmiştir) ve VideoLAN topluluğu, son kullanıcıların VLC medya oynatıcısını kullanırken sorunsuz bir deneyim yaşamalarını sağlamak için bu projeyi, kullanıcı belgelerini iyileştirmek amacıyla kullanmak istemektedir.

GEÇERLİ DURUM

Kullanıcı dokümanları şu anda bir wiki sayfasında bulunmaktadır. Eski, eksik, gezinmesi veya bilgileri bulması zor, medya oynatıcının mevcut sürümüyle ilgili bilgileri kapsamamaktadır ve yalnızca Almanca'ya çevrilebilmesi İngilizce bilmeyen kişiler için büyük bir sıkıntıya neden olmaktadır.

ÖNERİLEN KULLANICI BELGELERİMİN MEVCUT BELGELERDEKİ İYİLEŞTİRME NEDENİDİR?

Önerilen kullanıcı dokümanı, son kullanıcı için verimliliği, tutarlılığı ve huzurunu iyileştirecek ve sağlayacak şekilde yapılandırılacaktır. Video, yazılı kılavuzları ve ilgili resimleri, VLC medya oynatıcısının her bir özelliğinin nasıl kullanılacağına ilişkin talimatlar ve açıklamalar içerir; güncel, kolay gezinme, kolay gezinme, anlaşılabilir ve en az beş temel dilde çevrilebilir.

Mentorlar: Jean-Baptiste, Alex, Simon

ANALİZ

Jean-Baptiste ile birlikte, iyileştirme amacıyla mevcut kullanıcı dokümanlarının taşınacağı yeni ortam hakkında konuştuk ve Sphinx ile yazılmış kaynak dosyanın Gitlab deposunu ve Dokümanları Oku bölümünde barındırılan ana dokümanları gösteren iki bağlantı paylaştık ve yeni dokümanların buna benzer olmasını beklediğini söyledi. İşleyiş şeklini daha iyi anlamak için bu araçlarla ilgili epey araştırma yaptım.

Sfenks

Sfenks, yazılım belgeleri için sağlam ve olgun bir çözümdür. Tek kaynak yayınlama, içeriği yeniden kullanma, içerik türüne ve etiketlere dayalı koşullu dahil etme, mobil ve masaüstünde mükemmel bir kullanıcı deneyimi sağlayan yetişkinlere yönelik çok sayıda HTML teması, sayfalar, dokümanlar ve projeler arasında referans verme gibi yazarların beklediği çeşitli özellikleri içerir. Dizin ve Sözlük desteği ve uluslararasılaştırma desteği. Ayrıca, biçimlendirme dili olarak reStructuredText öğesini kullanıyor. Bu aracın güçlü yanlarının çoğu, reStructuredText'in gücü, sadeliği ve dokümanları çevirme becerisinden geliyor.

Belgeleri okuyun

Google Dokümanlar'ı okuyun, dokümanlarınızın oluşturulmasını, sürüm oluşturulmasını ve barındırılmasını otomatikleştirerek yazılım dokümanlarını sizin için basitleştirin. Asla senkronize olmamaktadır. Örneğin, Git, Mercurial, Marketplace veya Subversion gibi favori sürüm kontrol sisteminize kod aktardığınızda, Dokümanları otomatik olarak derleyerek kodunuz ve belgeleriniz her zaman güncel olacaktır. Birden çok sürümü vardır. Google Dokümanlar'ı okuyun, dokümanlarınızın birden fazla sürümünü barındırabilir ve oluşturabilir. Böylece, dokümanlarınızın 1.0 sürümüne ve 2.0 sürümüne sahip olmak, sürüm denetim sisteminizde ayrı bir dalı veya etiketi kullanmak kadar kolaydır. Google Dokümanlar ücretsiz ve açık kaynaklıdır ve neredeyse her insan ve bilgisayar dilinde kullanılan yaklaşık 100.000 büyük ve küçük açık kaynak projesinin dokümanlarını barındırır.

DOĞRULA

Sfenks son derece güçlü bir araçtır ve Dokümanları Oku özelliği, dokümanlarınızı farklı sürümlerde güncel tutan Sfenks dokümanlarını barındırmak için en üstte oluşturulur. Bunlar, geliştiricilerin ve teknik yazarların son kullanıcılar için en iyi kullanıcı dokümanlarını oluşturmak üzere kullanabilecekleri mükemmel bir araç setidir.

Sfenks, belgeleri birden fazla dile çevirme desteği sunar. Dokümanları yönetmek için kullanılacak sürüm denetimini destekler. Herkesin doğru bilgileri düzenleyebildiği ve ekleyemediği mevcut wiki'den farklı olarak bu sürüm denetim sistemi, tüm değişikliklerin ana depoya eklenmeden önce gözden geçirilmesini sağlar. Sürüm kontrolü, kullanıcılar sorun oluşturabileceği, açık çekme istekleri vb. oluşturabileceği için dokümanların açık kaynaklı katkısını da artırır. Sfenks ve Dokümanları okuma özelliği; ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, Write the Docs vb. gibi birçok önemli topluluk tarafından da kullanılmaktadır. Ayrıca, yeni VLC kullanıcı dokümanları için kullanılabilecek harika bir araçtır.

Bu araçlarla ilgili bilgileri okumadım, aynı zamanda temel bir örnek de oluşturdum. Gitlab depomun bağlantısı olan https://gitlab.com/Didicodes/demo-vlc-user-documentation adresinde, readthedocs'da barındırılan sürüme ise şu adresten ulaşabilirsiniz: [https://vlc-user-documentation-demo.readthedocs.io/en/latest/](https://vlc-user-documentation-demo.readthedocs.io/en/latest)

ÖNERİLEN BELGELERİN YAPISI

VLC Kullanıcı Dokümanları için şu adreste bir yapı oluşturdum: https://docs.google.com/document/d/1Sy2V2IADoCyfnGBK70v8mkjiWK2tH-oWdUlDxAfQAYA/edit?usp=sharing. Bu yeni yapının uygulanmadan önce mentorlar tarafından onaylanması gerekir. Bu, yapının mentorlar tarafından incelendikten sonra muhtemelen değişebileceği anlamına gelir.

PROJE HEDEFLERİ

  • Belgeleri yeniden yapılandırın.
  • Belgeleri VLC'nin modern sürümlerine uyacak şekilde güncelleyin.
  • Sphinx ve ReadtheDokümanlar'ı kullanarak kullanıcı dokümanlarını Gitlab'e taşıyın.
  • Eski resimleri ve bilgileri kaldırın.
  • Kullanıcı belgelerini daha kolay anlaşılacak şekilde tekrar yazın.
  • Sfenks Uluslararasılaştırmasını kullanarak çeviri için gerekli ayarları yapın.
  • Kullanıcıların dokümanları okurken karşılaştıkları sorunları bildirebilmesi veya çözebilmesi için doküman topluluğunu şekillendirin.

NEDEN BU PROJE?

Kod yazmanın, sorunları çözmenin ve yazılım geliştirmenin tam potansiyeline, başkalarını da yazma yoluyla bu konuda aydınlatabilme yetkinle ulaşacağına inanıyorum. VideoLAN topluluğunun multimedya için ücretsiz yazılım çözümleri geliştirme çabaları beni her zaman etkilemiştir. Çocukken VLC medya oynatıcı, müzik dinlerken veya film izlerken her zaman kullandığım yazılımdı. Çünkü çok gürültülüydü ve çok fazla özellikten oluşuyordu. Çocukluğumun harika olmasına katkıda bulunan toplulukla birlikte çalışmak benim için bir onur.

NEDEN BU PROJE İÇİN DOĞRU KİŞİSİM

Bu proje için doğru kişi olduğuma inanıyorum çünkü:

  • Kuruluşların belgelerini geliştirme konusunda geçmişte deneyime sahibim ve herhangi bir sürüm denetim sistemini kullanabilirim; bu yüzden, Gitab'da komut yürütmek sorun olmayacak. Ayrıca insanlara değer katan projelerde çalışmak beni motive ediyor.
  • Birinin bir şeyi mümkün olan en verimli şekilde yapmasını istiyorsanız onu belgelemelisiniz. Süreçlerinizi belgeleyerek projeye dahil olan herkesin verimlilik ve tutarlılık elde etmesini ve gönül rahatlığını sağlarsınız.
  • VLC kullanıcılarının ihtiyaçlarını biliyorum çünkü onlardan biriyim. Bu, belgelerin dünya genelindeki diğer tüm kullanıcıların ilk bakışta anlayabileceği şekilde yazılmasına olanak tanır.