Dokumentasi Bukan Pelengkap: Membangun Dokumentasi Proyek Python dengan MkDocs dan GitHub Pages
Selama beberapa minggu terakhir penulis mengembangkan BuckPow, sebuah platform open source untuk energy observability dan benchmarking perangkat IoT serta embedded system. Saat ini repository tidak hanya berisi aplikasi backend berbasis Python, tetapi juga firmware untuk ESP8266/ESP32, dashboard web, REST API, contoh implementasi, hingga dokumentasi perangkat keras. Pada awal pengembangan, seluruh informasi penulis tampilkan di dalam README.md. Cara tersebut cukup efektif ketika proyek masih sederhana. Namun, setelah setelah beta rilis pertama, README mulai terasa kurang untuk menampung semua informasi mengenai proyek. Sehingga penulis mulai kesulitan menjaga dokumentasi untuk tetap rapi, pada kondisi tersebut penulis menyadari bahwa dokumentasi tidak bisa lagi diperlakukan sebagai lampiran proyek. Dokumentasi harus menjadi bagian dari proses pengembangan. ...