Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Project FreeBSD
- {i>Technical writer <i}(Penulis teknis):
- kafein
- Nama project:
- Membuat bab buku panduan Wine
- Durasi project:
- Durasi standar (3 bulan)
Project description
Sebagai bagian dari inisiatif ini, saya akan membuat bab panjang panduan yang mendalam dalam FreeBSD Handbook yang terkait dengan penginstalan, penggunaan, dan pemecahan masalah WINE (www.winehq.org) di FreeBSD. Saya akan berusaha menghabiskan waktu 4-8 jam setiap minggu untuk mengerjakan item di bawah, kecuali jika dinyatakan lain.
*** Pengikatan Komunitas
Jika terpilih, saya akan menghabiskan periode Bonding Komunitas untuk memahami proses dokumentasi dan infrastruktur proyek FreeBSD. Saya selalu terkesan dengan dokumentasi yang kohesif yang telah dibuat oleh project ini, dan saya akan berinteraksi dengan anggota tim project terkait alur kerja mereka. Saya juga akan bergabung dan menjelajahi forum yang berorientasi pada pengguna untuk mendapatkan gambaran tentang apa yang akan membantu pengguna FreeBSD terkait dokumentasi secara umum, dan membantu menggunakan WINE di FreeBSD secara khusus.
Saya akan meluangkan waktu selama periode ini untuk mempelajari toolchain dokumentasi project. Hal ini akan memungkinkan saya untuk langsung memulai selama minggu-minggu awal project jika saya terpilih.
*** Minggu 1 (14-19/9): Menguji Penginstalan & Memecahkan Masalah
Saya akan menghabiskan minggu pertama fase Pengembangan Dokumen untuk melakukan penginstalan dry run WINE pada versi stabil FreeBSD saat ini, serta menginstal dan menjalankan berbagai aplikasi Windows mulai dari utilitas sederhana hingga aplikasi yang lebih kompleks. Ini adalah pendekatan yang saya lakukan dalam artikel serupa yang saya buat di ReactOS untuk MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), hanya saja saya akan menggunakan waktu minggu pertama untuk memeriksa lebih banyak pilihan program.
Menurut pengalaman saya, menghabiskan waktu seperti ini di awal berguna untuk mengidentifikasi (dan memecahkan masalah) jenis masalah ""gotcha"" umum. Dengan demikian, saya akan dapat memiliki solusi saat tiba waktunya untuk menulis bagian yang relevan, atau setidaknya memiliki permintaan bantuan ke saluran yang sesuai.
Sasaran Minggu Ini: Memiliki ringkasan bab penginstalan dan detail yang diperlukan terkait cara memperbaiki masalah penginstalan umum.
*** Minggu ke-2 (21-25/9): Mendokumentasikan Penginstalan WINE
Selama Minggu 2, saya akan membuat draf bagian yang menggambarkan penginstalan WINE melalui metode populer, termasuk:
- Dari sumber menggunakan sistem port;
- Melalui paket biner menggunakan repositori inti;
- Menggunakan pengelola paket GUI yang tersedia jika tersedia, dan;
- Dari repositori alternatif seperti FreshPorts (dan alasan pengguna ingin melakukannya).
Penting untuk bagian ini adalah diskusi tentang instalasi 32- vs 64-bit dan simultan, untuk menyoroti langkah-langkah tambahan menjalankan program dari arsitektur yang berbeda membutuhkan arsitektur.
Sasaran Minggu Ini: Versi draf yang rapi dari bagian yang menjelaskan penginstalan WINE di FreeBSD. ""Draf yang telah dioptimalkan"" ini harus berisi teks yang hampir final (menunggu pemeriksaan tata bahasa dan masukan ulasan), serta placeholder untuk screenshot, jika bukan screenshot itu sendiri.
*** Minggu 3 (28/9-2/10): Menjalankan Program WINE Pertama Anda di FreeBSD
Setelah subsistem WINE terinstal, bagian berikutnya akan menjelaskan penginstalan dan eksekusi beberapa program awal. Aplikasi ini kemungkinan besar akan berfokus pada utilitas mandiri yang sederhana, seperti Notepad++ open source. Tujuannya adalah untuk memungkinkan pengguna mendownload aplikasi dengan cepat, menginstalnya, dan melihatnya berfungsi dengan sedikit kerumitan.
Bagian ini penting untuk menunjukkan kepada pengguna bahwa beberapa/banyak aplikasi Windows sebenarnya dapat berjalan di FreeBSD, sehingga menjadikannya pilihan yang layak untuk komputasi sehari-hari.
Sasaran Minggu Ini: Identifikasi sejumlah kecil program yang diinstal dengan rapi dan (sebagian besar) berfungsi secara otomatis, serta versi draf yang rapi dari bagian yang mengilustrasikan penginstalannya.
*** Minggu 4 (10/5-9): Ikhtisar &Konsep WinE
Bagian akhir dari bagian sebelumnya akan menyinggung perlunya melakukan beberapa penyesuaian dan penyesuaian agar aplikasi tertentu berfungsi di WINE. Pada saat itu, pengantar subsistem WINE akan berguna untuk memberikan konteks. Bagian ini akan memeriksa apa yang disertakan dengan sistem WINE, cara sistem tersebut berinteraksi dengan FreeBSD, dan tempat pengguna dapat mulai mencari untuk lebih memahami sistem atau memecahkan masalah.
Perlu diperhatikan bahwa bagian ini tidak bertujuan untuk menduplikasi resource yang ada, melainkan menampilkan ringkasan terstruktur yang tertaut ke sumber lain (yang mudah dicerna) untuk mendapatkan informasi lebih lanjut.
Sasaran Minggu Ini: Draf yang telah dioptimalkan dari bagian yang memperkenalkan subsistem WINE kepada pengguna.
*** Minggu 5 (10/12-16): Konfigurasi WINE di FreeBSD
Bagian ini akan membahas lebih jauh tentang konfigurasi WinE yang sebenarnya, dimulai dengan keseluruhan modifikasi/penyesuaian khusus untuk FreeBSD. Mereka juga akan menggambarkan penggunaan folder $WINEPREFIX, yang dapat digunakan untuk menyesuaikan lingkungan WINE untuk aplikasi tertentu. Karena sudah ada referensi yang menjelaskan konsep ini secara mendalam, bagian ini hanya akan memberikan pengantar yang cukup mendetail sebelum menautkan ke referensi tersebut.
Sasaran Minggu: Draf bagian yang bagus yang menjelaskan di mana, bagaimana, dan dalam keadaan apa konfigurasi WINE mendalam diperlukan.
*** Minggu 6 (19-23/10): GUI WINE di FreeBSD
Karena menyiapkan WINE untuk menjalankan program tertentu dapat menjadi latihan yang kompleks dan memakan waktu, ada alat bantuan untuk mempermudah proses ini. Bagian ini akan memberikan ringkasan tentang penginstalan dan penggunaan beberapa opsi yang ada di FreeBSD, termasuk:
- WINECfg
- winetricks
- playonbsd
- lainnya sesuai ketersediaan
Sasaran Minggu Ini: Untuk memberikan bagian draf yang rapi dengan petunjuk tentang cara menginstal dan menggunakan aplikasi helper GUI WINE yang paling populer sebanyak mungkin.
*** Minggu 7 (26-30/10): FAQ WINE/FreeBSD (Riset)
Beberapa informasi yang paling berharga mengenai aplikasi teknis yang rumit seperti WINE dapat ditemukan dalam interaksi antara pengguna yang mencoba memecahkan masalah tertentu dan pakar memberikan jawaban. Pengguna akan banyak menghemat waktu jika beberapa FAQ ini, terutama yang diketahui memengaruhi pengguna FreeBSD, dikumpulkan di satu tempat.
Bagian ini akan membahas hal tersebut, dan minggu ini saya akan memeriksa jenis masalah yang umumnya dialami pengguna FreeBSD terkait WINE, serta untuk mempelajari dan (sejauh mungkin) menguji jawabannya. Hal ini akan memberi pembaca bab Handbook ini peluang yang jauh lebih baik untuk menyelesaikan masalah tertentu dengan cepat.
Bagian ini juga akan menyertakan daftar referensi tentang tempat mencari jawaban yang tidak diberikan.
Sasaran Minggu Ini: Bagian draf yang telah dioptimalkan yang berisi masalah WINE yang paling umum, baik yang dialami oleh pengguna FreeBSD maupun secara umum, dan link/catatan terkait solusinya. Perlu diketahui bahwa meskipun tugas minggu ini tidak memiliki draf output, tugas ini kemungkinan akan memerlukan investasi waktu yang lebih lama untuk menemukan dan merekonsiliasi masalah umum serta melacak solusinya. Saya memperkirakan akan menghabiskan sekitar 8-10 jam untuk riset ini.
*** Minggu ke-8 (2-6/11): FAQ WINE/FreeBSD
Minggu ini akan dihabiskan untuk menyintesis riset Minggu 7 guna membuat bagian tentang FAQ/masalah pemecahan masalah umum (dengan menautkan ke solusi yang sesuai).
Sasaran Minggu Ini: Draf yang telah dioptimalkan dari bagian yang mencantumkan pertanyaan umum/masalah yang sering dialami, dan petunjuk langkah demi langkah untuk mengatasinya.
*** Minggu ke-9 (9-13/11): Administrasi WINE multi-pengguna
Bagian ini akan menawarkan panduan bagi administrator yang ingin men-deploy WINE dalam skenario multi-pengguna. Hal ini tidak hanya mencakup praktik terbaik untuk berbagi sub-sistem itu sendiri di antara beberapa pengguna, tetapi juga terkait dengan aplikasi Windows yang di-deploy dalam WINE.
Sasaran Minggu Ini: Bagian draf yang rapi yang menjelaskan panduan dan praktik terbaik bagi administrator FreeBSD untuk men-deploy WINE dan aplikasi berbasis WINE kepada beberapa pengguna.
*** Minggu 10 (16/11-20): Lampiran, Ulasan Masukan &Administrivia
Meskipun saya akan berusaha menerapkan masukan apa pun yang diterima dari mentor dan peninjau lainnya selama proses penyusunan draf, minggu ini akan memberi saya waktu untuk mengatur ulang/menulis ulang secara lebih menyeluruh jika diperlukan.
Selain itu, saya akan menulis semua hal administratif yang diperlukan untuk bab Handbook ini (materi awal, indeks, dll.) selama waktu ini, serta menyusun bacaan lebih lanjut terkait WINE (misalnya, menggunakan WINE versi Linux melalui kompatibilitas biner, DOSBox untuk game/program lama, dll.).
Sasaran Mingguan: Draf yang telah dioptimalkan dari seluruh bab Handbook, termasuk semua bagian lainnya.
*** Minggu ke-11 (23-27/11): Penyelesaian Bab Panduan
Saya berencana untuk mendedikasikan minggu kedua hingga terakhir ini untuk memeriksa tata bahasa semua teks, memeriksa gambar, dan menguji berbagai output (HTML, PDF, dll.) sesuai kebutuhan. Minggu ini juga akan memungkinkan update jika salah satu software di atas (dari FreeBSD itu sendiri hingga WINE atau helper-nya) diupgrade sejak penulisan awal.
Sasaran Mingguan: Versi akhir bab Handbook, termasuk semua pembaruan yang diperlukan.
*** Minggu 12 (30/11-5/12): Penyelesaian Project
Setelah berdiskusi dengan mentor project, saya akan memeriksa bab Handbook ke dalam kontrol sumber, menyusun laporan project, dan mengirimkan project sebagai selesai.