Membuat Dokumentasi Proyek Anda di Github

Membuat Dokumentasi Proyek Anda di Github - Dokumentasi yang dapat diakses memungkinkan orang untuk belajar tentang suatu proyek, membuatnya mudah untuk diperbaharui memastikan bahwa dokumentasi tetap relevan.

Dua cara umum untuk mendokumentasikan suatu proyek adalah file README dan wiki

1. File README adalah cara cepat dan sederhana bagi pengguna lain untuk mempelajari lebih lanjut tentang pekerjaan anda.
2. Wiki di Github membantu anda menyajikan informasi mendalam tentang proyek anda dengan cara yang bermanfaat.

Ide yang baik adalah setidaknya memiliki README di proyek anda, karena itu adalah hal pertama yang akan dibaca banyak orang ketika mereka pertama kali menemukan proyek anda.

Membuat README 

Ketika anda membuat repositori baru melalui GitHub, pilih "Inisialisasi repositori ini dengan README" kecuali anda berencana untuk mengimpor repository yang ada.

File README.md anda sekarang tersedia untuk di edit di repositori baru anda. Nama proyek anda ada di atas, diikuti oleh deskripsi apa pun yang anda pilih untuk dimasukkan saat membuar repositori. README mudah di modifikasi, baik di Github atau secara lokal. Lihatlah panduan menguasai Markdown untuk mempelajari lebih lanjut tentang cara memodifikasi teks di dalam file setelah anda membuatnya.

Format README

README umumnya mengikuti satu format untuk segera mengarahkan pengembang ke aspek terpenting dari proyek anda.

• Nama Proyek: Nama proyek anda adalah hal pertama yang akab dilihat orang saat menggulir ke README anda, dan disertakan saat membuat file README anda.
• Deskripsi: Berikut Deskripsi proyek anda. Deskripsi yang bagus Jelas, Singkat, dan to the point. Jelaskang pentingnya proyek anda dan apa fungsinya.
• Daftar Isi: Secara opsional, sertakan daftar isi agar orang lain dapat dengan cepat menavigasi README yang panjang atau terinci.
• Instalasi: Instalasi adalah bagian selanjutnya dalam README yang efektif. Beri tahu pengguna lain cara memasang proyek anda secara lokal. Secara opsional, sertakan gif untuk membuat proeses lebih jelas bagi orang lain.
• Penggunaan: Bagian selanjutknya adalah penggunaan, dimana anda mengajar orang lain tentang cara menggunakan proyek anda setelah mereka menginstalnya. Ini juga akan menjadi tempat yang baik untuk menyertakan screenshot proyek anda.
• Credits: Sertakan  bagian kredit untuk menyoroti dan menautkan ke penulis proyek anda.
• Lisensi: Terakhir, Sertakan bagian untuk lisensi proyek anda seperti lisensi MIT dll. Untuk informasi lebih lenjut tentang memilih lisensi, lihat panduan lisensi Github

README anda hanya berisi informasi yang diperlukan bagi developer untuk mulai menggunakan dan berkontribusi pada proyek anda. Dokumentasi yang lebih panjang paling cocok untuk wiki, seperti penjelasan dibawah ini.

Membuat wiki

Setiap repositori di Github hadir dengan wiki. Setelah membuat repositori, anda dapat mengatur wiki yang disertakan melalui bar navigasi. Memulai wiki anda mengklik tombol wiki dan membuat halaman pertama anda.

Menambahkan Konten

Konten wiki dirancang agar mudah diedit. Anda dapa menambahkan atau mengubah konten pada halaman wiki apapun dengan mengklik tombol edit yang terletak di sudut kanan atas setiap halaman. membuka editor di wiki.

Halaman wiki dapat ditulis dalam format apapun yang didukung oleh Github Markup. Menggunakan menu drop-down di editor, anda dapar memilih format wiki anda, dan kemudian menggunakan toolbar untuk membuat dan memasukkan konten pada halaman. Wiki juga memberi anda opsi untuk menyertakan catatan kaki khusus di mana anda dapat mendaftar hal-hal seperti detail kotak atau informasi lisensi untuk proyek anda.

Github melacak perubahan yang dibuat untuk setiap halaman di wiki anda. Di bawah judul halaman, anda dapat melihat siapa yang melakukan pengditan terbaru, selain jumlah komit yang dibuat untuk halaman tersebut. Mengklik informasi ini akan membawa anda ke riwayat halaman penih di mana anda dapat membandingkan revisi atau melihat daftar suntingan terperinci dari waktu ke waktu.

Menambahkan Halaman

Anda dapat menambahkan halaman tambahan ke wiki anda dengan memilih Halaman Baru di sudut kanan atas. Secara default, setiap halaman yang anda buat disertakan secara otomatis di sidebar wiki anda dan terdaftar dalam urutan abjad.

Dukungan

Anda juga dapat menambahkan bilah samping khusus ke wiki anda dengan mengklik tautan Tambahkan bilah khusus samping, konten khusus sidebar dapat menyertakan teks, gambar, dan tautan.

Catatan: Halaman yang disebut "Rumah" berfungsi sebagai halaman masuk ke wiki anda. Jika tidak ada, daftar isi yang dihasilkan secara otomatis akan ditampilkan sebagai gantinya.

Penyorotan Syntax

Halaman Wiki mendukung penyorotan sintaks kode otomatis untuk berbagai bahasa dengan menggunakan sintaks berikut: 

```ruby
   deff foo
     puts `bar`
   end
```

Blok harus dimulai dengan tiga backtick, opisional diikuti dengan nama bahasa yang terkandung oleh blok. Lihat pygments untuk daftar bahasa yang dapat disorot sintaks.

Konten blok harus diindentasi pada tingkat yang sama dengan backticks pembuka. Blok harus diakhiri dengan tiga backtick yang indentasi pada level yang sama dengan backticks pembuka.

Done

Anda telah mempelajari beberapa informasi penting tentang cara terbaik membagikan proyek anda dengan komunitas Github lainnya,, Selamat mencoba.

Terima Kasih sudah membaca Membuat Dokumentasi Proyek Anda di Github. Semoga Bermanfaat!

Tag:

Git , Pemrograman , Software