BAHAGIAN PENDIDIKAN DAN LATIHAN TEKNIKAL

VOKASIONAL
KEMENTERIAN PENDIDIKAN MALAYSIA
ARAS 5 & 6, BLOK E14, KOMPLEKS E,
PUSAT PENTADBIRAN KERAJAAN PERSEKUTUAN

KERTAS PENERANGAN
(INFORMATION SHEET)
KOD DAN NAMA
IT-010-3:2013 PEMBANGUNAN APLIKASI
PROGRAM NOSS
TAHAP NOSS 3

KOD, NAMA CU DAN WA CU06/WA1- INTERPRET SYSTEM DOCUMENTATION

NOSS REQUIREMENT

KOD DAN NAMA TEKNOLOGI SISTEM PENGURUSAN PANGKALAN DATA

PROGRAM KV DAN APLIKASI WEB

KOD DAN NAMA KPD 4024 APPLICATION SYSTEM DOCUMENTATION

KURSUS KSKV COMPILATION

NO DAN TAJUK
STANDARD K1 INTERPRET SYSTEM DOCUMENTATION
REQUIREMENT
KANDUNGAN KSKV

NO. KOD NOSS IT-010-3:2016-C06/ P(3/7)

Muka Surat : 1 Drp : 10
NO. KOD KSKV KPD4024 / KP(3/7)

TAJUK/TITLE :
KENAL PASTI JENIS DOKUMENTASI SISTEM

TUJUAN/OBJECTIVE:
Di akhir sesi pembelajaran, pelajar akan dapat:

1. Menyenaraikan jenis-jenis dokumentasi sistem.

• Data Flow Diagram (DFD)
• Entity Relation Diagram (ERD)
• End User License Agreement (EULA)
2. Memahami dan menerangkan tentang sampel manual pengguna.
3. Memahami dan menerangkan tentang sampel manual kod sumber.
4. Merujuk kepada Company’s Policy And Guideline untuk mengaplikasi dokumentasi
sistem.
 Muka surat : 2
NO KOD KPD4024 / KP(3/7)
Daripada : 10

PENERANGAN/INFORMATION :

1.1 Jenis Dokumentasi Sistem (Types Of System Documentation)

a) Data Flow Diagram (DFD)

➢ DFD merupakan perwakilan grafik "aliran" data melalui sistem maklumat.

➢ DFD digunakan untuk menggambarkan pemprosesan data (reka bentuk berstruktur).

Ia melihat sistem sebagai fungsi yang mengubah input ke output yang diingini.
Berbeza dengan carta alir kerana carta alir menunjukkan aliran kawalan tetapi DFD
menunjukkan aliran data.

Simbol-simbol:

Rajah 1. Simbol DFD

Rajah 2. Contoh tahap pertama – Admin Side DFD bagi sistem membeli belah atas talian
 Muka surat : 3
NO KOD KPD4024 / KP(3/7)
Daripada : 10

b) Entity Relation Diagram

➢ Gambar rajah entiti (ERD) menunjukkan hubungan set entiti yang disimpan dalam
pangkalan data. Entiti dalam konteks ini adalah komponen data.

➢ Dengan kata lain, rajah ERD menggambarkan struktur logik pangkalan data. Sekilas
pandang, gambar rajah entiti kelihatan seperti carta aliran. Ia adalah simbol khusus, dan
makna simbol-simbol tersebut yang menjadikannya unik.

Simbol-simbol:

Rajah 3. Simbol dan keterangan ERD

Rajah 4. Contoh ERD –Sistem pesanan pizza atas talian

 Muka surat : 4
NO KOD KPD4024 / KP(3/7)
Daripada : 10

c) End User License Agreement (EULA)

➢ Perjanjian Lesen Pengguna Akhir (EULA) adalah kontrak undang-undang antara

