Halaman ini diterjemahkan oleh Cloud Translation API.

Project VideoLAN

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

Ringkasan proyek

Organisasi open source:: VideoLAN
Penulis teknis:: Edidiong Anny Asikpo
Nama proyek:: Memodernisasi (menulis ulang) dokumentasi pengguna VLC
Durasi proyek:: Durasi standar (3 bulan)

Project description

ABSTRAK

Dokumentasi pengguna dirancang untuk membantu pengguna akhir menggunakan suatu produk atau layanan. Dokumentasi pengguna yang baik sangat penting karena menyediakan cara bagi pengguna untuk mempelajari cara menggunakan perangkat lunak, fiturnya, kiat, trik, dan juga menyelesaikan masalah umum yang dihadapi saat menggunakan perangkat lunak tersebut. Ini juga mengurangi biaya dukungan dan merupakan bagian dari identitas perusahaan produk: dokumentasi pengguna yang baik adalah tanda kesehatan produk, tim pengembang.

Tanpa dokumentasi pengguna yang baik, seorang pengguna mungkin tidak tahu bagaimana melakukan hal-hal di atas secara efektif dan efisien. Dokumentasi Pengguna dapat memainkan peran penting dalam memastikan keberhasilan suatu produk karena komunikasi yang hebat adalah dan akan selalu menjadi jantung bisnis atau produk apa pun dan dokumentasi yang hebat hanya mengambil komunikasi itu dan menempatkannya dalam kerangka kerja yang mudah dikelola yang dapat diakses setiap orang untuk sukses.

Pada saat penulisan ini, dokumentasi pengguna VLC telah diakses 4.634.065 kali dan pemutar media VLC diunduh sekitar 23 juta kali setiap bulan dari situs web utama, ini menunjukkan bahwa banyak orang di seluruh dunia menggunakan VLC Media Player dan mungkin ingin membaca dokumentasi penggunanya untuk panduan tentang cara menggunakan pemutar media. Namun, dokumentasi pengguna pemutar media VLC saat ini sudah ketinggalan zaman dan tidak lengkap (terakhir diubah pada hari 28 Oktober 2015) dan komunitas VideoLAN ingin menggunakan proyek ini untuk meningkatkan dokumentasi penggunanya agar pengguna akhir memiliki pengalaman yang mulus saat menggunakan pemutar media VLC.

NEGARA BAGIAN SAAT INI

Saat ini, dokumentasi pengguna tersedia di halaman wiki. Materi ini sudah usang, tidak lengkap, sulit dinavigasi atau menemukan informasi, tidak mencakup informasi tentang pemutar media versi saat ini dan hanya dapat diterjemahkan dalam bahasa Jerman yang menyebabkan kemunduran besar bagi orang-orang yang tidak dapat membaca Bahasa Inggris.

MENGAPA DOKUMENTASI PENGGUNA YANG DISARANKAN MENJADI PERBAIKAN DI ATAS YANG SAAT INI?

Dokumentasi pengguna yang diusulkan akan disusun untuk meningkatkan dan memastikan efisiensi, konsistensi, dan ketenangan pikiran bagi pengguna akhir. Panduan ini akan berisi panduan tertulis dan gambar terkait, termasuk petunjuk dan penjelasan tentang cara menggunakan setiap fitur pemutar media VLC, mutakhir, mudah dinavigasi, dapat dipahami, dan dapat diterjemahkan dalam setidaknya lima bahasa utama.

Mentor: Jean-Baptiste, Alex, Simon

ANALISIS

Jean-Baptiste dan saya berdiskusi tentang lingkungan baru yang menjadi tujuan migrasi dokumentasi pengguna saat ini untuk peningkatan dan dia berbagi dua link yang menunjukkan repositori Gitlab dari file sumber yang ditulis dengan Sphinx dan dokumentasi utama yang dihosting di Read the Docs dan dia mengatakan mereka mengharapkan dokumentasi baru serupa dengan itu. Saya banyak meneliti alat-alat ini untuk mendapatkan pemahaman yang lebih baik tentang cara kerjanya.

Sphinx

Sphinx adalah solusi yang andal dan matang untuk dokumentasi perangkat lunak. Ini mencakup sejumlah fitur yang diharapkan penulis, seperti publikasi sumber tunggal, penggunaan ulang konten melalui penyertaan, penyertaan bersyarat berdasarkan jenis dan tag konten, beberapa tema HTML dewasa yang memberikan pengalaman pengguna luar biasa di seluler dan desktop, mereferensikan berbagai halaman, dokumen, dan project. Dukungan Indeks dan Glosarium, serta dukungan internasionalisasi. reStructuredText juga menggunakan reStructuredText sebagai bahasa markup-nya, dan keunggulannya berasal dari kehebatan dan kemudahan reStructuredText serta kemampuannya untuk menerjemahkan dokumentasi.

Baca Dokumentasi

