Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of 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. IA membantu pengguna mempelajari cara menggunakan perangkat lunak atau layanan. Tidak semua orang ingin menghubungi dukungan atau menunggu balasan email jika yang dia butuhkan hanyalah sedikit arahan, tips, atau trik. Dokumentasi pengguna adalah hal itu. Teknologi ini juga mengurangi biaya dukungan dan merupakan identitas kesehatan produk dan tim developer.
VLC untuk Android telah diunduh lebih dari 100 juta kali dari Google Play Store saja. VLC menyediakan banyak fitur untuk port selulernya, mulai dari pemutaran audio-video hingga aliran data jaringan. Sering kali orang ingin menggunakan fitur luar biasa ini tetapi mereka tidak dapat melakukannya. Menelusuri blog atau beberapa video acak untuk hal ini membutuhkan banyak waktu dan kesabaran, namun tidak ada informasi keaslian 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 bulan Maret 2019. Project saat ini akan menyediakan dokumentasi Pengguna baru dengan desain modern dan lebih mudah digunakan untuk port Android.
SITUASI SAAT INI
Halaman wiki benar-benar ketinggalan zaman dan berisi lebih sedikit informasi tentang versi terbaru VLC. Selain itu, tidak mudah untuk melakukan navigasi. Tidak ada opsi yang terlihat untuk membaca dokumentasi dalam bahasa lain selain bahasa Inggris. Tidak berisi deskripsi fitur sama sekali.
ANALISIS
-> Saat ini dokumentasi saat ini sudah tidak berlaku 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 lebih banyak informasi teknis 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 hal teknis dan non-teknis akan menimbulkan kebingungan tambahan. Karena sekali lagi sebagian besar pengguna sudah 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.
-> Sebagian besar pengguna akan mencoba mendapatkan informasi melalui smartphone mereka sendiri dan beristirahat melalui desktop atau perangkat lain. Jadi, dokumentasi harus mudah diadaptasikan dengan setiap ukuran layar. Dan tidak akan menimbulkan kebingungan tentang navigasi.
-> Tidak semua fitur versi desktop tersedia di port Android, dan jika tersedia, fitur tidak berfungsi sama di kedua port. Hal ini karena aplikasi desktop telah dikembangkan lebih lama dan telah mencapai semacam status saturasi, sedangkan port seluler relatif baru dan masih berkembang. Selain itu, meskipun sekarang perangkat seluler menjadi semakin canggih, ada batasan yang jelas pada jenis fitur yang dapat kami sertakan terutama karena permintaan pengguna akhir. Memiliki fitur yang tidak digunakan siapa pun adalah pemborosan sumber daya pengembangan. Jadi, tidak disarankan untuk mendiskusikan kedua dokumentasi berdasarkan fitur.
BERDASARKAN ANALISIS DI ATAS, SAYA MENGUSARANKAN HAL BERIKUT. 1. Hingga saat ini, dokumentasi pengguna Desktop menggunakan generator Dokumentasi Sphinx dan tema Bacaan Dokumen. Penggunaan 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
- Lainnya
- |__Setelan
- | |__Media Library
- | |__Video -->Mode Latar Belakang/PiP
- : -> Pendekatan ini akan meningkatkan kemudahan akses karena pengguna akan dapat dengan mudah menavigasi ke bagian yang memerlukan bantuan dengan membandingkannya dengan lokasi relatif dalam aplikasi. Untuk setiap fitur, kita dapat lebih jauh memisahkan bagian teknis dan non-teknis. Pertama-tama, kita akan menulis deskripsi mudah non-teknis dan kemudian menyoroti atau memberi label lebih lanjut 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 responden non-teknis. Hal ini juga akan membantu bisnis Anda pada masa mendatang dengan meningkatkan kemudahan pemeliharaan. Karena aplikasi akan mencapai status saturasi, UI relatif tidak akan 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 berisi 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 mencakup desain ulang halaman awal dokumentasi pengguna Desktop agar pengguna dapat langsung memilih OS favorit mereka, lalu mengalihkan pengguna ke dokumentasi OS yang dipilih. Karena dokumentasi pengguna VLC Windows, MacOS, dan Linux sudah dirancang dan dibahas dengan baik, kami dapat memilih opsi dari Windows/MacOS/Linux atau Android atau iOS. Ini akan menghasilkan dokumentasi pengguna yang terpisah dengan baik tetapi menyatu dengan hanya satu tautan yang bisa digunakan untuk semua porta.
MENGAPA DOKUMENTASI PENGGUNA SAYA LEBIH BAIK? Dokumentasi pengguna yang diusulkan ini disusun berdasarkan pola umum yang diikuti oleh pengguna akhir untuk mendapatkan bantuan. Dokumentasi ini menggabungkan semua fitur yang diperlukan, misalnya Kesederhanaan, Kejelasan, Tampilan dan nuansa, pengetahuan teknologi untuk memaksimalkan kemudahan penggunaan dan pengalaman pengguna akhir. Ini juga mudah dikelola karena tidak perlu lagi menyimpan dokumentasi pengguna individual untuk setiap port.
MENGAPA SAYA ORANG YANG TEPAT UNTUK PROJECT INI? -> Saya telah menulis kode selama 2 tahun dan sering kali saya harus membaca dokumentasi API untuk library tertentu atau beberapa software atau bahkan mendokumentasikan kode saya sendiri. Jadi saya tahu persis apa yang ingin dilihat orang dalam dokumentasi, masalah apa yang mereka hadapi dan bagaimana pendekatan mereka untuk mendapatkan bantuan. Saya akan 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 canggih dan sangat terkenal, namun 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 mengumpulkan semua pengetahuan dan pengalaman saya, saya dapat memastikan dokumentasi yang bagus.