Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- Qubes OS
- Penulis teknis:
- luzeal
- Nama project:
- Onboard dengan QubesOS ! Mari kita tulis panduan yang terbuka dan mudah digunakan
- Durasi project:
- Durasi standar (3 bulan)
Project description
Mulai menggunakan QubesOS
Saya ingin membuat panduan terbuka dan materi terkait untuk pengguna QubesOS pemula. Tujuannya adalah memperkenalkan QubesOS kepada orang awam, dan menjaga agar panduan ini tetap ringkas dan mudah dipahami, menggunakan analogi, ilustrasi, dan diagram. Agar tetap ringkas, link ke sumber tepercaya dan andal akan digunakan, termasuk yang ada di situs QubesOS. Semuanya akan dirilis dengan lisensi terbuka.
Yang saya maksud dengan mandiri adalah konten yang dapat ada secara terpisah dari situs, misalnya sebagai buku panduan. Tidak sama dengan panduan versi offline. Idealnya, pipeline lain untuk memublikasikan konten sebagai panduan akan dibuat, bersama dengan situs.
Yang saya maksud dengan terbuka adalah panduan yang akan dirilis dengan lisensi terbuka.
Cara melakukannya
Tentukan target audiens
Hingga saat ini, saya merasa bahwa kategori pengguna yang ditargetkan QubesOS belum ditentukan dengan baik. Bagaimana QubesOS dapat membantu jurnalis, pengacara, analis keamanan, developer software, dan sebagainya? Akan sangat membantu jika Anda mendeskripsikan skenario saat QubeOS dapat terbukti berguna.
Tetapkan ekspektasi dengan benar
Penting juga untuk memperingatkan pengguna baru bahwa QubesOS memerlukan tingkat pengetahuan IT yang cukup tinggi. Ada harga yang harus dibayar untuk menggunakan QubesOS, dari segi kegunaan, terutama jika QubesOS adalah sistem komputasi utama Anda. Di sisi lain, ada hal-hal yang tidak dapat dilakukan QubeOS dengan baik (berdasarkan desain), seperti akselerasi 3D di virtual machine. Penting untuk memperjelasnya sejak awal, bukan untuk mencegah orang menggunakannya, tetapi untuk menetapkan ekspektasi bagi calon pengguna.
Apa itu QubesOS dan apa yang bukan QubesOS
Meskipun QubesOS adalah jenis sistem operasi khusus (distribusi Xen), akan menarik untuk membandingkannya dengan sistem operasi lain berdasarkan fungsi atau kekurangannya (misalnya, Windows semakin banyak menggunakan virtualisasi dan sandboxing sebagai mekanisme keamanan). Diagram/tabel sederhana dapat digunakan.
Spesifikasi panduan akan ditentukan bersama komunitas.
Apa informasi minimum yang harus ada dalam panduan? Seberapa jauh penginstalan dapat disederhanakan tanpa mengorbankan keamanan? Di mana seharusnya ambang batas berada? Apakah ada penyiapan QubesOS yang layak dan aman secara minimal? Jika tidak, elemen tersebut dapat ditentukan dan ditetapkan sebagai target panduan.
Lisensi
Mengambil surat izin mengemudi. Wiki Archlinux yang sangat dihormati menggunakan GNU Free Documentation License 1.3 atau yang lebih baru. Apakah lisensi ini cocok?
Upaya lainnya
Membuat dokumentasi situs lebih menarik secara visual
Catatan dapat ditandai menggunakan warna merah atau kuning agar lebih mudah diperhatikan. Misalnya, kotak warna dapat digunakan, seperti yang ada di wiki archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Kutipan panjang dapat digunakan.
Menautkan konten
Saat ini ada banyak konten untuk situs dokumentasi, tetapi setiap bagian sering kali tidak ditautkan ke topik relevan lainnya. Artikel dapat ditautkan satu sama lain untuk meningkatkan visibilitas.