Buat dokumentasi proyek menggunakan GitHub Copilot
Dokumentasi proyek menjelaskan tujuan, tujuan, dan persyaratan proyek. Untuk membuat dokumentasi proyek, Anda perlu memahami struktur proyek, komponennya, dan bagaimana komponen berinteraksi satu sama lain.
Tampilan Obrolan GitHub Copilot adalah alat yang ideal untuk menghasilkan dokumentasi proyek, karena dapat menganalisis seluruh struktur proyek dan memberikan gambaran umum tingkat tinggi tentang proyek. Tampilan Obrolan juga dapat digunakan untuk menghasilkan jenis dokumentasi tertentu, seperti file README, referensi API, dan dokumen terkait proyek lainnya.
Anda dapat menggunakan setiap mode tampilan Obrolan (Tanya, Agen, atau Rencana) untuk menghasilkan dokumentasi proyek. Setiap mode memiliki kekuatan dan kelemahannya sendiri. Spesifikasi proyek dan batasan lainnya memengaruhi mode mana yang harus digunakan.
Penting
Saat Anda menggunakan antarmuka Chat dalam mode agen, setiap prompt yang Anda masukkan dihitung sebagai satu permintaan premium, dikalikan dengan faktor pengganda model. GitHub Copilot mungkin mengambil beberapa tindakan tindak lanjut untuk menyelesaikan tugas Anda, tetapi tindakan tindak lanjut ini tidak dihitung terhadap penggunaan permintaan premium Anda. Hanya perintah yang Anda masukkan yang ditagih. Total permintaan premium yang digunakan tergantung pada berapa banyak perintah yang Anda masukkan dan model yang dipilih.
Menetapkan persyaratan dokumentasi proyek
Jenis dokumentasi dan persyaratan konten bergantung pada proyek, konsumen yang dimaksudkan, dan standar yang diadopsi oleh organisasi.
Misalnya, README.md dapat menyertakan bagian berikut:
- Judul Proyek: Nama proyek Anda.
- Deskripsi: Gambaran umum singkat tentang apa yang dilakukan proyek dan mengapa proyek tersebut ada.
- Daftar Isi: Opsional, tetapi berguna untuk READMEs yang lebih lama.
- Penginstalan: Petunjuk tentang cara menginstal dan menyiapkan proyek.
- Penggunaan: Contoh cara menggunakan proyek, termasuk cuplikan kode atau cuplikan layar.
- Fitur: Daftar fitur atau fungsionalitas utama.
- Konfigurasi: Detail tentang opsi konfigurasi atau variabel lingkungan apa pun.
- Kontribusi: Panduan untuk berkontribusi pada proyek.
- Lisensi: Lisensi apa pun yang digunakan oleh proyek terdistribusi.
- Kredit dan pengakuan: Pengenalan kontributor, pustaka, atau sumber daya yang digunakan.
- Kontak: Cara menjangkau pemeliharaan atau tim proyek.
- Changelog: Riwayat perubahan dan pembaruan (terkadang ditautkan ke file terpisah).
GitHub Copilot Chat dapat membantu Anda menghasilkan dokumentasi proyek yang memenuhi kebutuhan spesifik proyek Anda dan pemangku kepentingannya.
Gunakan mode Minta agen untuk menghasilkan dokumentasi proyek
Mode Agen Tanya dapat digunakan untuk menganalisis ruang kerja dan kemudian menghasilkan dokumentasi.
Gunakan proses berikut untuk menghasilkan dokumentasi proyek menggunakan mode Tanyakan agen:
Identifikasi persyaratan dokumentasi dan sumber daya pendukung.
Identifikasi persyaratan dokumentasi untuk proyek Anda. Identifikasi jenis dokumentasi dan bagian dokumen yang diperlukan.
Identifikasi sumber daya yang diperlukan untuk menghasilkan dokumentasi. Ruang kerja kode Anda bisa menjadi satu-satunya sumber daya yang diperlukan. Namun, Anda mungkin perlu menambahkan konteks ke obrolan untuk bagian seperti "Berkontribusi", "Kredit", dan "Kontak".
Buka tampilan Obrolan dan mulai sesi obrolan baru menggunakan mode Tanyakan agen.
Tambahkan konteks ke sesi obrolan.
- Anda dapat menambahkan konteks ke sesi obrolan dengan menyeret dan menjatuhkan file dari tampilan EXPLORER Visual Studio Code ke tampilan Obrolan. Anda juga dapat menggunakan tombol Lampirkan Konteks (ikon klip kertas).
- Anda dapat membuka file eksternal di editor kode untuk menyertakan sumber daya yang bukan bagian dari ruang kerja dan menggunakannya untuk memberikan lebih banyak konteks. Misalnya, Anda dapat membuka file markdown yang berisi panduan kontributor atau informasi kontak lalu menggunakan tombol Lampirkan Konteks untuk menambahkannya ke konteks tampilan Obrolan.
Masukkan serangkaian perintah yang menyelidiki persyaratan dokumentasi Anda.
Anda dapat menggunakan mode Minta agen untuk menganalisis ruang kerja dan membangun riwayat sesi obrolan yang mendukung persyaratan dokumentasi Anda. Menjelaskan tujuan Anda dapat membantu membangun konteks untuk sesi obrolan. Mengajukan pertanyaan yang memenuhi persyaratan Anda membantu GitHub Copilot mengidentifikasi informasi yang diperlukan untuk menghasilkan dokumentasi.
Perbarui konteks yang ditambahkan sesuai kebutuhan.
Masukkan perintah yang meminta dokumentasi proyek yang disarankan, mencantumkan bagian yang diperlukan yang Anda identifikasi di langkah pertama.
Misalnya: "
@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."Tinjau dokumentasi proyek yang disarankan, dan perbaiki hasilnya menggunakan perintah baru jika perlu.
Pindahkan dokumentasi proyek yang disarankan ke dalam file dokumentasi proyek.
Misalnya, buat file README.md di akar ruang kerja, dan sisipkan konten yang disarankan ke dalam file.
Anda dapat menggunakan mode Minta agen untuk menyarankan pembaruan untuk bagian tertentu dari proyek Anda setelah membuat dokumen, atau menggunakan alat GitHub Copilot lainnya untuk membantu pembaruan.
Gunakan mode Rencana untuk menghasilkan dokumentasi proyek
Mode rencana adalah yang terbaik untuk membuat rencana implementasi terperinci sebelum membuat dokumentasi proyek. Mode Rencana menganalisis basis kode, mengidentifikasi persyaratan dokumentasi, dan menghasilkan rencana langkah demi langkah. Setelah rencana disetujui, Anda dapat menyerahkannya ke mode agen untuk pelaksanaan.
Gunakan proses berikut untuk menghasilkan dokumentasi proyek, seperti file README.md, menggunakan mode Rencana:
Identifikasi persyaratan dokumentasi dan sumber daya pendukung.
Buka tampilan Obrolan dan mulai sesi obrolan baru menggunakan mode Plan.
Masukkan perintah yang menjelaskan tugas dokumentasi Anda.
Misalnya: "Saya perlu membuat file README dan dokumentasi pendukung untuk proyek ini. README harus mencakup: Judul Proyek, Deskripsi, Daftar Isi, Penginstalan, Penggunaan, Fitur, Konfigurasi, dan Lisensi."
Tinjau rencana implementasi.
Setelah beberapa saat, agen Plan memunculkan rencana dalam tampilan Obrolan. Paket ini menyediakan ringkasan tingkat tinggi dan perincian langkah-langkah, termasuk pertanyaan terbuka untuk klarifikasi. Anda dapat melakukan iterasi beberapa kali untuk mengklarifikasi persyaratan, menyesuaikan cakupan, atau menjawab pertanyaan.
Setelah paket selesai, pilih Mulai Implementasi untuk menyerahkan paket ke mode agen, atau pilih Buka di Editor untuk menyimpan paket sebagai file Markdown untuk digunakan nanti.
Saat Anda memilih Mulai Implementasi, GitHub Copilot beralih ke mode agen dan mulai menerapkan dokumentasi berdasarkan rencana yang disetujui. Tinjau file dokumentasi yang dihasilkan dan terima atau buang perubahan.
Gunakan mode agen untuk menghasilkan dokumentasi proyek
Mode agen adalah yang terbaik untuk menghasilkan dokumentasi proyek yang memerlukan pemahaman mendalam tentang proyek. Mode agen menganalisis seluruh struktur proyek sebelum menghasilkan dokumentasi proyek. Dengan mengumpulkan informasi dari beberapa file dan folder, mode agen dapat menjelaskan hubungan yang kompleks dan menyertakan tautan antar dokumen.
Gunakan proses berikut untuk menghasilkan dokumentasi proyek, seperti file README.md, menggunakan mode agen:
Identifikasi persyaratan dokumentasi dan sumber daya pendukung.
Buka tampilan Obrolan dan mulai sesi obrolan baru menggunakan mode agen.
Tambahkan konteks ke sesi obrolan.
Peserta obrolan tidak tersedia dalam mode agen, sehingga Anda tidak dapat menentukan
@workspacesebagai bagian dari permintaan Anda. Namun, Anda dapat menambahkan konteks ke sesi obrolan menggunakan#codebasedan dengan menambahkan file dan folder ruang kerja ke konteks obrolan. File eksternal dapat dibuka di Visual Studio Code lalu ditambahkan ke konteks obrolan menggunakan tombol konteks Attach.Masukkan perintah untuk membuat dokumentasi proyek yang dimaksudkan.
Misalnya: "Hasilkan kumpulan file dokumentasi proyek. Buat atau perbarui file README.md ruang kerja untuk repositori ini. Membuat atau memperbarui file UsageExamples.md. Membuat atau memperbarui file ChangeLog.md. Sertakan tautan antara file dokumentasi, kelas dan metode referensi silang, dan pastikan konsistensi di seluruh dokumen."
Tinjau file dokumen lalu simpan atau buang pembaruan.
Perbarui file menggunakan perintah untuk memperbaiki atau meningkatkan bagian tertentu jika perlu.
Kemampuan mode agen
Ada beberapa tugas dokumentasi di mana mode agen adalah pilihan terbaik.
Pembuatan dokumentasi multi-file dan lintas file.
- Mode agen dapat menganalisis seluruh struktur proyek, mengumpulkan informasi dari beberapa file dan folder, dan menghasilkan dokumentasi yang menautkan dan meringkas konten di seluruh basis kode. Misalnya, menghasilkan referensi API lengkap atau README yang menjelaskan semua komponen utama.
Analisis dan ringkasan proyek otomatis.
- Mode agen dapat melakukan tugas seperti meringkas arsitektur, mengidentifikasi kelas/layanan utama, dan menghasilkan diagram atau tabel yang memerlukan pemahaman hubungan antara file dan komponen.
Pembuatan konten dinamis (misalnya, contoh penggunaan, tabel kelas)
- Mode agen dapat memindai proyek untuk menghasilkan contoh penggunaan, tabel tanggung jawab kelas, atau daftar API publik.
Tugas dokumentasi sekumpulan.
- Mode agen dapat menjalankan urutan tugas dokumentasi (misalnya, memperbarui README, membuat CONTRIBUTING.md, menghasilkan dokumen API, memperbarui changelog) dalam satu alur kerja.
Penautan dan navigasi cerdas.
- Mode agen dapat membuat tautan antara file dokumentasi, kelas dan metode referensi silang, dan memastikan konsistensi di seluruh dokumen.
Mode agen sangat ideal untuk tugas dokumentasi di seluruh proyek, multi-file, dan sadar konteks yang memerlukan analisis, sintesis, dan koordinasi.
Ringkasan
GitHub Copilot dapat membantu Anda menghasilkan dokumentasi proyek yang memenuhi kebutuhan spesifik proyek Anda dan pemangku kepentingannya. Tampilan Chat dapat digunakan untuk menghasilkan dokumentasi proyek dalam tiga mode berbeda: Tanya, Agen, dan Rencana. Setiap mode memiliki kekuatan dan kelemahannya sendiri, dan mode terbaik untuk digunakan tergantung pada tugas tertentu yang ada. Mode Tanyakan agen adalah yang terbaik untuk mengajukan pertanyaan tentang basis kode atau konsep teknologi Anda. Mode Agen adalah yang terbaik untuk menghasilkan dokumentasi proyek yang memerlukan pemahaman mendalam tentang proyek. Mode Rencana adalah yang terbaik untuk membuat rencana implementasi terperinci sebelum menghasilkan dokumentasi, yang kemudian dapat diserahkan ke mode Agen untuk dieksekusi.