Halaman ini diterjemahkan oleh Cloud Translation API.

Project VLC

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:: VLC
Penulis teknis:: Avii
Nama proyek:: Membuat Dokumentasi Pengguna VLC untuk satu port seluler (Android)
Durasi proyek:: Durasi standar (3 bulan)

Project description

ABSTRAK

Dokumentasi pengguna digunakan sebagai sistem dukungan statis untuk membantu pengguna akhir. Memberikan informasi teknis dan non-teknis tentang suatu produk atau layanan. Hal ini membantu pengguna belajar cara menggunakan perangkat lunak atau layanan. Tidak semua orang ingin menghubungi dukungan atau menunggu balasan email jika yang ia butuhkan hanyalah sedikit arahan, tips, atau trik. Dokumentasi pengguna melakukan hal itu. Ini juga mengurangi biaya dukungan dan merupakan identitas kesehatan produk dan tim developer.

VLC untuk Android telah didownload lebih dari 100 juta kali dari Google Play Store saja. VLC menyediakan banyak fitur pada porta selulernya, mulai dari pemutaran audio-video hingga aliran jaringan. Sering kali orang ingin menggunakan fitur mengagumkan ini, tetapi mereka tidak dapat melakukannya. Mencari blog atau beberapa video acak untuk hal ini membutuhkan banyak waktu dan kesabaran dan tetap saja, tidak ada keaslian informasi yang diperoleh. Saat ini, VLC menghosting dokumentasi pengguna VLC untuk Android di halaman wiki dan memberikan lebih sedikit deskripsi atau tidak memberikan deskripsi tentang fitur ini. Selain itu, halaman wiki terakhir diperbarui pada Maret 2019. Project saat ini akan memberikan dokumentasi Pengguna baru dengan desain modern dan lebih mudah digunakan untuk port Android.

SITUASI SAAT INI

Halaman wiki benar-benar ketinggalan zaman dan berisi sangat sedikit informasi tentang versi terbaru VLC. Selain itu, mereka tidak mudah dijelajahi. Tidak ada opsi yang terlihat untuk membaca dokumentasi dalam bahasa selain bahasa Inggris. Iklan ini tidak berisi deskripsi fitur sama sekali.

ANALISIS

-> Saat ini, dokumentasi saat ini sudah usang dan harus ditulis dengan cara baru serta menggunakan platform dan alat yang berbeda.

-> Sebagian besar pengguna Android memiliki sedikit atau tidak memiliki pengetahuan teknis. Tetapi ada orang-orang yang membutuhkan informasi lebih teknis tentang sebuah fitur. Menulis dan mempertahankan dua dokumentasi terpisah untuk setiap tujuan di atas bukanlah ide yang baik. Atau bahkan dalam dokumentasi yang sama yang membagi fitur berdasarkan hal teknis dan non-teknis akan menambah kebingungan. Karena sekali lagi sebagian besar pengguna terbiasa dengan UI yang mereka lihat atau fitur yang mereka gunakan, ini tidak mudah bagi semua orang untuk memutuskan apakah sesuatu bersifat teknis atau non-teknis. Jadi kita ingin menyederhanakan ini untuk mereka.

-> Sebagian besar pengguna akan mencoba mendapatkan informasi melalui smartphone mereka sendiri dan beristirahat melalui desktop atau perangkat lain. Jadi, dokumentasi harus mudah disesuaikan dengan setiap ukuran layar. Dan tidak akan menimbulkan kebingungan tentang navigasi.

-> Tidak semua fitur versi desktop tersedia di port Android dan, jika tersedia, berarti tidak berfungsi dengan sama di kedua port. Hal ini karena aplikasi desktop telah dikembangkan cukup lama dan telah mencapai status saturasi, sebaliknya port seluler relatif baru dan masih berkembang. Selain itu, meskipun perangkat seluler zaman sekarang menjadi sangat canggih, ada batasan yang jelas pada jenis fitur yang dapat digabungkan terutama karena permintaan dari pengguna akhir. Memiliki fitur yang tidak digunakan siapa pun akan membuang-buang sumber daya pengembangan. Jadi, mendiskusikan kedua dokumentasi tersebut berdasarkan fitur tidaklah disarankan.

BERDASARKAN ANALISIS DI ATAS, SAYA SARANKAN HAL BERIKUT. 1. Sampai sekarang, dokumentasi pengguna Desktop menggunakan generator Dokumentasi Sphinx dan Baca tema Docs. Menggunakan hal yang sama untuk port Android akan membantu kita dalam hal berikut: -> Penggabungan kedua dokumentasi dengan mudah. -> Dioptimalkan untuk semua ukuran layar. -> Pengalaman yang lancar saat membuka Dokumentasi Pengguna Android melalui Dokumentasi Desktop

