Project Qubes OS

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

Ringkasan project

Organisasi open source:
Qubes OS
Penulis teknis:
c1e0
Nama proyek:
Menggabungkan panduan pemecahan masalah
Durasi project:
Durasi standar (3 bulan)

Project description

ABSTRACT

Panduan pemecahan masalah dirancang untuk membantu pengguna akhir memecahkan masalah apa pun yang dihadapi saat menggunakan produk atau layanan. Panduan pemecahan masalah yang baik sangat penting karena membantu pengguna saat terjadi masalah. Hal ini mencegah pengguna meninggalkan produk saat mereka mengalami masalah. Qubes memiliki ribuan pengguna harian di seluruh dunia, banyak di antaranya akan menghadapi masalah pada suatu waktu dan akan mendapatkan manfaat dari panduan pemecahan masalah.

STATUS PANDUAN PEMECAHAN MASALAH SAAT INI

Saat ini, panduan pemecahan masalah QubesOS tersebar di banyak halaman dan terkadang tidak lengkap, sehingga berulang kali memposting instruksi yang sama berulang kali saat membantu pengguna mendiagnosis masalah. Panduan yang tersedia tidak memiliki tata letak gejala-tindakan, sehingga menyulitkan pengguna untuk mencocokkan masalah dengan solusinya. Selain itu, ada beberapa masalah yang telah disebutkan berulang kali di media sosial (Reddit), halaman masalah Qubes Github, dan di forum #qubes-users, tetapi belum didokumentasikan dalam panduan pemecahan masalah saat ini.

MENGAPA PANDUAN PEMECAHAN MASALAH YANG SAYA USULKAN ADALAH PENINGKATAN DARI PANDUAN SAAT INI?

Panduan pemecahan masalah yang saya usulkan akan lengkap dan terstruktur untuk memastikan akurasi dan navigasi yang mudah. Panduan ini akan menampilkan petunjuk ringkas yang menjelaskan cara menyelesaikan masalah secara bertahap. Halaman ini akan menampilkan tata letak gejala-tindakan, tempat masalah akan dinyatakan, diikuti dengan solusi yang direkomendasikan untuk memecahkan masalah tersebut. Pemecahan masalah akan dioptimalkan untuk mesin telusur dan dirumuskan untuk mempertimbangkan masalah yang ditelusuri pengguna di media sosial dan mesin telusur. Semua ini akan dilakukan untuk memastikan bahwa pengguna dapat menemukan panduan pemecahan masalah resmi melalui mesin telusur dan menemukan solusi untuk masalah mereka dengan cepat/mudah

STRUKTUR PANDUAN PEMECAHAN MASALAH YANG DISARANKAN dan JANGKA WAKTU

Saya telah membuat struktur yang diusulkan untuk panduan pemecahan masalah Qubes OS yang dapat ditemukan di sini: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Tata letak ini disertai dengan perkiraan jangka waktu untuk menulis setiap bagian pemecahan masalah. Tata letak ini akan diterapkan setelah masukan dari mentor. Struktur dan jangka waktu dapat diubah berdasarkan masukan mentor.

SASARAN PROJECT

  • Susun ulang panduan pemecahan masalah agar memiliki tata letak tindakan gejala yang terkonsolidasi dan lebih mudah dipahami.
  • Menulis ulang pemecahan masalah yang ada agar mendapatkan petunjuk langkah demi langkah yang mudah diikuti.
  • Tambahkan screenshot jika diperlukan
  • Instal dan coba Qubes sendiri dan catat masalah yang ditemukan. Saya memiliki tiga komputer: Lenovo Thinkpad, Dell Latitude, dan Acer Aspire. Saya akan mencoba Qubes di setiap komputer ini, mencatat error apa pun, dan memvalidasi pemecahan masalah apa pun.
  • Hapus informasi yang sudah tidak berlaku dalam panduan yang ada.
  • Pastikan pemecahan masalahnya akurat. Saat ini, panduan pemecahan masalah yang ada memiliki pesan error ""Ini adalah dokumentasi pihak ketiga yang tidak resmi. Project Qubes OS tidak dapat menjamin akurasi halaman ini. Harap berhati-hati"". Peringatan ini akan dihapus setelah petunjuk pemecahan masalah diverifikasi keakuratannya. Akurasi solusi tersebut akan dipastikan dengan menguji pemecahan masalah secara pribadi di PC saya (jika memungkinkan), atau memeriksa secara online apakah ada pengguna yang telah memvalidasi solusi tersebut.
  • Migrasikan pemecahan masalah eksternal apa pun (dari forum dan GitHub) ke halaman web pemecahan masalah resmi.
  • Riset dan temukan lebih banyak masalah yang dihadapi pengguna dari Reddit (r/QubesOS), Stack Exchange, grup Google #qubes-users, dan masalah GitHub. Saya juga akan menggunakan alat riset kata kunci seperti Keywordtool.io dan UberSuggest.com untuk menemukan pertanyaan yang sering ditelusuri di mesin telusur seperti Google.
  • Tambahkan bagian “Mendapatkan bantuan”, jika panduan pemecahan masalah tidak menyelesaikan masalah pengguna. Contohnya dapat dilihat di halaman pemecahan masalah Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help.

MENGAPA PROJEK INI?

Saya sangat tertarik dengan teknologi, khususnya pengamanan cyber dan privasi. Saya yakin menulis adalah salah satu keahlian saya yang paling kuat. Saya sangat tertarik dengan Qubes OS karena berkaitan dengan dua kepentingan utama saya: keamanan dan privasi. Saya adalah pengguna setia produk lain yang berfokus pada keamanan dan privasi seperti DuckDuckGo dan Tor. Baru-baru ini saya menemukan Qubes OS, dan sejauh ini saya menyukainya.

MENGAPA SAYA YAKIN BAHWA SAYA ADALAH ORANG YANG TEPAT UNTUK PROJECT INI

  • Saya sangat tertarik dengan keamanan, privasi, dan menulis dokumentasi yang baik/bermanfaat.
  • Karena saya mengalami masalah saat menginstal dan menggunakan Qubes OS, saya dapat menjelaskan masalah ini dengan lebih baik di petunjuk pemecahan masalah.
  • Dalam sebulan terakhir, saya telah mempelajari aspek teknis Sistem Operasi Qubes. Saya juga mempelajari dokumentasi Qubes OS secara ekstensif. Untuk merasakan proses pengeditan dokumentasi, saya membuat permintaan pull (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • Baru-baru ini saya menyelesaikan magang di project Tor. Peran saya adalah dukungan teknis dan penulisan. Saat bekerja di pusat bantuan, saya menerima ratusan pertanyaan dari pengguna yang mengalami masalah saat menginstal atau menggunakan Browser Tor. Dengan membantu pengguna ini memecahkan masalah mereka, saya belajar cara menulis petunjuk pemecahan masalah yang ringkas dan mudah dipahami
  • Saat bekerja di Tor Project, saya juga menulis dokumentasi teknis menggunakan Markdown. Saya menggunakan Git, GitHub, dan GitLab untuk kontrol versi.