Bagian B. Catatan berjalan
9. Format entri
Satu entri ditulis setiap kali ada keputusan yang diambil atau eksperimen yang dijalankan. Entri ditulis lebih dulu oleh pengembang dengan bahasa apa adanya, lalu dirapikan.
Bidang | Isi |
|---|---|
ID | Nomor urut, format RN-001, RN-002, dan seterusnya. Dipakai supaya antar entri bisa saling menunjuk. |
Tanggal | Tanggal entri ditulis. |
Judul | Satu baris, menyebut keputusan atau eksperimennya. |
Tujuan | Apa yang ingin dicapai atau dibuktikan. |
Hipotesis | Dugaan sebelum dikerjakan. Kalau menyangkut hipotesis utama, sebut kodenya, misalnya H2. |
Proses | Apa yang benar-benar dilakukan, termasuk yang gagal. |
Hasil | Apa yang terjadi, dengan angka bila ada. |
Status | Terbuka, Terbukti, Dibatalkan, atau Diganti. |
Bukti | Tangkapan layar, catatan biaya, tautan laporan, atau nomor commit. |
Catatan pengembang | Pendapat pribadi, keraguan, atau firasat. Bagian ini sengaja tidak formal. |
Pembaruan | Koreksi bertanggal yang ditambahkan belakangan. Boleh lebih dari satu. |
Aturan entri.
Isi entri dibekukan setelah ditulis. Koreksi tidak menimpa isi lama, tetapi ditambahkan sebagai blok pembaruan bertanggal di bawah entri yang sama.
Kalau sebuah keputusan diganti keputusan baru, status entri lama diubah menjadi Diganti, dan ID entri penggantinya ditulis di situ. Entri baru menyebut ID entri yang digantikannya.
Perbaikan salah ketik dan tata bahasa boleh dilakukan kapan saja, karena tidak mengubah isi.
Angka ditulis apa adanya. Kalau hasilnya mengecewakan, tetap ditulis. Entri yang hanya berisi keberhasilan tidak berguna untuk pengambilan keputusan berikutnya.