Sebagian besar paket membutuhkan beberapa bentuk penjelasan untuk membantu pengguna memiliki pengalaman terbaik dan mengoptimalkan penggunaannya. Halaman ini memberikan beberapa tips untuk cara Struktur dan format dokumentasi.
Setelah judul paket, Anda harus memberikan gambaran dasar tentang apa paket dan/atau apa yang mengandung. Mengikuti gambaran, termasuk instruksi untuk menginstal, dan persyaratan sistem dan/atau batasan. Anda juga dapat menyediakan tautan untuk mendapatkan bantuan dan memberikan umpan balik, termasuk forum publik atau basis pengetahuan, dan kontak helpdesk.
Setelah informasi awal ini, Anda dapat menyediakan alur kerja yang lebih mendalam, deskripsi antarmuka pengguna atau daftar direktori untuk sampel, dan kemudian topik yang lebih canggih. Ini terbaik untuk menyediakan halaman referensi di dekat akhir.
| Section | Description |
|---|---|
| Overview | Memberikan penjelasan singkat, tingkat tinggi dari paket. |
| Package contents | Sertakan lokasi file penting yang ingin Anda ketahui. Misalnya, jika ini adalah paket sampel yang mengandung tekstur, model, dan bahan yang dipisahkan oleh kelompok sampel, Anda mungkin ingin menyediakan lokasi folder dari setiap kelompok. |
| Installation instructions | Anda dapat menunjuk ke pejabat, tetapi jika Anda memiliki persyaratan instalasi khusus, seperti menginstal sampel, menambahkannya di sini. |
| Requirements | Ini adalah tempat yang baik untuk menambahkan persyaratan perangkat keras atau perangkat lunak, termasuk versi Unity Editor paket ini kompatibel dengan. |
| Limitations | Jika paket Anda memiliki batasan yang diketahui, Anda dapat mencantumkannya di sini. Jika tidak, atau jika batasan sepele, masukkan bagian ini. |
| Workflows | Sertakan daftar langkah-langkah yang dapat dengan mudah diikuti yang menunjukkan cara menggunakan fitur. Anda dapat menyertakan screenshot untuk membantu menggambarkan cara menggunakan fitur. |
| Advanced topics | Ini adalah di mana Anda dapat memberikan informasi rinci tentang apa yang Anda berikan kepada pengguna. Ini sangat ideal jika Anda tidak ingin kewalahan pengguna dengan terlalu banyak informasi di depan. |
| Reference | Jika Anda memiliki antarmuka pengguna dengan banyak properti, Anda dapat menyediakan rincian di bagian referensi. Menggunakan tabel adalah cara yang baik untuk memberikan akses cepat ke deskripsi properti tertentu. |
| Samples | Untuk paket yang mencakup file sampel, Anda dapat menyertakan informasi rinci tentang bagaimana pengguna dapat menggunakan file sampel ini dalam proyek mereka dan scenesAdegan berisi lingkungan dan menu permainan Anda. Pikirkan setiap file Adegan unik sebagai tingkat yang unik. Di setiap Adegan, Anda menempatkan lingkungan, hambatan, dan dekorasi, pada dasarnya merancang dan membangun permainan Anda dalam potongan-potongan. More info Lihat di Glossary. |
| Tutorials | Jika Anda ingin memberikan trotoar untuk prosedur yang rumit, Anda juga dapat menambahkannya di sini. Gunakan petunjuk langkah demi langkah dan termasuk gambar jika mereka dapat membantu pengguna memahami. |
Markdown adalah format ringan yang biasa digunakan dalam paket. Banyak layanan hosting repositori (seperti GitHub dan Bitbucket) mendukungnya untuk README dan situs dokumentasi. Anda dapat menyediakan file MD di folder Documentation~ di bawah akar paket Anda sehingga jika pengguna paket Anda mengklik tautan View documentation dalam pane rincian Manajer Paket Unity, perekam MD default pengguna membuka file.
Atau, Anda dapat menggunakan situs web Anda sendiri untuk menghosting dokumentasi Anda. Untuk mengatur lokasi tautan View documentation untuk menunjuk ke situs web Anda sendiri, atur dengan properti Sitemap Sitemap dalam file package.json Anda.
Jika Anda memutuskan untuk menggunakan file Markdown untuk mendokumentasikan paket Anda, Anda dapat menemukan informasi lebih lanjut tentang cara menulis file MD dari sejumlah situs bantuan, seperti: