Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Praktik terbaik untuk pembuatan dokumentasi dengan Amazon Q Developer
Untuk meningkatkan hasil dari pembuatan dokumentasi dengan Amazon Q, ikuti praktik terbaik berikut:
-
Amazon Q dapat menghasilkan dokumentasi untuk sejumlah kode dalam kuota ukuran proyek kode, namun repositori yang sangat besar akan membutuhkan waktu lebih lama untuk menghasilkan dokumentasi dan mungkin kurang spesifik. Jika Anda memiliki repositori besar, pertimbangkan untuk meminta dokumentasi untuk subset kode atau satu file untuk hasil yang lebih spesifik.
-
Kualitas dokumentasi yang dihasilkan Amazon Q dapat ditingkatkan jika kode Anda dikomentari dan terorganisir dengan baik, memiliki konvensi penamaan yang baik untuk entitas pemrograman, dan mengikuti konvensi pengkodean standar lainnya.
-
Amazon Q menghasilkan dokumentasi kualitas tertinggi untuk kode yang ditulis dalam satu atau lebih bahasa yang didukung. Kode yang ditulis dalam bahasa lain mungkin tidak tercermin dalam dokumentasi yang dihasilkan, atau dapat menghasilkan dokumentasi berkualitas lebih rendah. Untuk informasi lebih lanjut tentang bahasa, lihatDukungan bahasa untuk pembuatan dokumentasi.
-
Jika Anda ingin meminta perubahan spesifik ke README bahasa alami, Anda dapat melakukannya dengan memilih untuk memperbarui yang sudah ada README dan kemudian memilih opsi untuk membuat perubahan tertentu. Setelah Amazon Q menghasilkan dokumentasi, Anda juga dapat memilih untuk membuat perubahan dan menjelaskan pembaruan apa yang Anda ingin Amazon Q lakukan.
-
Saat menjelaskan pembaruan yang Anda inginkan Amazon Q buat ke dokumentasi Anda, pertimbangkan hal berikut:
-
Deskripsi perubahan harus mencakup bagian yang ingin Anda modifikasi, konten yang ingin Anda tambahkan atau hapus, dan masalah spesifik yang perlu diperbaiki.
-
Perubahan harus berhubungan dengan bagaimana fungsionalitas proyek tercermin dalamREADME.
-
Konten yang Anda rujuk harus tersedia di basis kode Anda.
-
-
Amazon Q tidak memiliki akses ke platform pribadi atau internal. Amazon Q juga mungkin tidak memiliki pengetahuan tentang alat atau perangkat lunak pihak ketiga atau perkakas khusus dalam kode Anda. Jika kode Anda menyertakan sumber daya Amazon Q tidak dapat mengakses atau tidak akrab dengannya, kode itu tidak akan didokumentasikan. Anda dapat mengedit secara manual README untuk menyertakan konten yang tidak dapat dihasilkan Amazon Q.
