Coding & data · Wawancara balik
README proyek dari wawancara singkat
AI bertanya satu per satu tentang proyekmu, lalu menyusun README berisi kegunaan, cara instalasi, cara pakai, dan batasan yang benar-benar ada.
1 kali kirim2 isianDiperbarui
Untuk: Mahasiswa, pencari kerja yang menyiapkan portofolio GitHub, dan programmer yang proyeknya belum berdokumen.
Diadaptasi dari prompts.chat (CC0)
Prompt siap salin
Prompt
Saya ingin menulis README.md untuk proyek {{nama proyek}} di GitHub. Pembaca utamanya: {{perekrut yang melihat portofolio / rekan tim baru / pengguna umum}}. Jangan langsung menulis. Wawancarai saya dulu, satu pertanyaan per pesan, tunggu jawaban saya sebelum bertanya lagi. Tanyakan hal yang dibutuhkan pembaca tadi, misalnya: masalah yang diselesaikan, cara menjalankan dari nol (versi bahasa, dependensi, variabel lingkungan; sebutkan namanya saja, jangan isi rahasianya), contoh penggunaan, struktur folder penting, keterbatasan yang sudah diketahui, dan lisensi. Maksimal 10 pertanyaan; bila jawaban saya sudah mencakup pertanyaan berikutnya, lewati. Setelah wawancara selesai, tulis README dalam Markdown dengan bagian: judul dan satu kalimat kegunaan, fitur, prasyarat, instalasi langkah demi langkah dalam blok kode, cara pakai dengan contoh, struktur folder, keterbatasan, dan lisensi. Tandai tempat tangkapan layar dengan [tangkapan layar: apa yang ditampilkan]. Jangan mengarang perintah, fitur, angka performa, atau lencana (badge) yang tidak saya sebut; yang belum jelas tulis [isi].
Isian yang harus kamu ganti
Ganti bagian yang disorot, termasuk tanda {{ }}.
- nama proyek
- perekrut yang melihat portofolio / rekan tim baru / pengguna umum
Bedah prompt: kenapa ini bekerja
Tiap potongan di bawah dikutip persis dari prompt di atas.
satu pertanyaan per pesan, tunggu jawaban saya
Pertanyaan satu per satu membuatmu menjawab dengan rinci, bukan mengisi daftar panjang sekaligus lalu melewatkan bagian penting.
cara menjalankan dari nol
Bagian instalasi paling sering gagal karena penulis lupa langkah yang sudah otomatis di komputernya sendiri.
sebutkan namanya saja, jangan isi rahasianya
README publik di GitHub bisa dibaca siapa saja, jadi nilai kunci dan kata sandi tidak boleh ikut tertulis.
Jangan mengarang perintah, fitur, angka performa, atau lencana
Perintah instalasi karangan langsung gagal saat dicoba pembaca dan merusak kesan pertama portofolio.
Kalau jawabannya belum pas
Kirim di percakapan yang sama. Perintah yang spesifik jauh lebih efektif daripada "perbaiki lagi".
README terlalu panjang
Pangkas README ini sampai bisa dibaca dalam satu menit oleh {{pembaca utama}}: pertahankan instalasi dan contoh penggunaan, pindahkan sisanya ke bagian Dokumentasi lanjutan.
Kelas terkait
- Dokumentasi Teknis: Panduan Pengguna dan ProsedurPembaca dan jenis dokumen, prasyarat, langkah bernomor, hasil langkah, placeholder, catatan dan peringatan, troubleshooting, serta konsistensi istilah. Kelas ini menguji penerapan aturan tertulis pedoman gaya, bukan kemampuan menulis dokumen bebas.
- Menulis dengan MarkdownJudul, daftar, tautan, tabel, blok kode, dan daftar tugas — ditulis di editor, hasilnya terlihat langsung.
Prompt lain di Coding & data
- Jelaskan pesan error dan cari penyebabnyaIsian formulir · Isi formulir bahasa, perintah, pesan error lengkap, dan kode terkait, lalu dapat arti error, dugaan penyebab, dan cara membuktikannya.
- Query SQL dari pertanyaan bisnisPercakapan bertahap · Tempel skema tabel sekali, pastikan AI memahaminya, lalu ajukan pertanyaan satu per satu dan dapat query beserta penjelasannya.
- Regex dari contoh yang cocok dan tidakDengan contoh · Daftar teks yang harus cocok dan yang harus ditolak jadi soal latihan bagi AI, lalu regex-nya diuji terhadap setiap contoh.
- Pesan commit dan deskripsi pull requestDua fase · Fase 1 meringkas diff dan memeriksa apakah perlu dipecah; fase 2 menulis pesan commit dan deskripsi PR dari ringkasan yang kamu setujui.