Apa jenis dokumen untuk desain game? [Tutup]

Jenis dukungan / format apa yang Anda gunakan untuk menyimpan dan meredakan dokumentasi desain game Anda? Wiki? File dokumen? File dalam Repositori? Folder bersama? Google Doc?

Harap berikan pro dan kontra untuk masing-masing.

Saya menggunakan Google Documents karena yang benar-benar saya butuhkan adalah editor teks yang sedang online. Saya dapat berkolaborasi dengan orang-orang online dengan relatif mudah dan saya tahu informasi saya aman di sana jika komputer saya crash.

Opsi lain yang layak dilihat adalah menggunakan Dropbox . Letakkan dokumen Word di sana dan Anda langsung memiliki lingkungan kolaboratif dengan kontrol versi.

Wiki

Pro:

• Versi terbaru selalu dapat diakses melalui web, dari luar situs, dll.
• Cukup mudah digunakan (jika Anda menghindari mereka yang memiliki trainwreck untuk memformat seperti MediaWiki, itu adalah)
• Pengindeksan otomatis, pencarian, kategorisasi mudah
• Mudah mengaitkan perubahan dengan orang dan membuatnya bertanggung jawab atas perubahan
• Mendukung tautan dan membuatnya mudah dan efektif untuk memfaktorkan perincian
• Dapat menautkan ke halaman wiki langsung dari laporan bug internal dan korespondensi lainnya, membuat verifikasi bug sangat mudah
• Riwayat versi dan kontrol revisi biasanya ada di dalamnya

Cons:

• Terkadang TERLALU mudah untuk diubah (* lihat di bawah) dan membutuhkan disiplin
• Halaman dapat keluar dari sinkronisasi ketika diedit secara terpisah (sering kali tidak ada 'pencarian global dan ganti', misalnya)
• Halaman-halaman menjadi yatim piatu atau digantikan dan dibiarkan sebagai ladang ranjau potensial untuk coders nanti. ( "Apa maksudmu kita tidak menerapkan itu lagi? Ini masih dalam wiki desain!" )
• Sintaks bisa menjadi sedikit esoterik kecuali Anda mendapatkan paket yang tepat
• Harus mengatur hosting, atau menerima apa yang tersedia online secara gratis
• Tidak ada rute yang jelas melalui dokumen - bagaimana Anda membacanya 'semua'?
• Sulit dicetak. Bisakah Anda mencetak semuanya dengan satu klik? Bisakah Anda dengan mudah mencetak segala sesuatu yang relevan dengan satu fitur yang diberikan untuk membawanya ke rapat? Bisakah Anda membuat anotasi versi digital dengan mudah tanpa mengaburkan dokumen yang mendasarinya?

(* Kami menggunakan wiki untuk satu proyek dan desainer selalu tergoda untuk masuk dan 'meningkatkan' bagian dari itu, bahkan pada fitur yang telah ditandatangani dan dikirim untuk dikodekan. Kemudian ketika QA harus menguji fitur, itu akan menjadi mimpi buruk karena seringkali desain akan menyarankan sesuatu yang berbeda dengan apa yang sebenarnya dikodekan, dan itu akan memerlukan sedikit usaha yang membuat frustasi untuk mengetahui mana yang terjadi pertama kali, perubahan pada desain atau kode.)

File Teks

Pada proyek saya saat ini, saya menggunakan file teks biasa di folder "Documents" proyek saya, disimpan dalam repositori di sebelah kode.

Pro:

• Dokumentasi disimpan dekat dengan pekerjaan yang sebenarnya, sehingga mudah ditemukan.
• Pemformatan sederhana berarti mudah dan cepat untuk menjaga dokumentasi.
• Format sederhana juga berarti ada sedikit risiko kehilangan dokumentasi karena server crash, korupsi file, dll.
• Waktu pengaturan yang benar-benar minimal menjadikan ini awal yang baik untuk tim pengembang tunggal atau kecil (2-3 orang).
• Menggunakan kontrol versi berarti bahwa perubahan dilacak, dan sering kali seseorang dapat menautkan perubahan dalam dokumentasi secara langsung dengan perubahan dalam kode.
• Semudah bekerja dengan teks, pencarian, pengeditan, dan sebagainya seringkali dapat dilakukan dengan alat baris perintah.

Cons:

• Lebih dari beberapa pengguna dan dokumen akan keluar dari sinkronisasi dengan mudah.
• Tidak ada tautan, jadi Anda menggunakan satu dokumen yang sangat besar atau beberapa dokumen yang lebih kecil namun terputus.
• Opsi pemformatan dan publikasi terbatas (meskipun konversi, seperti melalui Penurunan harga, mudah dilakukan.)
• Semudah bekerja dengan teks, seringkali satu-satunya cara untuk mencari, mengedit lanjutan, dan sebagainya adalah dengan menggunakan alat-alat baris perintah.

