- Alasan keberadaan file README
- README adalah konten penting yang menentukan kesan pertama dari sebuah proyek kode
- Wajah proyek sekaligus panduan pengguna
- Membantu memahami alasan keberadaan kode, masalah yang diselesaikan kode, dan pentingnya kode tersebut
- Menjelaskan tujuan proyek, cara instalasi, dan cara penggunaan
- Memberikan informasi penting kepada semua orang yang berpartisipasi dalam proyek dan meningkatkan nilai kode
- README yang sangat baik juga dapat sangat memengaruhi keberhasilan proyek
- Kode ada untuk menyelesaikan masalah, dan README harus menyampaikan dengan jelas pentingnya masalah tersebut serta cara penyelesaiannya
- Proyek tanpa README
- Seperti labirin tanpa papan petunjuk
- Minat terhadap proyek dapat menurun, dan proyek yang berguna mungkin tidak dikenal luas
- Pengembang akan kesulitan memelihara dan meningkatkan proyek
- Membutuhkan banyak waktu untuk memahami struktur kode yang ada atau cara penggunaannya
- Syarat penulisan README
- Harus selalu memuat informasi terbaru
- Jika ada perubahan pada proyek, README juga harus diperbarui bersama-sama
- README harus ringkas, tetapi tetap menyediakan semua informasi yang diperlukan
- Jika isi menjadi panjang, buat jalur baru sesuai tujuan untuk menyimpan file dan tambahkan hyperlink
- Isi yang perlu dimuat dalam README
- Fitur utama dan tujuan proyek
- Cara instalasi: panduan instalasi langkah demi langkah, alat dan pustaka yang diperlukan untuk instalasi, panduan pengaturan lingkungan
- Cara mengatasi masalah: masalah yang sering terjadi dan cara mengatasinya
- Kanal dukungan: cara berkomunikasi dengan pemelihara utama proyek atau penanggung jawab komunikasi
- Informasi lisensi: lisensi menjelaskan hak dan batasan terkait penggunaan, modifikasi, dan distribusi kode
- Log perubahan: riwayat pembaruan utama proyek
- Contoh penggunaan
- Materi pembelajaran tambahan dan tautan dokumentasi
- Prasyarat: bertujuan membantu pengguna menyiapkan lingkungan untuk menginstal dan menjalankan proyek dengan mudah
Belum ada komentar.