Bu sayfa, Cloud Translation API ile çevrilmiştir.

VLC projesi

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:: VLC
Teknik yazar:: Avii
Proje adı:: Bir mobil bağlantı noktası için VLC Kullanıcı Dokümanlarını oluşturma (Android)
Proje süresi:: Standart uzunluk (3 ay)

Proje açıklaması

ÖZET

Kullanıcı dokümanları, son kullanıcılara yardımcı olmak için statik bir destek sistemi olarak kullanılır. Bir ürün veya hizmet hakkında hem teknik hem de teknik olmayan bilgiler sağlar. Kullanıcıların yazılımı veya hizmeti nasıl kullanacaklarını öğrenmelerine yardımcı olur. Küçük bir yönlendirme, ipucu veya püf noktası yeterli olduğunda herkes destek ekibiyle iletişime geçmek ya da e-posta yanıtı beklemek istemez. Kullanıcı belgeleri tam da bunu yapıyor. Aynı zamanda destek maliyetlerini azaltır ve ürünün sağlığı ile geliştirici ekibinin kimliğidir.

Android için VLC sadece Google Play Store'dan 100 milyondan fazla kez indirildi. VLC, mobil bağlantı noktaları için ses-video oynatmasından ağ akışına kadar pek çok özellik sağlar. İnsanlar genellikle bu harika özellikleri kullanmak ister ancak bunu yapamazlar. Bunun için bir blog veya rastgele video aramak çok fazla zaman ve sabır gerektiriyor, ancak yine de elde edilen bilgilerin orijinalliği yok. Şu anda VLC, wiki sayfasında Android için VLC'yi barındırmakta ve bu özelliklerle ilgili daha az açıklama sağlamaktadır veya hiçbir açıklama sağlamaktadır. Buna ek olarak, wiki sayfaları en son Mart 2019'da güncellenmiştir. Mevcut proje, modern bir tasarıma ve Android bağlantı noktası için daha fazla kullanım kolaylığına sahip yeni Kullanıcı dokümanları sağlayacaktır.

GEÇERLİ DURUM

Wiki sayfaları tamamen eski ve VLC'nin en son sürümüyle ilgili çok daha az bilgi içeriyor. Ayrıca, buralarda gezinmek de kolay değildir. Dokümanları İngilizce dışında başka bir dilde okumak için görünür bir seçenek yoktur. Özellik açıklaması içermez.

ANALİZ

-> Mevcut belgeler şu an itibarıyla geçerliliğini yitirmiş olup yeni bir yöntemle, farklı bir platform ve araçlar kullanılarak yazılması gerekmektedir.

-> Çoğu Android kullanıcısının teknik bilgisi çok azdır veya hiç teknik bilgisi yoktur. Ancak bazı insanlar bir özellikle ilgili daha fazla teknik bilgiye ihtiyaç duyar. Yukarıdaki amaçların her biri için iki ayrı belge yazmak ve saklamak iyi bir fikir değildir. Hatta aynı belgelerde, bir özelliği teknik ve teknik olmayan özelliklere göre ayırmak daha fazla karışıklığa yol açmaktadır. Kullanıcıların çoğu gördüğü kullanıcı arayüzüne veya kullandığı özelliklere alışkın olduğu için bir şeyin teknik mi yoksa teknik bir sorun mu olduğuna herkesin karar vermesi kolay değildir. Onlar için bunu basitleştirmek isteriz.

-> Kullanıcıların çoğu, akıllı telefonlarının kendisi üzerinden bilgi almaya çalışırken masaüstü veya başka cihazlardan da bilgi almaya çalışır. Bu nedenle dokümanlar her ekran boyutuna kolayca uyarlanabilir olmalıdır. Ve gezinmeyle ilgili hiçbir karışıklık yaratmayacaktır.

-> Masaüstü sürümünün her özelliği Android bağlantı noktasında mevcut değildir ve varsa her iki bağlantı noktasında da aynı şekilde çalışmaz. Bunun nedeni, masaüstü uygulamasının çok daha uzun süredir geliştirme aşamasında olması ve bir tür doygunluk durumuna ulaşmış olmasıdır. Ancak, mobil bağlantı noktası nispeten yeni ve hâlâ gelişmektedir. Bunun dışında, günümüzde mobil cihazlar çok güçlü hale gelmiş olsa da, büyük ölçüde son kullanıcının talebi nedeniyle kullanabileceğimiz özellik türüyle ilgili açık bir kısıtlama söz konusudur. Kimsenin kullanmadığı bir özelliğe sahip olmak, geliştirme kaynaklarını boşa harcamaktır. Bu nedenle özellikleri temel alarak her iki belgenin de konuşulması önerilmez.

YUKARI ANALİZLERE GÖRE AŞAĞIDAKİLERİ ÖNERİYORUM. 1. Şu an için Masaüstü kullanıcı dokümanları, Sfenks Belge oluşturma aracı ve Dokümanları Okuma teması kullanılıyor. Aynısını Android bağlantı noktası için de kullanmak size şu konularda yardımcı olacaktır: -> Her iki dokümanı da kolayca birleştirebiliriz. -> Tüm ekran boyutları için optimize edilmiştir. -> Masaüstü Dokümanları aracılığıyla Android Kullanıcı Dokümanlarına giderken sorunsuz bir deneyim