Ini bukan sesuatu yang ingin Anda andalkan untuk segala jenis kerja tim, tetapi kekuatan file teks dalam repo untuk memberi Anda hak untuk bekerja tidak boleh diremehkan untuk pengembang tunggal. Saat ini saya menggunakan satu dokumen sebagai semacam ikhtisar / master-planner yang berisi desain umum, dokumen kedua yang bertindak sebagai ToDo-daftar hal-hal spesifik yang dibutuhkan game, dokumen ketiga sebagai pelacak bug yang longgar, dan dokumen tambahan untuk uraikan "fitur x" sesuai kebutuhan.

Jangan gunakan format dokumen / editor yang tidak mampu multi-pengguna (mis. MS Word, Open Office Writer). Hanya satu orang yang dapat mengedit dokumen, dan bahkan dengan kontrol sumber, terlalu mudah untuk mulai bekerja pada versi yang sudah kadaluwarsa, dan dengan menyimpan bahwa pada dasarnya Anda menghancurkan semua yang telah dilakukan pengguna lain sejak terakhir kali pengguna memperbarui versinya. dokumen.

Folder bersama sejauh ini merupakan solusi terburuk dan mutlak tidak ada untuk semua jenis aset yang seharusnya dikerjakan secara kolaboratif. Anda tidak pernah dapat memastikan bahwa orang lain sedang mengerjakan file itu sekarang, atau akan melakukannya dalam beberapa menit ke depan. Anda juga tidak memiliki pelacakan perubahan dan tidak dapat kembali ke versi sebelumnya jika terjadi bencana (kesalahan manusia atau kebodohan manusia atau kelalaian manusia).

Lebih disukai menggunakan Wiki, tetapi yang ramah pengguna dan benar-benar WYSIWYG. Saya pribadi bersumpah demi Confluence , yang juga digunakan di studio pengembang game yang lebih besar dan hanya $ 10 untuk hingga 10 pengguna dan pemirsa tidak terbatas.

Sebagian besar wiki lainnya (MediaWiki, TikiWiki, dll.) Memiliki sisi negatif karena mereka memiliki kurva belajar yang curam atau bahkan praktis tidak dapat digunakan oleh personel non-teknis. Bukannya mereka tidak bisa mempelajarinya tetapi mereka (memang seharusnya) tidak menerima menggunakan sistem dokumen yang pada dasarnya mengharuskan Anda untuk menulis kode seperti HTML. Ini adalah kesalahan saya: Wiki yang mengatakan mereka WYSIWYG tetapi yang mereka lakukan hanyalah memasukkan sintaks ke dalam teks yang Anda tulis. Itu bukan WYSIWYG!

Pedoman untuk menggunakan wiki adalah menempatkan setiap heading pada halaman terpisah, sehingga Anda dapat memotong dokumen menjadi banyak bagian yang dapat dikelola. Confluence menawarkan fitur-fitur yang dengannya Anda dapat menggabungkan semua subhalaman tersebut kembali menjadi satu situs atau dokumen, yang dapat diekspor ke PDF misalnya.

Saya pikir One Note adalah opsi yang baik. Itu adalah sesuatu seperti Wiki tetapi dengan banyak dukungan pengeditan teks yang kaya. Selain klien desktop standar yang disertakan dengan Office, ada versi berbasis web dengan Office Live suite. Jujur, saya pikir versi berbasis web, yang gratis, harus cukup untuk sebagian besar kebutuhan dan ketika dikombinasikan dengan Skydrive Anda memiliki sistem yang cukup bagus untuk berkolaborasi pada dokumen langsung.

Untuk salah satu proyek open-source saya, kami telah menggunakan (terkesiap) SharePoint untuk menyimpan dokumen dan media. Mengelola pengguna dan izin sangat mudah, dan memiliki dukungan untuk riwayat versi lengkap. Kami telah memiliki situs SharePoint selama sekitar empat tahun sekarang, jadi mungkin ada pilihan yang lebih baik saat ini. Namun, telah bekerja cukup baik untuk kita. Di-host oleh pihak ketiga (sekitar $ 20 / bulan), jadi setelah pengaturan awal hampir tidak ada pemeliharaan di pihak kami. Selain mendukung pustaka dokumen dan gambar, SharePoint memiliki dukungan Wiki, meskipun saya tidak yakin seberapa baik itu melawan mesin Wiki yang lebih populer.