Add buatdokumentasiAPI.md

buatdokumentasiAPI.md

@@ -0,0 +1,76 @@
+Tentu saja bisa! GitHub Copilot sangat mampu memahami dan merespons instruksi dalam Bahasa Indonesia dengan baik.
+
+Berikut adalah beberapa pilihan prompt yang disusun khusus untuk menghasilkan dokumentasi API yang detail, terstruktur, dan mudah dipahami untuk integrasi. Anda bisa memilih format yang paling sesuai dengan kebutuhan proyek Anda.
+
+---
+
+### Opsi 1: Prompt untuk Dokumentasi Markdown (README.md)
+
+Gunakan prompt ini jika Anda ingin menaruh dokumentasi di file `README.md` atau wiki agar mudah dibaca manusia.
+
+**Cara pakai:** Buka Copilot Chat (Ctrl+I atau Cmd+I), seleksi kode API/Controller Anda, lalu paste prompt ini:
+
+```text
+Bertindaklah sebagai Senior Technical Writer. Tolong buatkan dokumentasi API yang lengkap dan profesional berdasarkan kode yang saya seleksi ini.
+
+Dokumentasi harus menggunakan Bahasa Indonesia dan mencakup hal-hal berikut untuk setiap endpoint:
+1. Nama Endpoint & Deskripsi Singkat (apa kegunaannya).
+2. HTTP Method (GET, POST, PUT, DELETE).
+3. URL Path.
+4. Parameter Request (Header, Body, Query Params) lengkap dengan tipe data dan status (wajib/opsional).
+5. Contoh Request (tuliskan dalam format cURL atau JSON).
+6. Contoh Response Sukses (200 OK) dengan struktur JSON dan penjelasan field-nya.
+7. Contoh Response Error (400, 401, 500) dan kemungkinan penyebabnya.
+
+Format output harus menggunakan Markdown yang rapi agar mudah dibaca oleh developer lain yang akan melakukan integrasi.
+
+```
+
+### Opsi 2: Prompt untuk Format OpenAPI (Swagger)
+
+Gunakan prompt ini jika Anda membutuhkan spesifikasi teknis standar industri yang bisa diimpor ke Postman atau Swagger UI.
+
+**Prompt:**
+
+```text
+Buatkan spesifikasi OpenAPI 3.0 (Swagger) dalam format YAML untuk kode API yang ada di file ini.
+
+Pastikan mencakup detail skema untuk Request Body dan Response Object. Berikan deskripsi yang jelas untuk setiap field agar developer pihak ketiga bisa memahaminya tanpa melihat source code.
+
+```
+
+### Opsi 3: Prompt untuk Inline Documentation (JSDoc / Docstring)
+
+Gunakan ini jika Anda ingin dokumentasinya menempel langsung di dalam kode fungsi agar muncul saat di-hover.
+
+**Prompt:**
+
+```text
+Tolong tambahkan komentar dokumentasi (seperti JSDoc untuk JS/TS atau Docstring untuk Python) pada setiap fungsi handler di kode ini.
+
+Jelaskan:
+- Tujuan fungsi.
+- Parameter input (tipe dan deskripsi).
+- Return value/Response object.
+- Kemungkinan error yang dilempar.
+Gunakan bahasa yang jelas dan ringkas.
+
+```
+
+---
+
+### Tips Agar Hasil Copilot Lebih Akurat
+
+Untuk hasil terbaik di VS Code, ikuti langkah berikut sebelum memasukkan prompt:
+
+1. **Gunakan `@workspace` (Jika kode tersebar):**
+Jika definisi model database (schema) dan controller/route Anda berada di file terpisah, gunakan perintah `@workspace` agar Copilot membaca seluruh konteks proyek.
+* *Contoh:* `@workspace Buatkan dokumentasi API untuk fitur Login berdasarkan route dan controller yang ada, serta jelaskan validasinya.`
+
+
+2. **Seleksi Kode (Highlight):**
+Jika Anda hanya ingin mendokumentasikan satu fungsi spesifik, blok/highlight dulu kodenya, baru ketik prompt di Chat window.
+3. **Iterasi (Perbaiki):**
+Jika hasil pertama kurang pas, Anda bisa membalas dengan: *"Tolong tambahkan contoh JSON response untuk kondisi error validasi input"* atau *"Buat penjelasannya lebih sederhana untuk developer pemula."*
+
+**Apakah Anda ingin saya buatkan contoh hasil dokumentasinya berdasarkan potongan kode dummy?**