Generator Dokumentasi Teknis

Template dokumentasi teknis ini mengubah catatan kode yang tersebar, komentar inline, dan detail implementasi menjadi dokumen yang bersih dan terstruktur. Cocok saat Anda membutuhkan output konsisten untuk gambaran arsitektur, langkah pengaturan, perilaku endpoint, dan kasus tepi tanpa harus menulis ulang konteks yang sama secara manual. Prompt ini membimbing model untuk memisahkan perilaku faktual dari asumsi, yang membantu mengurangi halusinasi dan menjaga dokumen tetap sesuai dengan basis kode yang sebenarnya.

Ini sangat berguna untuk insinyur backend, advokat pengembang, dan penulis teknis yang mendokumentasikan layanan setelah pengiriman fitur atau selama pekerjaan pemeliharaan. Output diatur sedemikian rupa sehingga pembaca dapat dengan cepat menemukan prasyarat, konfigurasi, contoh, dan catatan penting. Anda dapat menyesuaikan nada untuk wiki internal, panduan pelanggan, atau catatan serah terima dengan mengubah variabel audience dan voice. Ini juga cocok dipadukan dengan catatan rilis, karena model dapat merangkum apa yang berubah dan mengapa hal itu penting.

Untuk menyesuaikan, tempel materi sumber Anda ke {{SOURCE_MATERIAL}}, tentukan audiens di {{AUDIENCE}}, dan spesifikasikan kedalaman yang diinginkan di {{DEPTH}}. Jika Anda menginginkan detail operasional lebih lengkap, tambahkan {{ENVIRONMENT}} dan {{CONSTRAINTS}} agar model menyertakan catatan deployment, dependensi, dan batasan. Output yang diharapkan adalah dokumen yang halus dengan judul, paragraf pendek, dan potongan contoh. Untuk hasil terbaik, minta satu kali proses fokus pada akurasi, lalu proses kedua fokus pada keterbacaan dan struktur.