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:
- VLC
- Teknik yazar:
- Avii
- Proje adı:
- Bir mobil bağlantı noktası (Android) için VLC kullanıcı dokümanlarını oluşturma
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
ABSTRACT
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 kullanacağını öğrenmesine yardımcı olur. Her kullanıcı, ihtiyacı olan tek şey biraz yönlendirme, ipucu veya püf noktasıysa destek ekibiyle iletişime geçmek ya da e-posta yanıtı beklemek istemez. Kullanıcı dokümanları da bunu yapar. Ayrıca destek maliyetlerini azaltır ve ürünün sağlıklı olduğunun ve geliştirici ekibinin kimliğinin bir göstergesidir.
Android için VLC, yalnızca Google Play Store'dan 100 milyondan fazla kez indirildi. VLC, mobil sürümlerinde ses ve video oynatmadan ağ aktarımına kadar birçok özellik sunar. Kullanıcılar bu harika özellikleri kullanmak ister ancak çoğu zaman bunu yapamaz. Bunun için bir blog veya rastgele bir video aramak çok zaman ve sabır gerektirir. Ayrıca, elde edilen bilgilerin güvenilirliği de yoktur. Şu anda VLC, Android için VLC kullanıcı dokümanlarını wiki sayfasında barındırıyor ve bu özelliklerle ilgili çok az açıklama sunuyor veya hiç açıklama sunmuyor. Ayrıca, 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 olanağı sunan yeni kullanıcı dokümanları sağlayacaktır.
MEVCUT DURUM
Wiki sayfaları tamamen güncel değil ve VLC'nin en son sürümü hakkında çok az bilgi içeriyor. Ayrıca bu sayfalarda gezinmek kolay değildir. Dokümanları İngilizce dışında bir dilde okuma seçeneği yoktur. Özellik açıklamaları içermez.
ANALİZ
-> Şu anda mevcut dokümanlar eski olduğundan farklı bir platform ve araç kullanılarak yeni bir şekilde yazılmaları gerekiyor.
-> Android kullanıcılarının çoğu teknik bilgiye sahip değildir veya bu konuda bilgisi çok azdır. Ancak bir özellik hakkında daha fazla teknik bilgiye ihtiyaç duyan kullanıcılar da vardır. Yukarıdaki amaçların her biri için iki ayrı belge yazıp muhafaza etmek iyi bir fikir değildir. Ayrıca aynı dokümanlarda bir özelliğin teknik ve teknik olmayan sınıfa göre ayrılması da daha fazla karışıklığa yol açıyor. Kullanıcıların çoğu, gördükleri kullanıcı arayüzüne veya kullandıkları özelliklere alıştığı için bir konunun teknik olup olmadığına karar vermek herkes için kolay değildir. Bu nedenle bunu onlar için basitleştirmek istiyoruz.
-> Kullanıcıların çoğu bilgi edinmek için akıllı telefonlarını, geri kalanı ise masaüstü veya diğer cihazları kullanır. Bu nedenle, belgeler her ekran boyutuna kolayca uyarlanabilir olmalıdır. Gezinme konusunda kafa karışıklığı oluşturmamalıdır.
-> Masaüstü sürümünün her özelliği Android bağlantı noktasında kullanılamaz 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ştiriliyor olması ve bir tür doygunluk durumuna ulaşmış olmasıdır. Buna karşılık mobil bağlantı noktası nispeten yenidir ve hâlâ geliştirilmektedir. Bunun dışında, günümüzde mobil cihazlar çok güçlü hale gelse de çoğunlukla son kullanıcının talebi nedeniyle dahil edebileceğimiz özellik türünde belirgin bir kısıtlama var. Kimsenin kullanmadığı bir özelliğin olması, geliştirme kaynaklarının boşa harcanması anlamına gelir. Bu nedenle, her iki dokümanı da özelliklere göre karşılaştırmak önerilmez.
YUKARIDAKİ ANALİZE GÖRE ŞUNU ÖNERİYORUM. 1. Şu anda masaüstü kullanıcı dokümanlarında Sphinx doküman oluşturucu ve Read the Docs teması kullanılmaktadır. Android bağlantı noktası için aynısını kullanmak, şu konularda bize yardımcı olacaktır: -> Her iki dokümanı da kolayca birleştirme. -> Tüm ekran boyutları için optimize edilmiştir. -> Masaüstü dokümanları üzerinden Android kullanıcı dokümanlarına giderken sorunsuz deneyim
- Bölümleri, alt bölümleri ve alt alt bölümleri uygulamadaki göreceli konumlarına göre ayırma. Örneğin, Arka plan/PiP modu, Diğer -> Ayarlar -> Video bölümündedir. Bu nedenle bölüm yapısı şu şekilde olur:
- Daha fazla
- |__Ayarlar
- | |__Medya Kitaplığı
- | |__Video -->Arka Plan/PiP Modu
- : -> Bu yaklaşım, kullanıcıların uygulamadaki göreli konumla karşılaştırarak yardıma ihtiyaç duydukları bölüme kolayca gidebilecekleri için erişimi kolaylaştırır. Özelliklerin her birini teknik ve teknik olmayan bölümlere ayırabiliriz. Önce teknik olmayan kolay bir açıklama yazıp ardından aynı özelliğin teknik kısımlarını (varsa) hemen altında vurgularız veya etiketleriz. Bu durum bazı tekrarlara neden olabilir ancak teknik olmayan kullanıcıların sorunsuz bir deneyim yaşamasını sağlar. Bu, sürdürülebilirliği artırarak gelecekte de yardımcı olacaktır. Uygulama doygunluk durumuna ulaşacağından, ilgili kullanıcı arayüzünün çok fazla değişmesi beklenmez. Bu nedenle, gelecekte yeni bir özellik eklenirse/kaldırılırsa bölümü yeniden yapılandırabiliriz. Tüm kullanıcı arayüzünün değiştirilmesi durumunda bölümleri/bölümleri yeniden düzenleyebilir veya dokümanın tamamını yeniden yapılandırabiliriz. Her iki durumda da, ekran görüntüsünün mevcut kullanıcı arayüzüne uyacak şekilde değiştirilmesi gerekeceğinden tüm dokümanları değiştirmemiz gerekecektir. Çalışan bir demo burada barındırılı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ı ve 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ümanları etkilemeden veya geliştirme sırasında onlardan etkilenmeden iki dokümanı da sadece birkaç adımda birleştirmemize yardımcı olur. Geliştirildikten sonra bu dokümanların tamamını masaüstü dokümanlarının Android bölümüne yerleştirmeyi ve ardından Android için VLC dokümanları için kalıcı bir bağlantı oluşturmayı öneriyorum.
-> Diğer iyileştirmeler arasında, kullanıcıların doğrudan favori işletim sistemlerini seçmesine ve ardından seçilen işletim sisteminin dokümanlarına yönlendirilmesine olanak tanımak için masaüstü kullanıcı dokümanlarının başlangıç sayfasının yeniden tasarlanması yer alabilir. Windows, MacOS ve Linux VLC kullanıcı dokümanları zaten iyi tasarlanmış ve anlaşılır olduğundan Windows/MacOS/Linux ya da Android/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 güzelce ayrılmış ancak birleşik bir kullanıcı dokümanı elde edersiniz.
ÖNERDİĞİM KULLANICI DÖKÜMANLARI NEDEN DAHA İYİ? Önerilen bu kullanıcı dokümanları, son kullanıcının yardım almak için izlediği yaygın kalıplara göre yapılandırılmıştır. Kullanım kolaylığını ve son kullanıcı deneyimini en üst düzeye çıkarmak için dokümanlar, basitlik, netlik, görünüm ve his, teknolojik bilgi gibi gerekli tüm özellikleri bir araya getirir. Artık her bağlantı noktası için ayrı kullanıcı dokümanları oluşturmanız gerekmediğinden bu yöntem kolayca sürdürülebilir.
NEDEN BU PROJE İÇİN UYGUN KİŞİYİM? -> 2 yıldır kod yazıyorum ve sık sık belirli kitaplıklar veya bazı yazılımlar için API dokümanlarını incelemem, hatta kendi kodumu belgelemem gerekiyor. Bu sayede kullanıcıların dokümanda tam olarak ne görmek istediğini, hangi sorunlarla karşılaştığını ve yardım almak için nasıl bir yaklaşım sergilediğini biliyorum. Tutarlı ve kolay okunur dokümanlar yazmak için aynı deneyimi uygulayabilirim.
-> Quora, Stack Overflow ve diğer çeşitli platformlarda aktif olarak teknik konular hakkında yazılar yazıyorum. Konuyu ilgi çekici 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 bilinmemektedir veya bu konuda yardım yoktur. VLC'yi hem masaüstü hem de mobil platformlarda uzun yıllardır kullanıyorum ve kullanıcıların karşılaşabileceği sorunları biliyorum. Tüm bilgi ve deneyimlerimi birleştirerek mükemmel bir dokümasyon sunabilirim.