Individual Review #6

Setelah individual review yang lalu, saya akhirnya memilih untuk mengerjakan story untuk request day off, yang dapat digunakan oleh para karyawan untuk mengajukan izin atau cuti. Cakupan pekerjaan yang saya lakukan adalah membuat unit testing, migration, backend, serta frontend yang berkaitan dengan story tersebut.

Untuk model, sudah ada model yang dibuat oleh kelompok kami pada awal sprint. Akan tetapi, seiring waktu berjalan, saya menemukan adanya kejanggalan pada model. Salah satu case-nya adalah mengenai status pengajuan cuti. Awalnya di model, database kami hanya menyimpan status tersebut sebagai boolean yang bernilai true jika cuti di-approve. Namun, saya merasa, nilai boolean tersebut kurang definitif jika bernilai false. Karyawan tidak dapat mengetahui apakah pengajuan yang bernilai false tersebut sebenarnya masih menunggu persetujuan atau sudah ditolak.

Akhirnya, setelah berdiskusi dengan tim, saya melakukan penyesuaian terhadap database dengan mengubah status boolean tersebut menjadi 3 opsi yang bernilai ‘disetujui’, ‘menunggu persetujuan’, dan ‘ditolak’ sehingga karyawan dapat mengetahui status pengajuannya dengan lebih jelas.

Kemudian, berikut adalah hal yang dipelajari oleh saya sejak individual review yang lalu:

Release Notes

Release notes adalah dokumen yang disertakan dalam distribusi produk dan biasanya berisi mengenai perubahan-perubahan yang terjadi setiap produk tersebut dirilis. Contohnya? Pasti kalian pernah melihatnya dari Google Play Store atau App Store.

Seperti contoh dari Facebook di atas yang menyatakan bahwa tiap update atau versi yang dikeluarkan adalah improvement terhadap speed dan reliability dan jika ada fitur baru, akan di-highlight pada app.

Namun, apakah ini berarti bagi para penggunanya, khususnya bagi para pengguna yang berekspektasi tentang perubahan user experience dari Facebook sendiri?

Release notes tersebut tentu kurang deksriptif bagi para pengguna yang ingin tahu lebih lanjut mengenai fitur apa saja yang mengalami perubahan di aplikasi itu dan bagaimana perubahan tersebut dapat menguntungkan pengguna.

Oleh karena itu, release notes harusnya dapat memberikan gambaran mengenai hal apa saja yang diubah tiap rilis dan bagaimana hal tersebut dapat menguntungkan bagi para penggunanya jika melakukan update.

Salah satu template release notes menarik yang dapat menjelaskan gambaran bagi penggunanya adalah yang saya dapatkan dari ProdPad. Release notes kurang lebih dapat berisi 4 hal major seperti berikut:

Salah satu contoh aplikasi yang memiliki release notes yang baik adalah Slack:

Documentation Generator dengan JSDoc

JSDoc adalah generator dokumentasi API untuk JavaScript. Cara menggunakannya cukup dengan mengetik npm install jsdoc untuk instalasi, kemudian ketik komentar pada berkas yang ingin dibuat dokumentasinya.

Setelah membuat komentar dan menyimpan berkas tersebut, jalankan perintah jsdoc namafile.js. Kemudian, JSDoc dapat menghasilkan dokumentasi API yang dapat dilihat dengan format web. Hasilnya dapat dilihat dalam file html yang ada di folder out seperti berikut.