Memisahkan bab, bagian, dan subbagian sesuai dengan posisi relatifnya dalam aplikasi. Misalnya - Mode Latar Belakang/PiP ada di dalam Lainnya -> Setelan->Video. Jadi, struktur segmen akan menjadi

Lainnya

|__Setelan

| |__Pustaka Media

| |__Video -->Mode Latar Belakang/PiP

: -> Pendekatan ini akan meningkatkan kemudahan akses karena pengguna akan dapat dengan mudah membuka bagian bantuan yang mereka butuhkan dengan membandingkannya dengan lokasi relatif dalam aplikasi. Untuk setiap fitur, kita dapat memisahkan bagian teknis dan non-teknis lebih lanjut. Pertama-tama, kita akan menulis deskripsi non-teknis dan mudah lalu menyoroti atau memberi label lebih lanjut pada bagian teknis dari fitur yang sama, jika ada, tepat di bawahnya. Hal ini mungkin menyebabkan pengulangan, tetapi akan memastikan pengalaman yang lancar bagi sebagian besar pengguna non-teknis. Hal ini juga akan membantu di masa mendatang dengan meningkatkan pemeliharaan. Karena aplikasi akan mencapai status saturasi, UI relatif cenderung tidak banyak berubah, jadi di masa mendatang jika fitur baru ditambahkan/dihapus, kita cukup memfaktorkan ulang bagian tersebut. Jika seluruh UI diubah, kita dapat mengatur ulang bagian/bab atau menyusun ulang seluruh dokumen, kita perlu mengubah seluruh dokumentasi karena screenshot harus diganti agar sesuai dengan UI saat ini. Demo kerja dihosting di sini : https://avinal.gitlab.io/vlc-android-docs/
Setiap bagian dokumentasi harus terdiri dari tangkapan layar berlabel , deskripsi fitur, bagian yang lebih teknis jika ada, serta kiat dan trik untuk fitur tersebut.

-> Mengembangkan dokumentasi pengguna ini dari desktop secara independen akan membantu kami menggabungkan kedua dokumentasi hanya dalam beberapa langkah tanpa memengaruhi dokumentasi saat ini atau terpengaruh olehnya selama pengembangan. Saya mengusulkan untuk menempatkan seluruh dokumentasi ini di bagian Android pada dokumentasi desktop setelah dikembangkan, lalu membuat permalink untuk dokumentasi VLC untuk Android.

-> Peningkatan lainnya mungkin termasuk mendesain ulang halaman awal dokumentasi pengguna Desktop agar pengguna dapat langsung memilih OS favorit mereka, lalu mengarahkan kembali ke dokumentasi OS yang dipilih. Karena dokumentasi pengguna VLC Windows, MacOS, dan Linux sudah dirancang dan digunakan dengan baik, kami dapat memilih opsi dari Windows/MacOS/Linux atau Android atau iOS. Hal ini akan menghasilkan dokumentasi pengguna yang terpisah dengan baik tetapi menyatu dengan hanya satu tautan untuk digunakan pada semua port.

MENGAPA DOKUMENTASI PENGGUNA YANG SAYA usulkan LEBIH BAIK? Dokumentasi pengguna yang diusulkan ini disusun berdasarkan pola umum diikuti oleh pengguna akhir untuk mendapatkan bantuan. Dokumentasi menggabungkan semua fitur yang diperlukan, mis. Kesederhanaan, Kejelasan, Tampilan dan nuansa, pengetahuan teknologi untuk memaksimalkan kemudahan penggunaan dan pengalaman pengguna akhir. Ini juga mudah dikelola karena tidak perlu lagi mengelola dokumentasi pengguna individual untuk setiap port.

MENGAPA SAYA MENJADI ORANG YANG TEPAT UNTUK PROJECT INI? -> Saya telah menulis kode selama 2 tahun sekarang dan sering kali saya perlu melihat dokumentasi API untuk perpustakaan tertentu atau beberapa perangkat lunak atau bahkan mendokumentasikan kode saya sendiri. Jadi saya tahu persis apa yang ingin dilihat pengguna dalam dokumentasi, masalah apa yang mereka hadapi, dan cara yang mereka gunakan untuk mendapatkan bantuan. Saya dapat menerapkan pengalaman yang sama untuk menulis dokumentasi yang konsisten dan mudah dibaca.

-> Saya telah aktif menulis hal-hal teknis di Quora, Stack Overflow, dan berbagai platform lainnya. Saya tahu cara menjelaskan sesuatu dengan cara yang menarik dan mudah dipahami orang.

-> VLC untuk Android adalah alat yang ampuh dan sangat terkenal, namun sebagian besar fiturnya tidak dikenal atau tidak ada bantuan yang tersedia. Saya telah menggunakan VLC di platform desktop dan seluler selama bertahun-tahun dan saya tahu masalah yang mungkin dihadapi pengguna. Dengan menyimak semua pengetahuan dan pengalaman, saya dapat memastikan sebuah dokumentasi yang bagus.