Project Qubes OS

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

Ringkasan proyek

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

Project description

ABSTRAK

Panduan pemecahan masalah dirancang untuk membantu pengguna akhir memecahkan masalah yang dihadapi saat menggunakan produk atau layanan. Panduan pemecahan masalah yang baik penting karena membantu pengguna saat terjadi masalah. Hal ini membuat pengguna tidak meninggalkan produk ketika mereka mengalami masalah. Qubes memiliki ribuan pengguna harian di seluruh dunia, banyak di antaranya akan menghadapi masalah pada waktu tertentu 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 menyebabkan postingan petunjuk yang sama berulang kali saat membantu pengguna mendiagnosis masalah. Panduan yang tersedia tidak memiliki tata letak tindakan gejala, sehingga menyulitkan pengguna untuk mencocokkan masalah dengan solusinya. Selain itu, ada beberapa masalah yang telah disebutkan berulang kali di media sosial (Reddit), halaman masalah GitHub Qubes, dan di forum #qubes-users, tetapi belum didokumentasikan dalam panduan pemecahan masalah saat ini.

MENGAPA PANDUAN PEMECAHAN MASALAH YANG DISARANKAN MENGHASILKAN PERBAIKAN DI ATAS YANG SAAT INI?

Panduan pemecahan masalah yang saya usulkan akan lengkap dan terstruktur untuk memastikan keakuratan dan navigasi yang mudah. Panduan ini akan menampilkan instruksi ringkas yang menjelaskan cara memecahkan masalah secara selangkah demi selangkah. Studi kasus akan menampilkan tata letak tindakan gejala, di mana masalah akan dinyatakan, diikuti dengan solusi yang disarankan untuk memecahkan masalah tersebut. Pemecahan masalah akan dioptimalkan oleh mesin telusur dan disusun dengan kata-kata untuk memperhitungkan masalah yang ditelusuri pengguna di media sosial dan mesin telusur. Semua hal ini akan 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 disertai dengan perkiraan jangka waktu untuk menulis setiap bagian pemecahan masalah. Tata letak ini akan diterapkan setelah mendapat umpan balik dari mentor. Struktur dan jangka waktu dapat dimodifikasi berdasarkan umpan balik mentor.

SASARAN PROYEK

  • Ubah struktur panduan pemecahan masalah agar memiliki tata letak tindakan gejala yang lebih mudah dipahami dan terkonsolidasi.
  • 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 semua masalah yang ditemukan. Saya memiliki tiga komputer: Lenovo Thinkpad, Dell Latitude, dan Acer Aspire. Saya akan mencoba Qubes di tiap komputer, merekam setiap kesalahan dan memvalidasi setiap pemecahan masalah.
  • Hapus informasi yang tidak digunakan lagi dalam panduan yang ada.
  • Pastikan pemecahan masalah akurat. Hingga saat ini, panduan pemecahan masalah yang ada memiliki pesan error ""Ini adalah dokumentasi pihak ketiga tidak resmi. Project Qubes OS tidak dapat menjamin keakuratan halaman ini. Harap berhati-hati"". Peringatan ini akan dihapus setelah petunjuk pemecahan masalah diverifikasi keakuratannya. Keakuratan mereka 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 pemecahan masalah resmi.
  • Teliti dan temukan lebih banyak masalah yang dihadapi oleh pengguna dari masalah Reddit (r/QubesOS), Stack Exchange, grup Google #qubes-users, dan 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 PROJECT INI?

Saya sangat tertarik dengan teknologi, terutama pengamanan cyber dan privasi. Saya percaya bahwa menulis adalah salah satu kemampuan saya. Saya sangat tertarik dengan Qubes OS karena OS ini bersinggungan dengan dua kepentingan utama saya: keamanan dan privasi. Saya pengguna setia produk yang berfokus pada keamanan dan privasi lainnya seperti DuckDuckGo dan Tor. Saya baru saja menemukan Qubes OS, dan saya menyukainya.

MENGAPA SAYA PERCAYA SAYA ADALAH ORANG YANG TEPAT UNTUK PROJECT INI

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