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:
- VLC
- Teknik yazar:
- Avii
- Projenin adı:
- Bir mobil bağlantı noktası için VLC Kullanıcı Belgeleri 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 talimat, ipucu veya püf noktası olduğunda herkes destek ekibiyle iletişime geçmek ya da e-posta yanıtı beklemek istemez. Kullanıcı belgeleri tam olarak bunu yapıyor. Destek maliyetlerini de azaltır. Ayrıca, ürünün sağlıklı olduğunun ve geliştirici ekibinin kimliğindendir.
Android için VLC, sadece Google Play Store'da 100 milyondan fazla kez indirildi. VLC, mobil bağlantı noktaları için ses-video oynatma ve ağ akışı gibi birçok özellik sağlar. İnsanlar genellikle bu harika özellikleri kullanmak ister ancak bunu yapamıyorlar. Bunun için bir blog veya rastgele video aramak için çok zaman ve sabır gerekiyor, 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 sunmamaktadır. Buna ek olarak, wiki sayfaları en son Mart 2019'da güncellenmiştir. Mevcut proje, modern bir tasarıma sahip ve Android bağlantı noktası için daha kolay kullanım kolaylığı sağlayacak yeni Kullanıcı dokümanları sağlayacak.
MEVCUT DURUM
Wiki sayfaları tamamen eski ve VLC'nin 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 bir dilde okuma seçeneği sunulmaz. Özellik açıklamaları hiç yer almıyor.
ANALİZ
-> Şu an itibarıyla mevcut belgeler geçerliliğini yitirmiş durumda. Farklı bir platform ve araçlar kullanılarak yeni bir yöntemle yazılması gerekiyor.
-> Çoğu Android kullanıcısının teknik bilgisi çok azdır veya hiç yoktur. Ancak insanlar bir özellikle ilgili daha fazla teknik bilgiye ihtiyaç duyuyor. Yukarıdaki amaçların her biri için iki ayrı belge yazıp saklamanız iyi bir fikir değildir. Hatta aynı belgede, bir özelliğin teknik ve teknik olmayana göre bölünmesi daha fazla kafa karışıklığına neden olur. Yine kullanıcıların çoğu gördüğü kullanıcı arayüzüne veya kullandığı özelliklere alışık olduğundan, bir öğenin teknik mi yoksa teknik olmayan mı olduğuna herkesin karar vermesi kolay değildir. Onlar için bunu basitleştirmek istiyoruz.
-> Kullanıcıların çoğu, akıllı telefonlarından bilgi almaya çalışırken masaüstü veya diğer cihazlarda dinlenir. Bu nedenle dokümanlar her ekran boyutuna kolayca uyarlanabilir olmalıdır. Gezinmeyle ilgili hiçbir karışıklığa yol açmamalıdır.
-> Masaüstü sürümünün her özelliği Android bağlantı noktasında bulunmaz 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 gelmiş olmasıdır. Ancak, mobil bağlantı noktası nispeten yeni ve hâlâ gelişme aşamasındadır. Bunun dışında, günümüzde mobil cihazlar son derece güçlü hale gelmiş olsa da, büyük ölçüde son kullanıcı talebi nedeniyle, sunabileceğimiz özellik türlerine ilişkin bariz bir kısıtlama söz konusudur. Kimsenin kullanmadığı bir özelliğe sahip olmak, gelişim kaynaklarını israf etmektir. Bu nedenle özellikleri temel alarak her iki dokümanı da tartışmanız önerilmez.
YUKARIDAKİ ANALİZLERE GÖRE AŞAĞIDAKİLERİ ÖNERİYORUM. 1. An itibarıyla Masaüstü kullanıcı dokümanları için Sfenks Belgeleme aracı ve Dokümanları Okuma uygulamaları kullanılıyor. Aynısını Android bağlantı noktası için kullanmak bize aşağıdaki açılardan yardımcı olur: -> Her iki dokümanı da kolayca birleştirebilirsiniz. -> Tüm ekran boyutları için optimize edilmiştir. -> Masaüstü Dokümanları aracılığıyla Android Kullanıcı Dokümanlarına erişirken sorunsuz 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 göreli konumu karşılaştırarak kolayca gidebilecekleri için bu yaklaşım erişim kolaylığını artıracaktır. Özelliklerin her biri için teknik ve teknik olmayan bölümleri daha ayrıntılı bir şekilde ayırabiliriz. İlk olarak teknik olmayan bir kolay açıklama yazacağız ve ardından aynı özelliğin teknik bölümlerini (varsa) hemen altında vurgulayacak veya etiketleyeceğiz. Bu durum, içeriğin tekrarlanmasını sağlayabilir ancak teknik olmayan çoğunluğun sorunsuz bir deneyim yaşamasını sağlar. Bu, sürdürülebilirliği artırarak, gelecekte de işe yarayacaktır. 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 eklenir veya kaldırılırsa, bölümü yeniden düzenleyebiliriz. Kullanıcı arayüzünün tamamı değiştirilirse bölümleri/bölümleri yeniden düzenleyebilir veya dokümanın tamamını 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 gerektiğinden tüm dokümanları değiştirmemiz gerekir. Çalışan bir demo burada barındırılmaktadır : https://avinal.gitlab.io/vlc-android-docs/
Belgenin her bölümü etiketli bir ekran görüntüsü , özelliğin açıklaması, varsa daha teknik bölüm ve özelliğe ilişkin ipuçları ve püf noktalarından oluşmalıdır.
-> Bu kullanıcı belgelerini masaüstünden bağımsız olarak geliştirmek, mevcut dokümanları etkilemeden veya geliştirme sırasında ondan etkilenmeden iki dokümanı da yalnızca birkaç adımda birleştirmemize yardımcı olacaktır. Tüm bu belgelerin, geliştirildikten sonra masaüstü dokümanlarının Android bölümüne yerleştirilmesini ve Android için VLC dokümanları için bir kalıcı bağlantı oluşturulmasını öneriyorum.
-> Masaüstü kullanıcı dokümanlarının başlangıç sayfasının, kullanıcıların doğrudan favori işletim sistemlerini seçmelerine imkan verecek şekilde yeniden tasarlanması ve ardından seçilen OS'nin dokümanlarına yönlendirme de diğer iyileştirmeler arasında yer alabilir. Windows, MacOS ve Linux VLC kullanıcı belgeleri halihazırda iyi bir şekilde tasarlanıp düzenlendiğinden, Windows/MacOS/Linux veya Android ya da iOS arasından seçim yapmak üzere 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İ NEDEN DAHA İYİSİ? Ö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 bilgiler gibi gerekli tüm özellikleri bir araya getirir. Bu, artık her bağlantı noktası için ayrı kullanıcı belgelerinin tutulması gerekmediğinden kolayca sürdürülebilir.
BU PROJE İÇİN NEDEN DOĞRU KİŞİSİM? -> 2 yıldır kod yazıyorum ve sık sık belirli kütüphaneler, bazı yazılımlar için API belgelerinden yararlanmam, hatta kendi kodumu belgelemem gerekiyor. Bu sayede insanların belgelerde tam olarak ne görmek istediğini, ne gibi sorunlarla karşılaştıklarını ve yardım almak için nasıl yaklaştıklarını biliyorum. Tutarlı ve kolay okunabilir bir belge yazmak için aynı deneyimi uygulayabileceğim.
-> Quora, Stack Overflow ve diğer çeşitli platformlarda aktif olarak teknik yazılar yazıyorum. Bir şeyleri akılda kalıcı ve 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. Uzun yıllardır hem masaüstü hem de mobil platformlarda VLC'yi kullanıyorum ve bir kullanıcının ne gibi sorunlar yaşayabileceğini biliyorum. Tüm bilgimi ve tecrübemi bir araya getirerek harika bir belge oluşturacağım.