Dokumentasi adalah Kuncinya

Praktik Terbaik 2 - Lengkapi dokumen Anda sebelum langkah berikutnya

Saya telah lulus master saya di Komputer & Aplikasi dan saya sangat bersemangat untuk menulis kode sumber bahkan tanpa sepenuhnya memahami dan mendokumentasikan persyaratan. Dokumen desain dan dokumentasi kasus uji tidak ada dalam siklus hidup pengembangan perangkat lunak .... ada lompatan langsung ke pengkodean.

Pada tahap selanjutnya saya menemukan diri saya dalam masalah besar dan segera saya menyadari Documentation is the Key untuk menjadi pengembang, penguji, atau arsitek perangkat lunak yang sukses.

Sebelum Anda mulai mengembangkan perangkat lunak kecil atau besar, Anda harus memiliki jawaban untuk pertanyaan-pertanyaan berikut:

Dimana Spesifikasi Persyaratan?
Di manakah Dokumen Analisis Dampak?
Dimana Dokumen Desain?
Sudahkah Anda mendokumentasikan semua asumsi, batasan dengan benar?
Sudahkah Anda selesai meninjau semua dokumen?
Apakah Anda menandatangani semua dokumen dari semua pemangku kepentingan?

Setelah Anda mendapatkan jawaban positif untuk semua pertanyaan di atas, Anda aman dan siap untuk melanjutkan pengkodean. Banyak organisasi memiliki aturan ketat yang harus diikuti, tetapi yang lain tidak. Praktik terbaiknya adalah melengkapi semua dokumentasi yang diperlukan dan mengambil persetujuan yang sesuai sebelum melanjutkan untuk pengkodean perangkat lunak.

Apa yang Anda pelajari hari ini, mempersiapkan Anda untuk hari esok!

Jadi, sekali lagi ini adalah salah satu praktik terbaik untuk memiliki dokumentasi sebanyak mungkin. Beberapa dokumen penting, yang akan mempersiapkan Anda untuk masa depan adalah:

Pendekatan Desain
Tip dan Trik
Fungsi, perintah, dan instruksi khusus
Pelajaran
Situasi yang aneh
Metode debug
Praktik terbaik
Apa pun yang dapat membantu Anda di masa depan

Menyimpan dokumen secara elektronik tidak dikenakan biaya. Jadi, mari mulai memelihara dokumentasi yang diperlukan.