Dokumentasi Kode/Syntax Analisis
Prompt untuk mendokumentasikan kode atau syntax analisis data secara terstruktur
Prompt
Bantu saya mendokumentasikan kode/syntax analisis data penelitian:
- Software: [R/Python/SPSS/Stata/MATLAB/lainnya]
- Jenis analisis: [deskripsikan]
- Level audiens: [diri sendiri/tim/publik (open science)]
Buatkan dokumentasi yang mencakup:
1. **README file:**
- Deskripsi proyek
- Struktur folder dan file
- Cara menjalankan analisis dari awal sampai akhir
- Dependencies dan versi software
2. **Komentar di kode:**
- Header untuk setiap script (tujuan, input, output, author, tanggal)
- Komentar untuk setiap blok logika
- Penjelasan keputusan analitis (mengapa, bukan hanya apa)
3. **Codebook:**
- Definisi setiap variabel
- Coding scheme
- Missing data conventions
4. **Reproducibility checklist:**
- Apakah bisa dijalankan di komputer lain?
- Apakah seed random sudah di-set?
- Apakah path bersifat relative (bukan absolute)?
5. **Version control:**
- Tips menggunakan Git untuk penelitian
- Kapan commit dan bagaimana menulis commit message
Kapan Digunakan
- Saat menulis syntax analisis yang akan digunakan kembali
- Saat menyiapkan supplementary materials untuk publikasi
- Saat menerapkan prinsip open science dan reproducibility
Cara Menggunakan
- Dokumentasikan sejak mulai menulis kode
- Gunakan prompt untuk memastikan kelengkapan
- Test reproducibility di komputer berbeda
- Share di repository jika kebijakan memungkinkan