Project ScummVM

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

Ringkasan proyek

Organisasi open source:
ScummVM
Penulis teknis:
Cadi
Nama proyek:
Meluncurkan Portal Dokumentasi
Durasi proyek:
Durasi standar (3 bulan)

Project description

Tujuan:

  • Untuk menghasilkan dokumentasi pengguna akhir yang berkualitas tinggi dan berversi dengan menggabungkan sejumlah besar informasi dari sumber yang berbeda dan menulis ulang informasi untuk kejelasan, konsistensi, dan kelengkapan.
  • Dokumentasi harus mudah dipahami oleh pemula, tanpa menggurui pengguna yang mengerti teknologi.
  • Untuk membuat portal dokumentasi menggunakan generator situs statis.
  • Agar dokumentasi pengguna akhir siap menghadapi masa depan dengan membuat template dan petunjuk petunjuk terperinci untuk kontributor open source di masa mendatang.

Situasi saat ini:

  • Dokumentasi ScummVM yang tersedia tersebar di berbagai sumber.
  • Informasi sulit ditemukan dan sering diduplikasi; sangat mudah hilang di halaman yang tidak jelas.
  • Terkadang sulit untuk mengetahui informasi apa yang terkini, dan apa yang sudah tidak berlaku.
  • Beberapa informasi tidak ada atau tidak lengkap.

Memperbaiki masalah:

Struktur dokumentasi yang disarankan:

Halaman Landing |-- Memulai | -- Quick start guide |-- Installing ScummVM | |-- Nintendo 3DS | |-- AmigaOS | |-- Android | |-- (every) | |-- (common) | |-- (supported) |-- (platform) |-- Menggunakan ScummVM | |-- Peluncur | |-- Setelan global | |-- Setelan game | -- Keyboard shortcuts |-- Advanced options | |-- Cloud and LAN | |-- Control Mapping | |-- Configuration | |-- Command line options | |-- Graphics |-- Musik dan suara |-- Bantuan | |-- FAQ | |-- Kontak | |-- Masalah yang diketahui | -- Reporting a bug |-- Game Notes-- Catatan Rilis

  • Memulai:

Pengguna baru sering kali mencari panduan memulai cepat untuk memulai secepat mungkin. Meskipun penginstalan ScummVM bisa menjadi rumit pada beberapa platform, menginstalnya ke komputer tidak.

Panduan memulai harus mencakup hal berikut:

  • Cara menginstal ScummVM ke Windows, Mac, dan Linux.

  • Cara memuat, menambahkan, dan meluncurkan game.

  • Menginstal ScummVM:

Jika penginstalan tidak intuitif, atau pengguna mungkin tidak memiliki basis teknis yang kuat, pengguna memerlukan panduan komprehensif untuk menginstal ScummVM pada platform yang didukung.

Setiap halaman penginstalan komprehensif harus mencakup hal berikut:

  • Semua persyaratan sistem/prasyarat.
  • Cara mendownload versi ScummVM yang sesuai.
  • Cara menginstal ScummVM.
  • Cara memuat game ke platform yang dipilih, terutama jika game tersebut bukan platform yang dirancang untuk game tersebut.

  • Cara meluncurkan ScummVM, menambahkan game, dan meluncurkan game.

  • Menggunakan ScummVM:

Pengguna memerlukan dokumen referensi yang menjelaskan cara menggunakan ScummVM.

Dokumen referensi harus mencakup hal-hal berikut:

  • Antarmuka Peluncur; tampilan setiap jendela dan tab serta cara kerjanya.
  • Penjelasan tentang setelan yang tersedia, baik yang global maupun khusus game.

  • Pintasan keyboard/hotkey.

  • Opsi lanjutan:

Pengguna lanjutan memerlukan informasi tambahan yang lebih teknis tentang opsi yang tersedia bagi mereka untuk menyesuaikan cara game berjalan.

  • Catatan game:

Informasi khusus game apa pun yang perlu diketahui pengguna; termasuk, tetapi tidak terbatas pada: - Keistimewaan penginstalan - File tambahan apa pun yang diperlukan - Kontrol yang tidak biasa atau berbeda

  • Masalah umum:

Bagian ini harus berisi bug umum yang terkait dengan rilis tersebut.

  • Catatan rilis:

Sementara dokumentasi kami akan dibuat versinya, memiliki bagian Catatan Rilis dapat membantu untuk memberikan ringkasan perubahan dalam rilis terbaru. Hal ini dapat mencakup beberapa area yang saat ini berada di luar cakupan dokumentasi ini, seperti game yang baru didukung atau informasi tentang mesin baru.

