Perpustakaan Digital ITB

Pengembangan proyek berkelanjutan memanfaatkan dokumentasi untuk memudahkan developer lain dan developer yang baru agar dapat memahami sistem yang dikerjakan dan ikut serta pengembangan. Namun ketika dokumentasi tidak tersedia, tidak berkualitas, atau tidak sesuai dengan tugas developer, mereka terpaksa harus memahami sistem dengan membaca kode secara manual. Dokumentasi API otomatis yang disediakan FastAPI menyediakan informasi mengenai bagaimana suatu API dapat digunakan, tapi informasi ini belum tentu dapat menutupi kebutuhan developer dalam memahami sistem. Penelitian ini mengidentifikasi kebutuhan informasi dalam lingkup FastAPI untuk merancang sistem dokumentasi otomatis yang dapat menjawab kebutuhan informasi tersebut. Analisis literatur yang kemudian diverifikasi melalui kuisioner menunjukkan bahwa informasi yang dibutuhkan berkaitan erat dengan definisi suatu route beserta bagaimana dan komponen apa saja yang terlibat dalam pemrosesan suatu request oleh route tersebut. Kontribusi utama penelitian berada pada penggabungan literatur pemahaman kode untuk menghasilkan kategorisasi kebutuhan pemahaman kode melalui pencarian informasi yang kemudian diterapkan untuk menjadi basis penetuan kebutuhan informasi pada perawatan dan pengembangan proyek FastAPI. Hasil analisis kemudian mengarah kepada perancangan dan implementasi CodeQLRouteGen; sistem dokumentasi otomatis berbasis analisis statis menggunakan CodeQL untuk mengekstraksi informasi dari artefak kode proyek FastAPI dan memaparkan informasi terkait definisi route dan komponen yang terlibat dengan route melalui dokumen dan visualisasi interaktif. Evaluasi kualitatif melalui pengujian pengguna dan wawancara menunjukkan bahwa metode visualisai yang dipilih berhasil dalam membantu memberi kemudahan kepada developer untuk menemukan informasi yang diinginkan namun dengan catatan detil implementasi pada visualisasi perlu untuk diperinci kembali. Evaluasi kuantitatif melalui pengukuran presisi, akurasi, dan nilai F1 dari daftar route yang dihasilkan CodeQLRouteGen dengan daftar route pada dokumentasi API otomatis memiliki rata-rata nilai F1 0.9 dengan recall 0.9252 dan precision 0.8857. Hasil ini menunjukkan bahwa sistem sudah dapat menyediakan informasi yang dibutuhkan namun dapat dikembangkan lebih lanjut untuk mendukung kompleksitas pemahaman yang lebih tinggi dan menghasilkan daftar route yang lebih lengkap.