Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Qubes OS
- Penulis teknis:
- luzeal
- Nama project:
- Melakukan aktivasi dengan QubesOS. Mari kita tulis panduan terbuka dan mudah digunakan
- Durasi project:
- Durasi standar (3 bulan)
Project description
Aktifkan dengan QubesOS.
Saya ingin membuat panduan terbuka dan materi terkait untuk pengguna QubesOS pemula. Tujuannya adalah untuk memperkenalkan QubesOS kepada orang awam, dan membuat panduan ini sesederhana dan sejelas mungkin, menggunakan analogi, ilustrasi, dan diagram. Agar ringkas, link ke referensi yang andal dan tepercaya akan digunakan, termasuk yang ada di situs QubesOS. Semuanya akan dirilis dengan lisensi terbuka.
Yang dimaksud dengan mandiri adalah konten yang dapat ada secara terpisah dari situs, misalnya sebagai buku panduan. Panduan ini tidak sama dengan panduan versi offline. Idealnya, akan dibuat pipeline lain untuk memublikasikan konten sebagai panduan.
Yang dimaksud dengan terbuka adalah panduan yang akan dirilis dengan lisensi terbuka.
Cara melakukannya
Menentukan target audiens
Mulai hari ini, saya kira kategori pengguna yang ditargetkan QubesOS tidak terdefinisi dengan baik. Bagaimana QubesOS dapat membantu jurnalis, pengacara, analis keamanan, developer software, dan sebagainya? Akan lebih baik jika Anda menjelaskan skenario yang dapat berguna dengan QubeOS.
Menetapkan ekspektasi dengan benar
Penting juga untuk memperingatkan pengguna pemula bahwa QubesOS memerlukan tingkat pengetahuan IT yang cukup. Ada biaya yang harus dibayar untuk menggunakan QubesOS, dari segi kegunaan, terutama jika QubesOS adalah sistem komputasi utama Anda. Namun demikian, ada hal-hal yang (secara desain) tidak akan dilakukan QubeOS dengan baik, seperti akselerasi 3D di virtual machine. Penting untuk menjelaskannya sejak awal, bukan untuk mencegah orang menggunakannya, tetapi untuk menetapkan pengecualian bagi calon pengguna.
Pengertian QubesOS dan bukan QubesOS
Meskipun QubesOS adalah jenis sistem operasi khusus (distribusi Xen), akan menarik untuk membandingkannya dengan sistem operasi lain berdasarkan fungsinya atau tidak adanya fungsi (misalnya, Windows semakin banyak menggunakan virtualisasi dan sandboxing sebagai mekanisme keamanan). Diagram/tabel sederhana dapat digunakan.
Spesifikasi untuk panduan akan ditentukan bersama komunitas.
Apa saja informasi minimum yang harus ada dalam panduan? Seberapa mudah penginstalan dapat disederhanakan tanpa mengorbankan keamanan? Di mana seharusnya nilai minimumnya? Apakah ada penyiapan QubesOS yang minimal dan aman? Jika tidak, kategori tersebut dapat ditentukan dan ditetapkan sebagai target untuk panduan.
Lisensi
Ambil lisensi. Wiki Archlinux yang terkenal menggunakan GNU Free Documentation License 1.3 atau yang lebih baru. Apakah lisensi ini cocok?
endevoar lainnya
Membuat dokumentasi situs lebih menarik secara visual
Catatan dapat ditandai menggunakan warna merah atau kuning agar lebih mudah dilihat. Misalnya, kotak warna dapat digunakan, seperti yang ditemukan di wiki archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Kutip blok dapat digunakan.
Konten link
Saat ini ada cukup banyak konten untuk situs dokumentasi, tetapi setiap bagian sering kali tidak ditautkan ke topik lain yang relevan. Artikel dapat ditautkan satu sama lain untuk meningkatkan visibilitas.