Bölümleri, bölümleri ve alt bölümleri uygulamadaki göreli konumlarına göre ayırma. Örneğin, Arka Plan/PIP modu Diğer -> Ayarlar->Video'nun içindedir. Bu nedenle bölüm yapısı

Daha fazla

|__Ayarlar

| |__Medya Kitaplığı

| |__Video -->Arka Plan/PiP Modu

: -> Kullanıcılar yardıma ihtiyaç duydukları bölüme uygulamadaki ilgili konumla karşılaştırarak kolayca gidebilecekleri için bu yaklaşım erişim kolaylığını artırır. Özelliklerin her biri için teknik ve teknik olmayan bölümleri daha fazla ayırabiliriz. İlk olarak teknik olmayan, kolay bir açıklama yazacağız ve ardından aynı özelliğin, varsa, hemen altında bulunan teknik kısımlarını daha fazla vurgulayacak veya etiketleyeceğiz. Bu yöntem, bir miktar tekrara yol açabilir ancak teknik olmayan çoğunluğun sorunsuz bir deneyim yaşamasını sağlar. Bu, sürdürülebilirliği artırarak gelecekte işe yarayabilir. Uygulama doygunluk durumuna erişeceğinden, göreli kullanıcı arayüzü büyük olasılıkla fazla değişmeyecektir. Dolayısıyla, gelecekte yeni bir özellik eklenirse/kaldırılırsa bölümü yeniden düzenleyebiliriz. Kullanıcı arayüzünün tamamı değiştirildiğinde, bölümleri/bölümleri yeniden düzenleyebilir veya tüm dokümanı yeniden yapılandırabiliriz. Her iki durumda da, geçerli kullanıcı arayüzüyle eşleşmesi için ekran görüntüsünün değiştirilmesi gerekeceğinden, dokümanların tamamını değiştirmemiz gerekir. Çalışan bir demo şu adreste bulunmaktadır : https://avinal.gitlab.io/vlc-android-docs/
Dokümanların her bölümü, etiketli bir ekran görüntüsü , özelliğin açıklaması, varsa daha teknik bir bölüm ve özellikle ilgili ipuçları ile püf noktalarından oluşmalıdır.

-> Bu kullanıcı dokümanlarını masaüstünden bağımsız olarak geliştirmek, mevcut dokümantasyonu veya geliştirme sırasında etkilenmeden iki dokümanı da yalnızca birkaç adımda birleştirmemize yardımcı olur. Bu dokümanların tümünü, geliştirildikten sonra masaüstü dokümanlarının Android bölümüne yerleştirmeyi ve Android için VLC dokümanları için bir kalıcı bağlantı oluşturmayı öneriyorum.

-> Masaüstü kullanıcı dokümanlarının başlangıç sayfasının, kullanıcıların en sevdikleri işletim sistemini doğrudan seçmelerine olanak verecek şekilde yeniden tasarlama ve ardından seçilen işletim sisteminin dokümanlarına yönlendirme de diğer iyileştirmelerden bazılarıdır. Windows, MacOS ve Linux VLC kullanıcı dokümanları zaten iyi tasarlanmış ve geliştirilmiş olduğundan, Windows/MacOS/Linux veya Android ya da iOS arasından seçim yapabileceğiniz seçenekler sunabiliriz. Bu sayede, tüm bağlantı noktaları için kullanılacak tek bir bağlantıyla, birbirinden güzel şekilde ayrılmış ancak birleştirilmiş kullanıcı dokümanları elde edilir.

ÖNERİLEN KULLANICI BELGELERİM NEDEN DAHA İYİ? Önerilen kullanıcı dokümanı, son kullanıcının yardım almak için izlediği yaygın kalıplar temel alınarak yapılandırılır. Dokümanlar, kullanım kolaylığını ve son kullanıcı deneyimini en üst düzeye çıkarmak için basitlik, netlik, görünüm ve tarz, teknolojik bilgi gibi gerekli tüm özellikleri bir araya getirir. Artık her bağlantı noktası için ayrı kullanıcı dokümanlarına gerek kalmadığından, bu özellik kolayca yönetilebiliyor.

BU PROJE İÇİN NEDEN DOĞRU KİŞİSİM? -> 2 yıldır kod yazıyorum ve sık sık belirli kütüphanelerin, bazı yazılımların API belgelerini gözden geçirmem, hatta kendi kodumu belgelemem gerekiyor. Bu sayede insanların belgelerde ne görmek istediğini, ne tür sorunlarla karşılaştıklarını ve yardım almak için ne gibi yaklaşımlar aldıklarını biliyorum. Tutarlı ve kolay okunabilir bir belge yazmak için aynı deneyimi sunabileceğim.

-> Quora, Stack Overflow ve daha birçok platformda aktif olarak teknik yazılar yazıyorum. Bir şeyleri ilgi çekici, insanların kolayca anlayabileceği bir şekilde nasıl açıklayacağımı biliyorum.

-> Android için VLC güçlü ve çok ünlü bir araçtır, ancak özelliklerinin çoğu bilinmiyor veya herhangi bir yardım mevcut değil. VLC'yi yıllardır hem masaüstü hem de mobil platformlarda kullanıyorum ve kullanıcının ne gibi sorunlar yaşayabileceğini biliyorum. Bilgi birikimimi ve tecrübemi bir araya getirerek harika bir belge oluşturacağım.