pengarang atau penerbit aplikasi perisian dan pengguna aplikasi itu. EULA yang
sering disebut sebagai "lesen perisian" adalah serupa dengan perjanjian sewa. Pengguna
bersetuju untuk membayar keistimewaan untuk menggunakan perisian.
➢ EULA menjanjikan pengarang atau penerbit perisian untuk mematuhi semua sekatan
yang dinyatakan dalam EULA.

Rajah 5. Contoh EULA perisian NetBeans IDE

2.1 Contoh Panduan Pengguna (Sample Of User Manual)

➢ User manual atau panduan pengguna juga dikenali sebagai manual. Ianya adalah dokumen
komunikasi teknikal yang bertujuan untuk memberi bantuan kepada pengguna sistem.
➢ Panduan pengguna ditulis oleh pengaturcara, pengurus produk atau projek, atau kakitangan
teknikal lain, terutama dalam syarikat yang lebih kecil.
➢ Panduan pengguna paling sering dikaitkan dengan barangan elektronik, perkakasan dan
perisian komputer.
➢ Panduan pengguna yang biasa digunapakai oleh pengguna di luar sana adalah seperti
panduan menggunakan mesin basuh, televisyen dan lain-lain lagi. Bagaimanapun, panduan
pengguna dalam konteks sistem lebih menjurus kepada bagaimana menggunakan sesebuah
sistem yang dibangunkan.
➢ Kebanyakan panduan pengguna mengandungi kedua-dua panduan bertulis dan imej yang
berkaitan. Dalam kes aplikasi komputer, panduan pengguna mengandungi imej tangkapan
skrin (screenshot) antara muka manusia-mesin, dan manual perkakasan yang menggunakan
gambarajah yang jelas dan mudah.
 Muka surat : 5
NO KOD KPD4024 / KP(3/7)
Daripada : 10

Rajah 6. Contoh panduan pengguna Central Userid Management System dari UTM

Rajah 7. Contoh isi kandungan panduan pengguna Central Userid Management System dari UTM
 Muka surat : 6
NO KOD KPD4024 / KP(3/7)
Daripada : 10

Rajah 8. Contoh user manual bagi Frog VLE

3.1 Contoh Panduan Kod Sumber (Sample Of Source Code Manual)

➢ Panduan kod sumber atau dokumentasi kod sumber yang boleh dipercayai menjadi rujukan
bagi seseorang pengaturcara dalam menjejaki semua aspek aplikasi dan ia meningkatkan
kualiti produk perisian.
➢ Dokumentasi kod sumber membolehkan anda memindahkan idea tentang sebab
sesetengah kod dituliskan. Dengan memberi komen kepada kod dapat menjelaskan
“mengapa”, dan bukan bagaimana.
➢ Terdapat perisian dapat digunakan untuk mendokumentasi kod sumber supaya dijadikan
panduan kepada pengatur cara yang lain, iaitu Doxygen, NDoc, Visual
Expert, Javadoc, EiffelStudio, Sandcastle, ROBODoc, POD, TwinText, atau Universal Report.
➢ Kandungan dokumen kod sumber adalah seperti berikut (tetapi tidak terhad kepada butir-butir
berikut):
• Kerangka (framework) generasi HTML dan kerangka lain yang digunakan
• Jenis pengikatan data
 Muka surat : 7
NO KOD KPD4024 / KP(3/7)
Daripada : 10

• Corak reka bentuk dengan contoh (cth: Model-view-controller)

• Langkah-langkah keselamatan
• Corak dan prinsip lain

Rajah 9. Contoh source code manual - mendokumentasi source code yang sedia ada dengan
menggunakan komen gaya DOXYGEN pada perisian IDE CLION

Rajah 10. Contoh source code manual - mendokumentasi maklumat tentang URI Structure and Methods
daripada kod sumber yang sedia ada

4.1 Fungsi dasar dan garis panduan syarikat (Company’s policy and guideline)