Rencana serangan:

Saya mengusulkan untuk memulai dengan membuat template untuk halaman Menginstal ScummVM, karena ini akan menjadi cara termudah bagi saya untuk mendapatkan informasi yang saya perlukan dari pengelola/developer port (terutama jika informasi ini hanya sedikit atau tidak ada). Saya akan mengisi informasi apa pun yang saya miliki dari dokumentasi yang ada, yang kemudian dapat diperiksa kelengkapannya, akurasi, dan mata uangnya, atau ditambahkan jika diperlukan.

Selanjutnya saya akan menyisir dokumentasi yang ada; README, wiki dan {i>website<i}. Sambil melanjutkan, saya akan menulis ulang dan menambahkan ke setiap bagian sesuai kebutuhan dan menarik semua informasi ke portal baru. Saya juga akan mencatat informasi apa yang diambil dari mana, untuk memastikan bahwa setelah portal aktif, tidak ada duplikat, kontradiksi, atau anomali lainnya.

Untuk itu, saya akan bekerja sama dengan mentor, developer, pengelola port, dan pakar bidang studi lainnya untuk mencari informasi yang belum lengkap, serta memastikan setiap halaman selalu diperbarui dan komprehensif.

Dengan semangat kolaborasi dan tunduk kepada persetujuan dari mentor, saya ingin portal karya yang sedang dikerjakan dapat diakses oleh komunitas ScummVM selama proses penulisan, untuk menerima masukan secara real-time dan memastikan tidak ada yang terlewatkan selama proses penulisan.

Sebaiknya gunakan panduan gaya, seperti panduan gaya dokumentasi developer Google, untuk memastikan konsistensi bagi kumpulan karya ini dan untuk semua dokumentasi ke depannya.

Jika memungkinkan, saya akan menggunakan screenshot, gif, dan alat bantu visual lainnya untuk meningkatkan pemahaman.

{i>Timeline<i} yang diajukan:

Ikatan komunitas 17 Agustus - 13 September 2020

Terus luangkan waktu untuk berbicara dengan mentor dan komunitas ScummVM yang lebih luas untuk menyempurnakan visi proyek dan menyelesaikan detail seperti struktur dan konten dokumen.

Minggu 1 14 September - 20 September

  • Buat template untuk halaman penginstalan khusus platform.
  • Isi template dengan informasi yang ada dan distribusikan kepada pengelola/developer port yang sesuai untuk mengetahui informasi lebih lanjut.

Minggu 2 21 September - 27 September

  • Siapkan portal dokumentasi baru.

Minggu 3 28 September - 4 Oktober

Menggunakan ScummVM: - Antarmuka - Setelan global Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai ditampilkan kepada saya.

Minggu ke-4 5 Oktober - 11 Oktober

Menggunakan ScummVM: - Setelan game - Pintasan keyboard Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai ditampilkan kepada saya

Minggu ke-5 12 Oktober - 18 Oktober

Opsi lanjutan: - Cloud dan LAN - Pemetaan Kontrol Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai dikembalikan kepada saya

Minggu ke-6 19 Oktober - 25 Oktober

Opsi lanjutan: - Konfigurasi - Opsi command line Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai akan dikembalikan ke saya

Minggu ke-7 26 Oktober - 1 November

Opsi lanjutan: - Grafis - Audio Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai ditampilkan kepada saya

Minggu 8 2 November - 8 November

Bantuan: - FAQ - Kontak - Masalah umum

Menginstal ScummVM: - Panduan penginstalan khusus platform saat template yang sudah selesai dikembalikan ke saya

Minggu 9 9 November - 15 November

Bantuan: - Melaporkan bug - Catatan game - Catatan rilis

Menginstal ScummVM: - Selesaikan panduan platform yang belum selesai.

Minggu 10 16 November - 22 November

  • Pengeditan akhir, pemeriksaan tata bahasa, dan penyelesaian semua keputusan terkait portal seperti navigasi sidebar, penyesuaian tema/CSS, dll.
  • Pastikan semua link berfungsi seperti yang diharapkan.
  • Pastikan gambar/gif ditampilkan dengan benar.

Minggu 11 23 November - 30 November

  • Selesaikan item yang belum selesai dan luncurkan portal secara resmi!
  • Setelah portal diluncurkan, hapus informasi yang tidak perlu dari sumber lain setelah berkonsultasi dengan mentor.