Baca Dokumen menyederhanakan dokumentasi software dengan mengotomatiskan pembuatan, pembuatan versi, dan hosting dokumen untuk Anda. Alat ini tidak pernah sinkron; artinya, setiap kali Anda mendorong kode ke sistem kontrol versi favorit, baik itu Git, Mercurial, Bazaar, atau Subversion, Baca Dokumen akan otomatis membangun dokumen Anda sehingga kode dan dokumentasi Anda selalu terbaru. Tersedia beberapa versi; Baca Dokumen dapat menghosting dan membangun beberapa versi dokumen Anda sehingga memiliki versi 1.0 dokumen dan versi 2.0 dokumen semudah memiliki cabang atau tag terpisah dalam sistem kontrol versi. Baca Dokumen tersedia gratis dan bersifat open source serta menghosting dokumentasi untuk hampir 100.000 proyek open source besar dan kecil dalam hampir setiap bahasa manusia dan komputer.

SANGAT

Sphinx adalah alat yang sangat hebat dan Membaca Dokumen di atas untuk menyediakan hosting bagi dokumentasi Sphinx yang memperbarui dokumen Anda di berbagai versi. Bersama-sama, mereka adalah seperangkat alat luar biasa yang dapat digunakan oleh pengembang dan penulis teknis untuk membuat dokumentasi pengguna yang terbaik bagi pengguna akhir.

Sphinx menyertakan dukungan untuk menerjemahkan dokumentasi ke dalam berbagai bahasa. Aplikasi ini mendukung kontrol versi yang akan digunakan untuk mengelola dokumentasi. Tidak seperti wiki saat ini di mana siapa pun dapat mengedit dan tidak menambahkan informasi yang tepat, sistem kontrol versi ini akan memastikan bahwa semua perubahan ditinjau terlebih dahulu sebelum digabungkan ke repositori utama. Kontrol versi juga akan membuat dokumentasi meningkatkan kontribusi open source ke proyek karena orang dapat membuat masalah, membuka permintaan pull, dll. Sphinx dan membaca Dokumen digunakan oleh daftar komunitas hebat lainnya seperti; ASP.NET, Kernel, Julia, Jupyter, PHPMyAdmin, Tulis Dokumen, dll. dan ini adalah alat yang hebat untuk digunakan dalam dokumentasi pengguna VLC baru.

Saya tidak hanya membaca tentang alat-alat ini, saya juga membuat sampel dasar. Ini adalah link: https://gitlab.com/Didicodes/demo-vlc-user-documentation ke repositori Gitlab saya, sementara versi yang dihosting pada readthedocs dapat ditemukan di sini: [https://vlc-user-documentation-demo.readthedocs.io/en/latest/](https://vlc-user-documentation-demo.readthedocs.io/en/latest/.

STRUKTUR DOKUMENTASI YANG DISARANKAN

Saya telah membuat struktur untuk Dokumentasi Pengguna VLC yang dapat ditemukan di sini; https://docs.google.com/document/d/1Sy2V2IADoCyfnGBK70v8mkjiWK2tH-oWdUlDxAfQAYA/edit?usp=sharing. Sebelum implementasi struktur baru ini dimulai, struktur itu harus disetujui oleh mentor. Ini berarti bahwa strukturnya mungkin akan berubah setelah ditinjau oleh mentor.

SASARAN PROYEK

Mengubah struktur dokumentasi.
Mengupdate dokumentasi agar sesuai dengan versi VLC modern.
Memigrasikan dokumentasi pengguna ke Gitlab menggunakan Sphinx dan ReadtheDocs.
Hapus gambar dan informasi yang sudah tidak digunakan lagi.
Menulis ulang dokumentasi pengguna agar lebih mudah dipahami.
Siapkan untuk penerjemahan menggunakan Internasionalisasi Sphinx.
Mendorong komunitas dokumentasi sehingga pengguna dapat melaporkan atau menyelesaikan masalah apa pun yang ditemukan saat membaca dokumentasi.

MENGAPA PROJECT INI?

Saya selalu yakin bahwa menulis kode, memecahkan masalah, dan membangun perangkat lunak mencapai potensi penuhnya ketika Anda juga memiliki kemampuan untuk memberi penerangan kepada orang lain tentang hal itu melalui penulisan. Secara pribadi, saya selalu terpesona dengan upaya yang dilakukan oleh komunitas VideoLAN dalam menciptakan solusi software gratis untuk multimedia. Saat tumbuh dewasa, pemutar media VLC selalu merupakan perangkat lunak yang saya gunakan saat mendengarkan musik atau menonton film karena sangat berisik dan terdiri dari begitu banyak fitur. Suatu kehormatan bisa bekerja sama dengan komunitas yang berkontribusi membuat masa kecil saya jadi luar biasa.

MENGAPA SAYA JADI ORANG YANG TEPAT UNTUK PROJECT INI

Saya yakin saya adalah orang yang tepat untuk proyek ini karena:

Saya memiliki pengalaman sebelumnya dalam meningkatkan dokumentasi organisasi dan saya dapat menggunakan sistem kontrol versi, jadi menjalankan perintah di Gitab tidak akan menjadi masalah. Selain itu, yang memotivasi saya adalah mengerjakan proyek yang menciptakan nilai bagi orang-orang.
Jika Anda ingin seseorang melakukan sesuatu dengan cara yang paling efisien, Anda mendokumentasikannya. Dengan mendokumentasikan proses, Anda memastikan efisiensi, konsistensi, dan ketenangan pikiran bagi siapa pun yang terlibat.
Saya mengetahui kebutuhan pengguna VLC karena saya adalah salah satunya. Ini akan memungkinkan penulisan dokumentasi sedemikian rupa sehingga dapat langsung dipahami oleh semua pengguna di seluruh dunia.