Kode Unit : J.620100.023.
02
Unit Kompetensi Judul : Membuat Dokumen Kode Program
Unit
A. Petunjuk
1. Baca dan pelajari setiap instruksi kerja dibawah ini dengan cermat sebelum melaksanakan
praktek
2. Klarifikasi kepada Asesor apabila ada hal-hal yang belum jelas
3. Laksanakan pekerjaan sesuai dengan urutan proses yang sudah ditetapkan
4. Seluruh proses kerja mengacu kepada SOP/WI yang dipersyaratkan
5. Batas Waktu : 30 Menit
B. Skenario
Anda diminta untuk membuat dokumen kode program sehingga membantu
proses pengembangan dan juga perbaikan kesalahan (bug), dengan ketentuan
sebagai berikut :
1. Buka file program ”Aplikasi Pembayaran Listrik Pascabayar” yang telah dibuat.
2. Penulisan dokumentasi program sesuai dengan standar.
3. Gunakan tools untuk menghasilkan dokumen kode program sesuai bahasa
pemrograman yang dikuasai.
C. Langkah Kerja
1. Lakukan identifikasi kode program
a. Identifikasi modul
Jawab:
b. Identifikasi parameter yang digunakan pada program.
Jawab:
c. Jelaskan cara kerja algoritma program sesuai dengan definisi masalah.
Jawab:
d. Berikan komentar setiap baris kode termasuk data, eksepsi, fungsi, prosedur dan
class (bila ada) sesuai dengan bahasa pemrograman.
Jawab:
2. Buatlah dokumentasi modul program
a. Buat dokumentasi modul sesuai dengan identitas untuk memudahkan pelacakan.
Jawab:
b. Terapkan identifikasi dokumentasi sesuai dengan identitas untuk memudahkan
pelacakan.
Jawab:
1. Nomor Referensi atau ID Unik:
Berikan setiap dokumen nomor referensi atau ID unik yang unik untuk
membedakannya dari dokumen lainnya.
Pastikan nomor referensi tersebut mudah dicari dan dipahami.
2. Tanggal Pembuatan atau Pembaruan:
Sertakan tanggal pembuatan dokumen dan tanggal pembaruan terakhir (jika
ada).
Ini membantu dalam menentukan kekinian informasi.
3. Jenis Dokumen:
Tentukan jenis dokumen secara jelas (contoh: faktur, kontrak, laporan, dll.).
Pemilihan jenis dokumen membantu dalam mengelompokkan informasi
dengan lebih baik.
4. Identitas Pihak Terkait:
Jika dokumen melibatkan pihak-pihak tertentu, pastikan identitas mereka
dijelaskan dengan baik.
Misalnya, untuk kontrak, sebutkan pihak yang terlibat dan peran masing-
masing.
5. Metadata:
Tambahkan metadata seperti tag atau kategori untuk memudahkan
pengelompokan dan pencarian.
Ini dapat mencakup informasi seperti departemen terkait, proyek terkait,
atau kategori lainnya.
6. Penamaan File yang Jelas:
Gunakan sistem penamaan file yang konsisten dan jelas.
Hindari penggunaan karakter khusus atau singkatan yang ambigu.
7. Database atau Sistem Manajemen Dokumen:
Jika memungkinkan, simpan informasi identifikasi dalam database atau
sistem manajemen dokumen untuk memudahkan pencarian dan pelacakan.
8. Otentikasi dan Otorisasi Akses:
Pastikan bahwa hanya pihak yang berwenang yang dapat mengakses dan
mengelola dokumen tersebut.
Terapkan sistem otentikasi dan otorisasi yang memadai.
9. Revisi dan Riwayat Perubahan:
Catat setiap revisi atau perubahan yang terjadi pada dokumen.
Ini membantu dalam melacak evolusi informasi dan memahami versi yang
digunakan saat ini.
c. Jelaskan kegunaan modul.
Jawab:
1. Pemecahan Masalah:
Modul membantu dalam memecah masalah kompleks menjadi masalah yang
lebih kecil dan lebih mudah dikelola. Setiap modul dapat fokus pada tugas
tertentu, sehingga mempermudah pemahaman dan pengembangan.
2. Pemrograman Terstruktur:
Modul mendukung konsep pemrograman terstruktur dengan memisahkan
logika program ke dalam unit-unit terpisah. Hal ini membuat kode lebih
mudah dimengerti dan dipelihara.
3. Reusabilitas Kode:
Modul yang baik dirancang dapat digunakan kembali di berbagai bagian
program atau bahkan dalam proyek-proyek berbeda. Ini meningkatkan
efisiensi dan mengurangi waktu pengembangan.
4. Pembacaan dan Pemeliharaan Kode:
Modul memudahkan pembacaan kode karena setiap modul dapat berfokus
pada tugas tertentu. Ini mempermudah pemeliharaan kode karena
perubahan atau penambahan fungsi hanya mempengaruhi modul terkait.
5. Pembagian Tugas Tim:
Dalam pengembangan perangkat lunak yang melibatkan tim, modul
memungkinkan pembagian tugas dengan lebih efektif. Setiap anggota tim
dapat bekerja pada modul tertentu tanpa harus khawatir tentang interaksi
yang kompleks dengan modul lainnya.
6. Abstraksi dan Pengenkapsulan:
Modul menyediakan tingkat abstraksi yang memungkinkan pengembang
untuk menyembunyikan detail implementasi dan hanya mengekspos
antarmuka yang relevan. Ini mendukung konsep pengenkapsulan.
7. Pengujian yang Lebih Mudah:
Modul yang terisolasi mempermudah pengujian unit. Setiap modul dapat
diuji secara independen sebelum diintegrasikan ke dalam sistem secara
keseluruhan.
8. Skalabilitas:
Modul memungkinkan pengembangan sistem yang lebih besar dan kompleks
dengan cara menambahkan atau mengganti modul tanpa harus mengubah
seluruh sistem.
9. Manajemen Proyek yang Lebih Baik:
Dalam proyek-proyek besar, modul membantu dalam manajemen proyek
dengan membagi tim ke dalam kelompok-kelompok yang bertanggung jawab
atas modul tertentu.
d. Revisi dokumen sesuai perubahan kode program dan lengkapi dokumen
sehingga memenuhi syarat teknis.
Jawab:
1. Periksa Perubahan Kode:
Pahami dengan baik perubahan apa yang telah dilakukan pada kode program.
Analisis dengan seksama perbedaan antara versi sebelumnya dan versi saat
ini.
2. Identifikasi Dokumen Terkait:
Tentukan dokumen yang perlu direvisi sebagai hasil dari perubahan kode. Ini
bisa mencakup dokumentasi teknis, panduan pengguna, atau dokumentasi
lainnya yang terkait.
3. Perbarui Deskripsi Fungsional:
Jika perubahan kode mempengaruhi fungsionalitas sistem atau modul,
perbarui deskripsi fungsional di dokumen agar mencerminkan perubahan
tersebut.
4. Perbarui Diagram dan Gambar:
Jika dokumen menggunakan diagram atau gambar untuk menjelaskan
arsitektur atau alur kerja sistem, pastikan untuk memperbarui elemen-
elemen tersebut agar sesuai dengan perubahan pada kode.
5. Perbarui Contoh Kode:
Jika dokumen mencakup contoh kode, pastikan untuk memperbarui contoh-
contoh tersebut agar sesuai dengan sintaks dan logika baru dari perubahan
kode.
6. Perbaiki Referensi dan Cross-References:
Jika dokumen merujuk ke bagian-bagian tertentu dari kode, pastikan bahwa
referensi dan cross-references tersebut tetap relevan dengan perubahan
yang telah dilakukan.
7. Revisi Log dan Riwayat Perubahan:
Tambahkan entri revisi baru ke log perubahan dan riwayat perubahan
dokumen. Ini membantu dalam melacak kapan perubahan dilakukan dan
oleh siapa.
8. Perbarui Metode Pengujian:
Jika perubahan kode mempengaruhi metode pengujian, perbarui bagian
pengujian di dokumen untuk mencerminkan perubahan tersebut.
9. Revisi Format dan Tata Letak:
Pastikan bahwa revisi dokumen tetap mematuhi format dan tata letak yang
telah ditetapkan. Hal ini melibatkan penyesuaian struktur dokumen dan
pemformatan teks.
10. Review dan Validasi:
Mintalah rekan pengembang atau pihak yang berkompeten untuk meninjau
revisi dokumen dan memastikan bahwa dokumen memenuhi syarat teknis
yang diperlukan.
1. Publikasikan dan Distribusikan:
Setelah revisi dokumen selesai dan telah melewati validasi, pastikan untuk
mempublikasikan dan mendistribusikannya ke pihak yang terkait.
3. Buatlah dokumentasi fungsi, prosedur atau method program
a. Buatlah dokumentasi fungsi, prosedur atau method yang memudahkan pihak lain
untuk membaca dokumentasi tersebut.
Jawab:
b. Menjelaskan kemungkinan eksepsi pada modul program.
Jawab:
c. Revisi dokumen sesuai perubahan kode program dan lengkapi dokumen
sehingga memenuhi syarat teknis.
Jawab:
4. Generate dokumentasi
a. Identifikasi tools untuk generate dokumentasi dan pastikan tools generate
dokumentasi dapat digunakan.
Jawab:
b. Lakukan generate dokumentasi dan berikan solusi apabila hasil
dokumentasi tidak berhasil digenerate.
Jawab: