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
K1 INTERPRET SYSTEM DOCUMENTATION
STANDARD
REQUIREMENT
KANDUNGAN KSKV

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

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

TAJUK/TITLE :
SEDIA KEPERLUAN DOKUMENTASI SISTEM

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

1. Menerangkan keperluan dokumentasi sistem.

 Peraturan Perniagaan
 Functional Design Specification (FDS)
 Manual Pengguna
2. Mengenalpasti jenis dokumentasi sistem
 sampel System Requirement Spesification (SRS), dan Software Design
Documentation (SDD), User Requirement Specification (URS)
 Dokumentasi kod sumber, panduan penyelenggaraan
 Sampel User Acceptance Test, Dokumen Analisis Keperluan Sistem
 Muka surat : 2
NO KOD KPD4024 / KP(1/7)
Daripada : 11

PENERANGAN/INFORMATION :

1.1 Keperluan Dokumentasi Sistem (System Documentation Requirement)

 Dokumentasi adalah satu cara yang dilakukan untuk penyediaan dokumen-

dokumen dengan menggunakan bukti yang tepat dari pencatatan sumber-
sumber informasi khusus iaitu dari karangan/ tulisan, wasiat, buku, dokumen
undang-undang dan sebagainya.

 Dokumen keperluan menyediakan maklumat mengenai fungsi sistem. Secara

amnya, dokumen keperluan adalah pernyataan tentang apa yang perlu dilakukan
oleh sistem.

 Ia mengandungi

 Business Policy (Peraturan Perniagaan)

- Biasanya termasuk mengenai jenis niche perniagaan yang dijalankan, sumber

modal perniagaan dan bagaimana perniagaan syarikat yang menggunakan
sistem menjalankan tugas seharian yang berkaitan dengan sistem.

Rajah 1. Contoh Polisi Syarikat

 Muka surat : 3
NO KOD KPD4024 / KP(1/7)
Daripada : 11

 Spesifkasi Kefungsian Rekabentuk (FDS)

- Mengandungi fungsi-fungsi yang mengikut kehendak pengguna yang perlu

dipenuhi oleh pembangun sistem seperti keperluan Payment Gateway, warna
korporat sistem dan sebagainya. Rujuk contoh Lampiran 4024 FDS.

Rajah 2 . Contoh Kandungan Functional Design Document

 User Manual (Manual Pengguna)

- Mengandungi tatacara penggunaan sistem dan keperluan sistem yang perlu

diketahui oleh pengguna yang mana akan menjadi satu rujukan kemudian hari.
Rujuk contoh Lampiran 4024 Template User Manual
 Muka surat : 4
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 3 . Contoh Paparan User Manual pada halaman web

 Dokumen ini mestilah jelas dan difahami oleh pengguna. Setiap terma yang
digunakan mestilah dijelaskan di dalam glosari bagi mengelakkan berlakunya salah
faham di kalangan pengguna. Ia harus mengandungi maklumat cukup untuk
menggariskan tujuan produk, ciri, fungsi, dan kelakuannya.

 Menyediakan gambaran keseluruhan sistem dan membantu jurutera dan pihak

berkepentingan memahami teknologi yang mendasari.

 Ia biasanya terdiri daripada

 Dokumen keperluan SRS

- Mengandungi spesifikasi keperluan sistem termasuk perkakasan dan
perisian yang diperlukan bagi menjalankan sesuatu sistem dengan baik dan
berkesan selaras dengan tujuan pembinaannya. Rujuk rajah 4 Contoh SRS
 Muka surat : 5
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 4 . Contoh Dokumen System Requirement Specification

 Reka bentuk seni bina

- Rekabentuk seni bina yang digunakan dalam pembangunan sistem perlu
didokumenkan untuk memberi maklumat kepada orang yang
 Muka surat : 6
NO KOD KPD4024 / KP(1/7)
Daripada : 11

bertanggungjawab mengenai sistem dan memberi gambaran keseluruhan

sistem. – Storyboard & wireframes. Rujuk contoh Lampiran SDD

Rajah 5 . Contoh kandungan Software Design Document

 Dokumentasi Kod Sumber

- Dokumentasi Kod Sumber termasuklah Kod-kod sumber aturcara yang
terlibat semasa pembangunan sistem.
- Perlu menyenaraikan semua jenis bahasa pengaturcaraan yang digunakan
dalam pembangunan sesuatu sistem / perisian Contoh: HTML, PHP, CSS,
MySQL, Javascript & lain-lain bahasa pengaturcaraan yang terlibat.
 Muka surat : 7
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 6 . Contoh Kod Sumber dalam Pengaturcaraan Sistem E-Aduan

 Dokumen Pengesahan
- Antaranya adalah pengesahan User Requirements System atau System
Requirement Specifications yang telah disahkan oleh pengguna berkenaan
tujuan dan spesifikasi pembinaan sistem ini dijalankan.
 Muka surat : 8
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 7 . Contoh Dokumen User Requirement Specification

 Pengesahan Dan Maklumat Ujian

- Dokumen berkenaan ujian-ujian yang telah dijalankan terhadap sistem dan
juga dokumen yang mengandungi User Acceptance Test.
 Muka surat : 9
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 8 . Contoh Dokumen User Acceptance Test

 Panduan Penyelenggaraan
- Panduan penyelenggaraan sistem yang diberikan secara berkala sama ada
untuk tempoh waktu tertentu bagi memastikan sistem berjalan dengan baik dan
berkesan. – Laporan Penyeliaan & Penyelenggaraan Kemudahan

Rajah 9. Contoh Dokumen Borang Penyelenggaraan Kemudahan ICT

 Muka surat : 10
NO KOD KPD4024 / KP(1/7)
Daripada : 11

Rajah 10: Contoh Dokumen Analisis Keperluan Sistem

Kesimpulannya, keperluan dokumentasi sistem sangat penting kerana ia

memberikan gambaran keseluruhan tentang sesebuah sistem dari saat ia dikehendaki
oleh pengguna dan bagaimana pembangun sistem mengolah idea dan kehendak
pengguna dengan membina satu sistem yang baik dan berkesan kepada pengguna.

SOALAN/QUESTION :

1. Terangkan maksud dokumentasi.

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

2. Berikan kepentingan keperluan dokumentasi sistem kepada pembangun sistem

dan pengguna.
………………………………………………………………………………………………
………………………………………………………………………………………………
………………………………………………………………………………………………
 Muka surat : 11
NO KOD KPD4024 / KP(1/7)
Daripada : 11

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