💭 🐆 ⏲️ Aturan 10: 1 dalam pemrograman dan penulisan 🐮 🖖🏻 🌝

Dalam artikel ini, penulis menganalisis jumlah waktu yang dihabiskan untuk menulis buku atau kode program, dan sampai pada pola yang menarik. Ini dapat digunakan untuk menjadwalkan pekerjaan proyek.

Hukum Hofstadter: Bisnis apa pun selalu bertahan lebih lama dari yang diharapkan, bahkan jika Anda memperhitungkan hukum Hofstadter.
- Douglas Hofstadter, Gödel, Asher, Bach

Menulis prosa dan kode memiliki banyak kesamaan. Tetapi kemiripan yang paling mencolok adalah bahwa baik penulis maupun programmer tidak dapat menyelesaikan pekerjaan mereka tepat waktu. Penulis terkenal karena melanggar tenggat waktu. Programmer telah mendapatkan reputasi orang-orang yang hasilnya selalu sangat berbeda dari perhitungan awal. Muncul pertanyaan: mengapa?

Hari ini saya punya ide bagaimana menjawabnya. Dan temuan saya membuat saya takjub.

Mempelajari buku saya

Kedua buku saya, Halo, startup dan Terraform: kami meluncurkan dan bekerja , saya menulis di lingkungan pembuatan buku Atlas , yang menyediakan untuk mengelola semua konten menggunakan Git. Ini berarti bahwa setiap baris teks, setiap pengeditan dan setiap perubahan telah dikomit ke log commit Git.

Mari kita periksa berapa banyak usaha yang dihabiskan untuk menulis dua buku.

Hai startup

Mari kita mulai dengan buku pertama saya. Halo startup . Ini memiliki 602 halaman dan sekitar 190 ribu kata. Saya menjalankan cloc di repositori Hello, Startup git dan mendapatkan hasil berikut (untuk kesederhanaan, bagian pecahan dibuang):

602 halaman berisi 26.571 baris teks. Bagian terbesar ditulis dalam AsciiDoc , mirip dengan Markdown. Ini digunakan oleh Atlas untuk menulis hampir semua konten. Menggunakan HTML dan CSS, Atlas mendefinisikan tata letak dan struktur buku. Selain mereka, ada bahasa pemrograman lain (Java, Ruby, Python dan tidak hanya), di mana berbagai contoh ditulis untuk topik yang dibahas dalam buku ini.

Tetapi 602 halaman dan 26.571 baris hanyalah hasil akhirnya. Mereka tidak mencerminkan sekitar 10 bulan penulisan, perubahan, pengeditan, pengoreksian, penyesuaian gaya, penelitian, catatan, dan pekerjaan lain yang berkontribusi pada penerbitan buku. Oleh karena itu, untuk mendapatkan ide yang lebih berguna, saya menggunakan git-quick-stats untuk menganalisis seluruh log komit buku.

Jadi, saya menambahkan 163.756 baris dan menghapus 131.425, yang secara total memberikan 295.181 baris bahan olahan. Artinya, ternyata saya menulis atau menghapus total 295 181 baris, di mana 26 571 baris tetap sebagai hasilnya. Rasio ini sedikit di atas 10: 1. Untuk mendapatkan setiap baris yang dipublikasikan, saya harus menulis 10 lainnya terlebih dahulu!

Saya akui bahwa menghitung jumlah baris yang ditambahkan dan dihapus dari Git tidak dapat dianggap sebagai metrik yang ideal untuk proses pengeditan. Tetapi, setidaknya, ini memungkinkan kita untuk memahami bahwa perhitungan sederhana tidak cukup untuk mengevaluasi pekerjaan yang dilakukan. Sebagian besar dari proses tidak tercermin sama sekali dalam log komit Git. Misalnya, beberapa bab pertama ditulis dalam Google Documents sebelum saya pindah ke Atlas, dan banyak pengeditan dilakukan di komputer saya tanpa komitmen.

Terlepas dari kenyataan bahwa data ini jauh dari ideal, saya percaya bahwa rasio keseluruhan "bahan teks asli" untuk diterbitkan adalah 10: 1.

Terraform: kami mulai dan bekerja

Mari kita periksa apakah proporsi ini berlaku untuk buku kedua saya Terraform: kami meluncurkan dan bekerja , yang berisi 206 halaman dan sekitar 52 ribu kata.

Output sederhana dari cloc :

206 halaman terdiri dari 8410 baris teks. Sekali lagi, sebagian besar teks ditulis dalam AsciiDoc, meskipun buku ini mengandung lebih banyak contoh kode yang ditulis terutama dalam HCL, bahasa utama Terraform. Selain dia, ada banyak penurunan harga yang saya gunakan untuk mendokumentasikan contoh HCL.

Kami akan menggunakan git-quick-stats untuk memeriksa riwayat revisi buku ini:

Selama hampir lima bulan, saya menambahkan 32.209 dan menghapus 22.402 baris, total 54.611 baris daur ulang. Keakuratan mengevaluasi proses penyuntingan buku ini semakin menderita, ketika pekerjaan dimulai sebagai serangkaian posting blog yang melalui revisi nyata sebelum dipindahkan ke Atlas dan Git. Volume posting blog ini mengambil setidaknya setengah dari buku, jadi akan logis untuk meningkatkan tingkat akhir teks yang diproses sebesar 50%. Artinya, itu akan menghasilkan 54611 * 1,5 = 81 916 baris teks yang dapat diedit, menghasilkan total 8410 baris.

Dan lagi, rasio sekitar 10: 1 diamati!

Tidak mengherankan bahwa penulis tidak memenuhi tenggat waktu. Jika jadwal seharusnya menyerahkan buku 250 halaman, maka dalam praktiknya ternyata dalam prosesnya kita akan menulis 2.500 halaman.

Bagaimana dengan pemrograman?

Bagaimana perkembangannya? Saya memutuskan untuk memeriksa beberapa repositori open source git dari berbagai tingkat kematangan: dari beberapa bulan hingga 23 tahun.

terraform-aws-couchbase (2018)

terraform-aws-couchbase adalah seperangkat modul untuk menyebarkan dan mengelola Couchbase di AWS, kode sumber yang dibuka pada 2018.

Output sederhana dari cloc :

Dan inilah hasil dari memeriksa git-quick-stats :

Kami mendapatkan sebanyak 37.693 baris kode kerja, menghasilkan 7481 baris kode akhir dalam rasio 5: 1. Bahkan dalam repositori di bawah 5 bulan, saya harus menulis ulang setiap baris lima kali! Tidaklah mengherankan bahwa mengevaluasi pengembangan perangkat lunak itu rumit: kita bahkan tidak membayangkan bahwa untuk mendapatkan 7,5 ribu baris kode akhir, kita benar-benar harus menulis 35 ribu

Mari kita lihat bagaimana keadaan dengan produk yang lebih tua.

Terratest (2016)

Terratest adalah pustaka sumber terbuka yang dibuat pada 2016 untuk menguji kode infrastruktur.

Output sederhana dari cloc :