Sudah cukup lama sejak saya menulis artikel terakhir di seri DevOps ini. Tapi sudah saatnya saya fokus pada salah satu hal terpenting di DevOps, yaitu dokumentasi.
Ini mungkin terasa seperti aktivitas yang sangat jelas dalam komunitas DevOps, tetapi dokumentasi yang efisien sering diabaikan di berbagai organisasi.
Ada upaya singkat untuk membuat metodologi Dokumentasi Berkelanjutan. Ada juga gerakan untuk membuat DocOps Framework yang keluar dari CA (sekarang Broadcom). Terlepas dari janji awalnya, DocOps tidak pernah menjadi gerakan industri.
Sebelum saya menyelami lebih jauh, penting bagi saya untuk berbicara secara singkat tentang Pengujian Kotak Hitam dan Pengujian Kotak Putih.
Pengujian Kotak Hitam
Pengujian Black Box sesuai dengan aspek non-fungsional dari perangkat lunak. Ini tidak ada hubungannya dengan cara kerja perangkat lunak dan berfokus pada aspek kegunaan perangkat lunak. Untuk dapat melakukan pengujian Black Box, Anda hanya perlu menjadi pengguna akhir.
Mengapa pendekatan seperti itu disebut sebagai Kotak Hitam? Hitam menunjukkan ketidakjelasan, yang menunjukkan bahwa Anda hanya memiliki akses tingkat pengguna ke perangkat lunak dan tidak dapat melihat cara kerjanya secara internal. Pengetahuan tentang kode sumber dalam kasus seperti itu tidak relevan.
Misalnya, untuk melakukan pengujian Black Box Firefox Nightly, Anda hanya perlu mengunjungi Halaman Unduhan Firefox Nightly, mengunduh, menginstal, dan menjalankan browser.
Nama lain untuk jenis pengujian ini adalah Behavioral Testing, karena ini semua tentang bagaimana perangkat lunak “berperilaku” secara real-time.
Pengujian Kotak Putih
Pengujian Kotak Putih sesuai dengan aspek fungsional perangkat lunak. Ini semua tentang bagaimana perangkat lunak bekerja dan berfokus pada aspek pengembangan perangkat lunak.
Untuk dapat melakukan tes White Box, Anda harus mengambil jalur pengembang. Mengapa pendekatan seperti itu disebut sebagai Kotak Putih? Putih menunjukkan transparansi, yang menunjukkan bahwa Anda memiliki akses tingkat pengembang ke perangkat lunak dan dapat melihat cara kerjanya secara internal. Pengetahuan tentang kode sumber dalam kasus seperti itu sangat penting.
Misalnya, untuk melakukan pengujian Kotak Putih Firefox Nightly, tempat terbaik untuk memulai adalah Firefox Source Docs dan mungkin juga Firefox ASan Nightly Page.
Nama lain untuk jenis pengujian ini adalah Pengujian Berbasis Kode, karena ini semua tentang bagaimana perangkat lunak "dikodekan" dan dibangun secara real-time.
Pada catatan itu:Apakah Anda menyadari betapa pentingnya Perangkat Lunak Sumber Terbuka dalam hal Pengujian Kotak Putih dan Kotak Hitam? Tidak ada kekaburan sama sekali! Perangkat Lunak berpemilik hanya dapat diuji Black Box karena tidak ada akses ke kode sumber. Semua ini memiliki pengaruh yang signifikan pada pembuatan manual lengkap untuk perangkat lunak apa pun.Apa itu Pengujian Dokumentasi?
Pengujian Dokumentasi adalah prosedur validasi dokumentasi untuk menguji fungsionalitas, kegunaan, dan keamanan dari setiap proses sistemik yang sedang dikembangkan. Itu memastikan sistem bekerja persis seperti yang didokumentasikan.
Apa itu DocOps?
Sejalan dengan cara kerja DevOps, DocOps adalah proses penyederhanaan berkelanjutan yang mempercepat Pengujian Dokumentasi dengan efisiensi yang cermat.
Secara konvensional, Pengujian Dokumentasi selalu dianggap sebagai bentuk Pengujian Kotak Hitam yang tidak berfungsi. Namun di era saat ini, itu tidak bisa berakhir begitu saja, dan DocOps membutuhkan comeback yang putus asa.
Pengujian Dokumentasi dapat melampaui batas Black Box karena mengetahui prosedur untuk mengembangkan, membangun, atau bahkan menerapkan perangkat lunak juga dapat menjadi faktor penting dalam mengurangi bug dan memperbaiki masalah.
Itu juga memerlukan dokumentasi yang cermat seperti yang dijelaskan dalam Dokumen Sumber Firefox (ditautkan di bagian sebelumnya sebagai contoh). Oleh karena itu, Pengujian Dokumentasi dapat melibatkan Pengujian Kotak Hitam dan Kotak Putih secara bersamaan. Jadi, jika Anda harus melakukan prosedur validasi seperti itu, Anda harus melakukannya di tiga tingkat:
- Pengujian Dokumentasi Fungsionalitas
- Pengujian Dokumentasi Kegunaan
- Pengujian Dokumentasi Keamanan
Pengujian Dokumentasi Fungsionalitas
Pengujian Dokumentasi Fungsionalitas merupakan pendekatan White Box terhadap sistem. Ini memvalidasi dokumentasi yang dibuat untuk mengembangkan, membangun, dan menerapkan perangkat lunak.
Pengujian Dokumentasi Kegunaan
Usability Documentation Testing merupakan pendekatan Black Box terhadap sistem. Ini memvalidasi dokumentasi yang dibuat untuk mengunduh, menginstal, dan menggunakan perangkat lunak.
Pengujian Dokumentasi Keamanan
Pengujian Dokumentasi Keamanan adalah pendekatan Kotak Hitam dan Kotak Putih terhadap suatu sistem. Ini memvalidasi dokumentasi yang dibuat untuk melakukan pengujian penetrasi dan memastikan keamanan optimal perangkat lunak dan sistemnya.
Siklus Hidup Peningkatan Dokumentasi (DILC)
Efektivitas fungsionalitas, kegunaan, dan pengujian keamanan tergantung pada kesederhanaan dokumentasi untuk setiap fase pengembangan sistem. Jika Anda melihat proses dokumentasi sebagai proses sistemik, dapat mengadopsi Siklus Hidup Pengembangan Sistem yang sama. model yang telah saya rancang dan sajikan sebelumnya:
Jika Anda hanya fokus pada diagram di atas sehubungan dengan mendokumentasikan bagaimana melakukan setiap tugas berlabel, maka secara kolektif akan menjadi Siklus Hidup Peningkatan Dokumentasi yang akan terus meningkatkan kualitas manual yang lengkap. Saat pengembangan perangkat lunak dimulai, dokumentasinya juga akan melalui revisi berkelanjutan berdasarkan apa yang berhasil dan apa yang tidak, betapapun besar atau kecilnya.
Sangat disayangkan bahwa DocOps tidak banyak dieksplorasi belakangan ini. Perangkat lunak, dengan sendirinya, mungkin sangat baik, tetapi dapat menjadi tidak dapat digunakan sama sekali tanpa dokumentasi yang tepat &tepat. Di sinilah Pengujian Dokumentasi berperan, dan dengan demikian membawa peran yang sama pentingnya sepanjang masa pakai perangkat lunak. Oleh karena itu, perangkat lunak itu sendiri akan selalu sebaik dokumentasinya, dan itulah kebenaran yang hakiki.
Bila Anda memiliki dokumentasi yang lebih baik, Anda pasti akan mendapatkan masalah yang lebih kecil/tertutup pada GitHub atau penyedia repositori lainnya.
Pemikiran Terakhir
Sesuai dengan apa yang baru saja saya diskusikan, tujuan utama kami di Buku Pegangan Linux adalah untuk menjelajahi Pengujian Dokumentasi Keamanan dan Fungsionalitas karena fokus utamanya adalah mendokumentasikan sisi server Linux. Ini FOSS, di sisi lain, berhubungan dengan Pengujian Dokumentasi Kegunaan karena fokus utama pada pengalaman pengguna Linux, kemudahan penggunaan dan kesederhanaan.
Siklus Hidup Peningkatan Dokumentasi juga dapat dikaitkan dengan upaya berkelanjutan kami untuk selalu memperbarui artikel kami dan memastikan semua yang dibahas sebelumnya masih dapat diuji dan berfungsi apa adanya, yang merupakan persyaratan utama DocOps yang Efektif.
Saya harap Anda menemukan bacaan ini berguna tentang mengapa dokumentasi berkelanjutan dapat menjadi tujuan selamanya. Saya akan menjelajahi seri DevOps lebih jauh dan menjelajahi HumanOps di artikel saya berikutnya (dalam seri ini). Jika Anda memiliki saran dan pemikiran untuk dibagikan yang relevan dengan seri ini atau artikel ini secara khusus, beri tahu saya di bagian di bawah.