Halaman ini diterjemahkan oleh Cloud Translation API.

Project VLC

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

Ringkasan project

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

Project description

ABSTRACT

Dokumentasi pengguna digunakan sebagai sistem dukungan statis untuk membantu pengguna akhir. Halaman ini memberikan informasi teknis dan non-teknis tentang produk atau layanan. Video ini membantu pengguna mempelajari cara menggunakan software atau layanan. Tidak semua orang ingin menghubungi dukungan atau menunggu balasan email jika yang dia butuhkan hanyalah sedikit petunjuk, tips, atau trik. Dokumentasi pengguna hanya melakukan hal itu. Hal 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 untuk port selulernya, mulai dari pemutaran audio-video hingga streaming jaringan. Sering kali orang ingin menggunakan fitur luar biasa ini, tetapi mereka tidak dapat melakukannya. Menelusuri blog atau video acak untuk hal ini memerlukan banyak waktu dan kesabaran, dan tetap saja, informasi yang diperoleh tidak autentik. Saat ini, VLC menghosting dokumentasi pengguna VLC untuk Android di halaman wiki dan memberikan deskripsi yang lebih sedikit atau tidak sama sekali untuk fitur ini. Selain itu, halaman wiki terakhir diperbarui pada Maret 2019. Project saat ini akan menyediakan dokumentasi Pengguna baru dengan desain modern dan kemudahan penggunaan yang lebih besar untuk port Android.

SITUASI SAAT INI

Halaman wiki sudah tidak berlaku lagi dan berisi sangat sedikit informasi tentang VLC versi terbaru. Selain itu, situs tersebut tidak mudah dinavigasi. Tidak ada opsi yang terlihat untuk membaca dokumentasi dalam bahasa selain bahasa Inggris. Judul ini tidak berisi deskripsi fitur sama sekali.

ANALISIS

-> Saat ini, dokumentasi yang ada sudah tidak berlaku dan perlu ditulis dengan cara baru serta menggunakan platform dan alat yang berbeda.

-> Sebagian besar pengguna Android memiliki sedikit atau tidak memiliki pengetahuan teknis. Namun, ada orang yang memerlukan informasi teknis lebih lanjut tentang suatu fitur. Menulis dan memelihara dua dokumentasi terpisah untuk setiap tujuan di atas bukanlah ide yang baik. Atau bahkan dalam dokumentasi yang sama, membagi fitur berdasarkan teknis dan non-teknis akan menimbulkan kebingungan tambahan. Karena sekali lagi sebagian besar pengguna terbiasa dengan UI yang mereka lihat atau fitur yang mereka gunakan, tidak mudah bagi semua orang untuk memutuskan apakah sesuatu bersifat teknis atau non-teknis. Jadi, kita ingin menyederhanakannya 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, tidak berfungsi sama di kedua port. Hal ini karena aplikasi desktop telah dikembangkan lebih lama dan telah mencapai semacam status kejenuhan, sedangkan port seluler relatif baru dan masih dalam pengembangan. Selain itu, meskipun perangkat seluler saat ini menjadi sangat canggih, ada batasan yang jelas pada jenis fitur yang dapat kita sertakan, terutama karena permintaan pengguna akhir. Memiliki fitur yang tidak digunakan oleh siapa pun adalah pemborosan resource pengembangan. Jadi, menggabungkan kedua dokumentasi berdasarkan fitur tidak direkomendasikan.

BERDASARKAN ANALISIS DI ATAS, SAYA MENYARANKAN HAL BERIKUT. 1. Saat ini, dokumentasi pengguna Desktop menggunakan generator Dokumentasi Sphinx dan tema Read the Docs. Menggunakan hal yang sama untuk port Android akan membantu kita dengan cara berikut: -> Penggabungan kedua dokumentasi menjadi 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 penerapan. Misalnya - Mode Latar Belakang/PiP berada di bagian Lainnya -> Setelan->Video, sehingga struktur bab akan

Lainnya

|__Setelan

| |__Koleksi Media

| |__Video -->Mode Latar Belakang/PiP

: -> Pendekatan ini akan meningkatkan kemudahan akses karena pengguna akan dapat membuka bagian yang mereka butuhkan dengan mudah 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 mudah non-teknis, lalu menandai atau memberi label pada bagian teknis fitur yang sama, jika ada, tepat di bawahnya. Hal ini mungkin menyebabkan beberapa pengulangan, tetapi akan memastikan pengalaman yang lancar bagi sebagian besar pengguna non-teknis. Hal ini juga akan membantu di masa mendatang dengan meningkatkan kemampuan pemeliharaan. Karena aplikasi akan mencapai status kejenuhan, UI relatif tidak akan banyak berubah, sehingga pada masa mendatang jika fitur baru ditambahkan/dihapus, kita cukup memfaktorkan ulang bagian tersebut. Jika seluruh UI diubah, kita dapat menyusun ulang bagian/bab atau menyusun ulang seluruh dokumen. Dalam kedua kasus tersebut, kita perlu mengubah seluruh dokumentasi karena screenshot harus diganti agar sesuai dengan UI saat ini. Demo yang berfungsi dapat diakses di sini : https://avinal.gitlab.io/vlc-android-docs/
Setiap bagian dokumentasi harus terdiri dari screenshot berlabel, deskripsi fitur, bagian yang lebih teknis jika ada, serta tips dan trik untuk fitur tersebut.

-> Mengembangkan dokumentasi pengguna ini secara independen dari desktop akan membantu kita 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 dalam dokumentasi desktop setelah dikembangkan, lalu membuat permalink untuk dokumentasi VLC untuk Android.

-> Peningkatan lainnya dapat mencakup mendesain ulang halaman awal dokumentasi pengguna Desktop agar pengguna dapat langsung memilih OS favorit mereka, lalu mengalihkan ke dokumentasi OS yang dipilih. Karena dokumentasi pengguna VLC untuk Windows, MacOS, dan Linux sudah didesain dan dibahas dengan baik, kami dapat menempatkan opsi untuk memilih dari Windows/MacOS/Linux atau Android atau iOS. Hal ini akan menghasilkan dokumentasi pengguna yang terpisah dengan baik, tetapi terpadu dengan hanya satu link yang dapat digunakan untuk semua port.

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

MENGAPA SAYA ORANG YANG TEPAT UNTUK PROJEK INI? -> Saya telah menulis kode selama 2 tahun dan sering kali saya perlu membaca dokumentasi API untuk library atau software tertentu atau bahkan mendokumentasikan kode saya sendiri. Jadi, saya tahu persis apa yang ingin dilihat orang dalam dokumentasi, masalah apa yang mereka hadapi, dan cara mereka mendapatkan bantuan. Saya akan dapat menerapkan pengalaman yang sama untuk menulis dokumentasi yang konsisten dan mudah dibaca.

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

-> VLC untuk Android adalah alat yang canggih dan sangat terkenal, tetapi sebagian besar fiturnya tidak diketahui 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 menggunakan semua pengetahuan dan pengalaman saya, saya dapat menjamin dokumentasi yang bagus.