➢ Dasar dan garis panduan syarikat menetapkan peraturan diguna pakai dalam organisasi,
menggariskan tanggungjawab kedua-dua pekerja dan majikan.
➢ Dasar dan garis panduan syarikat sedia ada diwujudkan untuk melindungi hak pekerja serta
kepentingan perniagaan majikan. Bergantung pada keperluan organisasi, pelbagai dasar
dan garis panduan mewujudkan peraturan mengenai kelakuan pekerja, kehadiran, kod
pakaian, privasi dan bidang lain yang berkaitan dengan terma dan syarat pekerjaan.
➢ Setiap syarikat yang menggunakan komputer, e-mel, internet, dan perisian setiap hari perlu
mempunyai dasar teknologi maklumat.
 Muka surat : 8
NO KOD KPD4024 / KP(3/7)
Daripada : 10

➢ Adalah penting bagi pekerja untuk mengetahui apa yang diharapkan dan dikehendaki oleh
pihak syarikat apabila menggunakan teknologi yang disediakan oleh majikan mereka, dan
adalah penting bagi syarikat untuk melindungi dirinya sendiri dengan mempunyai dasar untuk
mengawal bidang seperti internet peribadi dan penggunaan e-mel, keselamatan, inventori
perisian dan perkakasan dan pengekalan data.
➢ Ia juga penting bagi pemilik perniagaan untuk mengetahui potensi kehilangan masa dan
produktiviti dalam perniagaan mereka atas sebab penggunaan internet peribadi.

Rajah 11: Dasar dan garis panduan syarikat tentang penggunaan e-mel dalam syarikat
 Muka surat : 9
NO KOD KPD4024 / KP(3/7)
Daripada : 10

SOALAN/QUESTION :

1. Senaraikan TIGA jenis dokumentasi sistem.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

2. Terangkan apakah yang dimaksudkan dengan EULA.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

3. Terangkan maksud user manual.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

4. Berikan TIGA contoh panduan pengguna yang biasa dipakai oleh pengguna
………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

5. Terangkan kepentingan dokumentasi kod sumber.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

6. Senaraikan 3 perisian yang membolehkan dokumentasi kod sumber dibuat.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

7. Terangkan fungsi dasar dan garis panduan syarikat.

………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………
 Muka surat : 10
NO KOD KPD4024 / KP(3/7)
Daripada : 10

8. Apakah kesan yang berlaku sekiranya syarikat tidak mempunyai dasar dan garis
panduan yang jelas.
………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………

RUJUKAN/REFERENCE
1. 10 Tools for the Perfect Code Documentation. (2016, August 15). Retrieved from
http://blog.liveedu.tv/code-documentation-tools/
2. Noel Ceta.(n.d).All You Nedd to Know About UML Diagrams: Types and 5+ Examples.
Retrieved from https://tallyfy.com/uml-diagram/
3. UML Diagrams Example.(n.d).Retrieved from https://www.uml-diagrams.org/index-
examples.html
4. Anastasia Kazakova. (2016, May 18).Keep your code documented. Retrieved from
https://blog.jetbrains.com/clion/2016/05/keep-your-code-documented/
5. Freeproject. (2017, April 24). Online Shopping System Dataflow Diagram. Retrieved
from https://www.freeprojectz.com/dfd/online-shopping-system-dataflow-diagram
6. Building better documentation.(n.d). Retrieved from
https://www.atlassian.com/software/confluence/documentation
7. Wikipedia The Free Encyclopedia.(n.d).Software documentation.Retrieved from
https://en.wikipedia.org/wiki/Software_documentation
8. Technical Documentation in Software Development: Types, Best Practices, and Tools.
(2019, March 26). Retrieved from https://www.altexsoft.com/blog/business/software-
documentation-types-and-best-practices/
9. Sherrie Scott. (2019, February 5). Examples of Company Policies & Procedures.
Retrieved from http://smallbusiness.chron.com/examples-company-policies-
procedures-10995.html
10. Corporate Computer Services, Inc.(n.d). Retrieved from
http://www.corpcomputerservices.com/articles/it-policies-small-business