Anda di halaman 1dari 24

TUGAS TEKNIK DOKUMENTASI

MAKALAH MATERI

Disusun Oleh :
Arief Rakhmad Wicaksono
MI-2B
1331140058

MANAJEMEN INFORMATIKA
TEKNOLOGI INFORMASI
POLITEKNIK NEGERI MALANG
2015

DAFTAR ISI
DAFTAR ISI..............................................................................................2
BAB 1 KEBUTUHAN DOKUMENTASI................................................................3
1.1

Dokumentasi Proyek...........................................................................3

1.2

Langkah-Langkah Pendokumentasian Proyek...............................................4

1.2.1

Pendefinisian..............................................................................4

1.2.2

Perencanaan...............................................................................5

1.2.3

Organisasi.................................................................................6

1.2.4

Pengawasan...............................................................................7

1.2.5

Penyelesaian...............................................................................8

1.2.6

Leading....................................................................................8

BAB II DOKUMENTASI PERANCANGAN SISTEM..............................................10


2.1

Tujuan.........................................................................................10

2.2

Pendahuluan..................................................................................10

2.3

Aktifitas Perencanaan Pengembangan Software...........................................10

2.4

Dokumentasi yang biasa digunakan.........................................................11

2.4.1

Project Plan..............................................................................11

2.4.2

Spesifikasi Desain.......................................................................13

BAB III MODEL DOKUMENTASI PERANCANGAN SISTEM...................................15


3.1

Tujuan.........................................................................................15

3.2

Contoh dokumentasi perancangan sistem..................................................15

3.3.1

Kebutuhan pengguna...................................................................15

3.3.2

Spesifikasi................................................................................16

3.3.3

Desain....................................................................................18

3.3.4

Implementasi dan pemilihan teknologi................................................19

3.3.5

Pengujian................................................................................19

BAB I
KEBUTUHAN DOKUMENTASI
1.1 Dokumentasi Proyek
Dokumentasi sebuah proyek adalah suatu dokumentasi yang berisi kebutuhan user yang
akan diimplementasikan dalam bentuk spesifikasi dan instruksi. Keuntungan dari membuat
dokumentasi proyek adalah sebagai berikut :
-

Mengetahui dampak teknologi dan bisnis


Menghitung estimasi biaya sesungguhnya
Menentukan tingkat usaha
Mencapai suatu penyelesaian yang paling efektif biayanya.
Memilih perangkat bantu dan teknik terbaik

Kualitas proses biasanya melibatkan elemen berikut ini :


Metodologi : Suatu cara, metoda, untuk mencapai tujuan. Suatu metodolog berlaku
secara umum, dengan perencanaan tingkat tinggi, dan digunakan sebagai landasan
setiap proyek.
Dokumentasi : Dokumen khusus, yang pada awal proyek akan menerangkan secara
garis besar yang akan dilengkapi pada setiap proyek yang dilaksanakan.
Standard : Panduan yang disusun dan digunakan pada suatu institusi untuk

menyelesaikan suatu pekerjaan. Contoh standard ini adalah :


o Kesepakatan penamaan untuk berbagai macam kode,
o Kesepakatan layar GUI,
o kesepakatan data modelling.
Standard ini penting karena merupakan landasan:
o sebagai kerangka kerja,
o Sarana komunikasi.
o Juga untuk mengontrol kualitas serta menjaga kontinuitas pengembangan.

1.2 Langkah-Langkah Pendokumentasian Proyek


1.2.1

Pendefinisian
Dengan mendefinisikan proyek dengan tetap, diharapkan proyek dapat mulai dan

diakhiri dengan biaya yang paling efektif. Termasuk menjawab : who, what, when,
where, why and how dari pelaksanaan proyek tersebut. Perangkat bantu untuk
melaksanakan tugas ini disebut dengan Statement of the Works (SOW).
SOW adalah kesepakatan antar client dan developer. Dokumen ini ditulis berdasarkan
perspektif bisnis dan teknis yang berisi topik-topik berikut ini :

Pengantar (misal informasi latar belakang)


Tujuan dan obyektif (misal cost, jadwal, dan kualitas)
Scope (misal, aplikasi HTML atau VRML)
Assumsi (misal kemampuan penanganan peningkatan traffic jaringan)
User
Sumber daya (misal spesialis jaringan, programmer)
Milestone untuk penjadwalan (misal waktu akhir testing)
Pembiayaan (biaya langsung dan overhead)
Amandement (definisi ulang dari penyerahan pekerjaan)
Tanda tangan (manajemen senior dan komunitas pengguna)
SOW memberikan keuntungan ketika digunakan untuk memulai suatu proyek. Yaitu :

Menjelaskan biaya dan jadwal juga asumsi utama tentang proyek


Menjelaskan peranan dan tanggung jawab.
Mengukuhkan definisi hal yang akan dicapai proyek Intranet tersebut.
Mendorong diselesaikannya proyek tersebut, karena adanya kesepakatan tertulis
dalam dokumen tersebut (tanda tangan).

1.2.2

Perencanaan
SOW menjabarkan biaya secara kasar, penjadwalan, kualitas, dan sumberdaya

manusia pada suatu proyek. Perencanaan sebagai langkah berikutnya meliputi 6 tahapan
yang dapat dilaksanakan secara berurutan ataupun paralel. 6 langkah tersebut adalah:
Menyusun Work Breakdown Structure (WBS)
o Daftar pekerjaan yang harus diselesaikan
o Dasar estimasi, alokasi sumber daya, menyusun jadwal, dan menghitung biaya
o Mempertimbangkan secara serius sebelum membangun suatu proyek.

Mengestimasi waktu pelaksanaan proyek


o Most optimistic : Waktu ideal untuk menyelesaikan pekerjaan, diasumsikan
segala sesuatunya berjalan lancar, dan sempurna.
o Most likely : Waktu yang dibutuhkan pada kondisi kebanyakan, tipikal dan
normal.
o Most pessimistic : Waktu yang dibutuhkan ketika keadaan paling sulit terjadi.
Mengalokasikan sumber daya
Pengimbangan waktu setiap pekerjaan, ketersediaan, dan kemampuan sumber daya.
Harus ditentukan level load dari sumber daya, agar tak ada personal yang bekerja
terlalu berat, dan ada yang terlalu ringan.
Menghitung pembiayaan
Apakah biaya yang akan dikeluarkan sesuai dengan SOW?
Jika sesuai, maka pekerjaan perencanaan selesai, bila tidak harus dilakukan revisi.
Bila memang sulit harus dilakukan negosiasi dengan pihak pemberi kerja. Ketika
melakukan perhitungan biaya perlu dipertimbangkan beberapa biaya tersembunyi,
misal training, dokumentasi.
Menyusun jadwal kerja
Dibagi menjadi 2,yaitu :
o Bar Chart, yang hanya menerangkan show time dari setiap pekerjaan dan tanpa
keterkaitan antar pekerjaan. Deskripsi ini paling baik digunakan pada presentasi
o Network Diagram, yang menenjukkan keterkaitan antar tugas dan
mengidentifikasi saat kritis pada jadwal.
Suatu network diagram, merupakan cara terbaik untuk merencanakan
secara detail, dan mengikuti perkembangan proyek. Diagram ini akan
menghubungkan pekerjaan terkait, dan waktu mulai dan berakhirnya dari
pekerjaan tersebut. Mengidentifikasi keterkaitan pekerjaan pada proyek Intranet
adalah sangat penting sebab komponen-komponen tersebut saling terkait agar
dapat bekerja sesuai dengan fungsinya.
Pengelolaan resiko
Manajer proyek dapat menentukan tingkat kepentingan setiap tugas. Manajer
proyek dapat berkonsentrasi pada waktu dan sumber daya pada elemen yang
terkritis dari penjadwalan.

1.2.3

Organisasi
Adalah proses penyusunan suatu infrastruktur yang akan memaksimalkan efisiensi dan

efektifitas ketika melaksanakan proyek. Yang harus dipertimbangkan adalah :

Struktur team
Ditentukan dengan menjelaskan
o Penjelasan peranan
o Tanggung jawab
o Hubungan pelaporan
SOW sebaiknya menyediakan dasar untuk menjelaskan ke-3 hal diatas. Informasi
ini membantu untuk mepersiapkan struktur team, seperti untuk menghasilkan :

o Diagram organisasi
o Matriks tanggung jawab
Dokumentasi
o Dokumentasi adalah penting sekali, sebab user memiliki peranan penting dalam
membuat dan merawat kandungan web site.
o Diagram arsitektur, perangkat bantu mapping, dan manual on line merupakan
perangkat bantu dokumentasi teknis.
o Dokumentasi bisnis seperti laporan status, dan jadwal juga penting.
o Dokumentasi baik teknis maupun bisnis, harus disimpan dalam perpustakaan yang
dapat diakses untuk referensi mendatang.

Pertemuan
Terdiri dari 3 jenis :
o Status review meeting, dilakukan secara regular untuk mengumpulkan informasi
mengenai kondisi dari pekerjaan individu.
o Checkpoint review meeting, dilakukan untuk mencapai milestone besar, seperti
mensetup server.
o Staff meeting, dilakukan untuk bertukar informasi dan bertukar pengalaman bagi
seluruh pihak yang terlibat

1.2.4

Pengawasan
Proses ini menjamin bahwa proyek Intranet efektif pembiayaanya, dan sesuai dengan
yang direncanakan. Proses ini terdiri dari :

Status Collection : Mengumpulkan data tentang penyelesaian suatu pekerjaan,


Kemudian membuat penilaian mengenai perkembangan yang dilakukan.
o Sisi Teknis : Penilaian kualitas pekerjaan yang dilakukan.
o Sisi bisnis : Pada tingkatan mana pekerjaan itu dilakukan berdasarkan waku tertentu.

Change Control : Pekerjaan mengevaluasi pelaksanaan teknis dan jadwal.


o Apakah sebenarnya perubahan yang terjadi (misal arsitektur jaringan).
o Apa dampaknya bagi finansial, jadwal, dan kualitas sistem.
o Bagaimana penanganan perubahan tersebut.
o Bilamana perubahan tersebut akan menyebabkan suatu efek.
Corrective Action : Melakukan revisi pendekatan untuk pencapaian tujuan proyek sesuai
dengan SOW dan perencanaan. Berkaitan sekali dengan langkah status collection and
assesment, sebab langkah yang dibutuhkan misal perencanaan ulang, bergantung apakah
corrective action ini perlu dilakukan secara besar atau cukup sedikit saja.

1.2.5

Penyelesaian
Pengumpulan dan analisis data
Mengidentifikasi dengan baik
Berdasarkan seluruh data dalam proyek
Menurunnya produktifitas.
Berdasarkan data yang dikoleksi mengenai unjuk kerja proyek melalui kumpulan hasil

statistik, wawancara, dan review setelah implementasi.


- Tendensi apakah yang terjadi di antara personal yang terlibat pada pengembangan
proyek pada saat mendekati akhir proyek.
- Bila suatu proyek akan selesai biasanya anggota team menjadi menurun
produktifitasnya.

1.2.6 Leading
Tahapan ini penting sekali hanya akan terjadi bila ke lima proses sebelumnya dilakukan
dengan bernar.
Pada tahapan ini dibutuhkan pembentukan suatu lingkungan kerja yang mendorong
pihak yang terlibat, sehingga dapat tercapainya tujuan.
Untuk mencapai hal tersebut, manajer proyek haruslah :
o Membuat visi yang jelas bagi proyek
o Berkomunikasi dengan efektif
o Menjaga motivasi yang tinggi
o Menjaga fokus dari visi
o Menyediakan lingkungan yang mendukung
o Mendorong penyusunan team.
Suatu proyek akan dapat dilakukan dengan baik bila telah dilakukan proses

engineering yang baik.


Ini berlaku baik untuk pengembangan program dengan produk jadi, atau dengan

kontraktor atau juga dengan team sendiri.


Lebih baik menghabiskan waktu lebih lama untuk melakukan disain dan penataan awal
yang baik, daripada terburu-buru melakukan implementasi.

BAB II
DOKUMENTASI PERANCANGAN SISTEM
2.1

Tujuan
Mengetahui bagaimana mendokumentasikan perancangan sistem
Mengetahui aktivitas pembuatan dokumentasi perancangan sistem
Mengetahui macam-macam dokumentasi perancangan sistem

2.2

Pendahuluan
Untuk proyek software yang besar, biasanya dokumentasi dilaksanakan sebelum
proses pengembangan dimulai.
Proposal untuk mengembangkan sistem dapat dibuat sebagai respon terhadap
permintaan untuk tender oleh klien eksternal atau untuk merespon dokumen strategi
bisnis lainnya.

2.3

Aktifitas Perencanaan Pengembangan Software


Memilih suatu model untuk proses pengembangan
Mengontrak dan menyusun tim pembuat software
Membeli atau menyewa perangkat keras/lunak yang dibutuhkan
Memilih produk berpotensi berdasarkan pengalaman keorganisasian, sumber
daya, dan tujuan.
Mengevaluasi informasi pasar mengenai viablitas produk
Mengestimasi biaya, jadwal, tersiko dan harga dari produk
Memilih bentuk laporan dan cara pengukuran perkembangan proyek
Memilih notasi untuk spesifikasi dan perancangan
Memilih bahasa pemrograman

Meletakkan standar untuk dokumentasi, coding, verifikasi dan pengujian


Memilih mekanisme pengaturan konfigurasi
Menyiapkan bahan dan personil untuk instalasi

2.4

Dokumentasi yang biasa digunakan


2.4.1

Project Plan
Pengantar
o Deskripsi permasalahan
o Deskripsi lingkungan masalah

Proposal
o Fungsi yang diberikan pada solusi yang diajukan
o Strategi umum untuk mengembangkan solusi
Keterbatasan sistem
o Prioritas kustomer
o Profil pengguna
o Usia pengharapan dari produk
o Pra-syarat keandalan (reliabilitas)
o Pra-syarat kinerja
o Lingkungan perangkat keras dan antar muka yang telah ada
Estimasi
o Jadwal
o Staf dan organisasi
o Budget
o Analisis resiko

Prosedur
o Model proses
o Metodologi dan notasi
o Standardisasi dan jaminan kualitas
o Accountability monitoring
o Kendali produk
o Data pengujian dan sumber data
o Kriteria akseptansi dan metoda pembayaran
Refferensi
o Dokumentasi yang digunakan dalam pengembangan
o Kamus istilah
o Kontrak yang diusulkan (jika ada)
2.4.2

Spesifikasi Desain
Suatu dokumen spesifikasi desain terdiri dari :
Pendahuluan
o Garis besar permasalahan
o Lingkungan aplikasi dan karakteristik pengguna
o Notasi yang digunakan dalam desain
o Tujuan proyek
Spesifikasi desain
o Fungsi perangkat lunak
o Teknik yang digunakan untuk menyelesaikan masalah ini terutama ketika
desainer tidak memiliki pengetahuan khusus
o Kinerja yang harus dicapai
Desain arsitektur
o Spesifikasi real time
o Spesifikasi interakasi manusia dan mesin yang digunakan.
o Batasan
o Modifikasi dan perawatan yang diprediksi
o Modul hirarki dan diagram interface
Spesifikasi detail setiap modul
o Deskripsi modul dan spesifikasi interface

o
o
o
o
o

Deskripsi proses
Definisi struktur data
Pra-syarat inisialisasi
Spesifikasi penanganan eksepsi
Alternatif desain, untuk tiap desain yang ditolak disertakan keterangan alasan

penolakan serta kondisi yang menyebabkan desain yang terpilih.


Refferensi
o Referensi
o Dokumentasi yang digunakan untuk mengembangkan desain.
o Daftar terminologi

BAB III
MODEL DOKUMENTASI PERANCANGAN SISTEM
3.1

Tujuan
Mengetahui contoh model dokumentasi perancangan sistem
Mengetahui tahapan pembuatan dokumentasi perancangan sistem

3.2.1

Kebutuhan pengguna

Definisi kebutuhan pengguna


Mendefinisikan kebutuhan dan hal-hal yang berkaitan dengan kebutuhan sistem
secara menyeluruh. Faktanya, dokumen ini harus disetujui oleh pemberi kerja dan
pelaksana kerja.
Bagian yang dibahas dalam dokumen ini adalah :
Purposeful requirement.
Menjelaskan mengapa kebutuhan itu perlu dipenuhi
Functional requirement.
Apakah fungsi sebenarnya yang dibutuhkan oleh user dari sistem ini.
Nonfunctional requirement.
Kebutuhan sistem yang tidak berkaitan dengan fungsinya yang melibatkan

seperti, bisa dimodifikasi, testing, dan portabilitas


User Profile.
Menerangkan tentang pengguna dari sistem ini, terutama yang berkaitan

dengan tingkat pengenalan terhadap teknologi yang akan diterapkan.


Analisis kebutuhan
Requirement Prioritisation.
Menjabarkan kebutuhan mana yang terpenting dari kebutuhan-kebutuhan

yang timbul untuk sistem yang akan dibuat tersebut.


Constraint and Risk Analysis.
Memahami halangan dan resiko yang ada untuk mengimplementasikan

model dan mengaplikasikan sistem ini.


Trade-off analysis.
Mengetahui hal-hal yang saling bertentangan dalam perancangan,

pengimplementasian serta pengaplikasian dari solusi.


Model kebutuhan
Bagian ini menyusun model kebutuhan tersebut menjadi suatu bentuk model
kebutuhan.

Disusun atas :

Hierarchical (functional) model dari prioritas,

risk functional ,

non-functional requirement dan

Suatu prototype yang interactive.

Functional model

Exploratory prototype

Requirement trace

The conceptual model


3.2.2

Spesifikasi
Spesifikasi siklus operasi sistem, Dalam bagian ini dijelaskan siklus penggunaan
sistem ini. Tujuan untuk mendapatkan spesifikasi teknis terutama akan berguna
pada bagian implementasi. Sistem fault tolerant 24 jam akan berbeda dengan
sistem yang beroperasi 1 jam sehari. Begitu juga siklus kerja sistem, atau langkah
kerja satu demi satu dispesifikasikan.
Spesifikasi fungsional,

Essential Capabilities
Dijabarkan fungsi utama dari sistem. Ini merupakan fungsi minimal yang
harus dipenuhi oleh sistem yang dibuat.

Additional Capabilites
Dideskripsikan fungsi tambahan yang timbul karena dipenuhi dan
digunakan sistem ini.

Future Capabilities
Menjelaskan fungsi pada masa datang dari sistem ini. Penjelasan ini erat
kaitannya dengan marketing strategy, technological dan Sales.

Komponen sistem

Software ,

hardware,

User, dan

Organisasi penunjang.

Spesifikasi kinerja.
Menjelaskan performansi / unjuk kerja yang ingin dicapai serta kemungkinan
keterbatasan di dalam penggunaan sistem. Setiap kebutuhan diusahakan
dispesifikasikan dengan jelas, termasuk karakteristik elektris dan fisis.

Characteristics and Constraints


Merupakan karakteristik tiap komponen pendukung sistem, termasuk
karakteristik fisis, elektris, maupun karakteristik perangkat lunak (misal; user
friendly dan interaktif). Juga dijabarkan keterbatasan di dalam penggunaan
sistem

Physical characteristics
Merupakan penjelasan bentuk luar dari sistem secara keseluruhan, misal;
ukuran berat dan lain-lain.

Environmental characteristics
Lingkungan tempat kerja dari sistem ini

Human Factors
Pengaruh manusia di dalam operasi sistem, baik sebagai penentu operasi,
misal dalam decision making system atau supervised control system.

Juga pengaruh manusia dalam menimbulkan ketidak-akuratan atau kesalahan


sistem.

3.2.3

Desain

Diagram blok

Menggambar blok diagram sistem secara keseluruhan dan interface antara kedua bagian
tersebut. Blok diagram terdiri dari 2 bagian, yaitu dunia di luar sistem dan di dalam
sistem.
Flow of Control
Menerangkan kondisi-kondisi yang mungkin dari sistem serta transisi dari satu kondisi ke
kondisi lainnya.
Representation of Data Flow
Menggambarkan aliran data serta transformasi yang dialami data tersebut dalam sistem
Decomposition into Functions
Membagi-bagi fungsi secara keseluruhan menjadi sub sistem dengan sub fungsinya.
Dapat digunakan Tree Diagram.
Relationship among Function
Dijelaskan hubungan antar sub sistem dengan kaitannya terhadap subfungsinya.
Module Spesification
Menggambarkan spesifikasi dari modul sistem.
Dalam memilih diagram untuk mendesain sistem perlu diperhatikan beberapa poin :
Suatu alat bantu untuk berfikir secara jelas
Mudah dimengerti
Sebagai alat bantu untuk komunikasi dengan end-user

3.2.4

Implementasi dan pemilihan teknologi

Menjelaskan metode dan peralatan yang digunakan untuk mengimplementasikan solusi


yang telah diajukan dalam bagian desain.
Menjelaskan alasan pemilihan teknologi yang digunakan.
Sebelum dilakukan pemilihan teknologi atau level alat yang digunakan maka harus
dilakukan estimasi terhadap beberapa hal :

Estimasi waktu untuk mengembangkan sistem

Estimasi panjangnya program

Estimasi kebutuhan memori

Estimasi kecepatan eksekusi

Juga harus dipertimbangkan pembagian antara software dan hardware


3.2.5

Pengujian

Bagian ini menunjukkan kerja dari sistem baik untuk masukan yang bersifat normal,
ataupun untuk masukan yang di luar ambang normal.
Setiap pengujian dilakukan dokumentasi sebagai bukti otentik kemampuan sistem.
Pada dasarnya, dilakukan testing berikut ini :
Recovery testing
Untuk mengetahui kemampuan sistem, untuk mengembalikan ke kondisi normal setelah
suatu masukan atau kondisi di luar dari yang dispesifikasikan.
Stress testing
Untuk mengetahui kemampuan sistem dalam menangani beban kerja yang berat, sangat
baik untuk mengetahui kemampuan maksimal dari sistem.
Security testing
Untuk mengetahui jenis-jenis aplikasi yang berkaitan dengan keamanan sistem, baik dari
pengguna yang melakukan kesalahan secara sengaja ataupun tidak sengaja.
Dalam melakukan uji coba dapat digunakan beberapa metodologi, diantaranya:
Use-Case
White Box
Black Box

Loop testing
Pada dasarnya suatu testing akan melakukan :
Verifikasi : Menjamin bahwa sistem benar-benar bekerja sesuai fungsinya.
Validasi : Menjamin bahwa sistem benar-benar memenuhi keinginan pemakai.

BAB IV
DOKUMENTASI

BAB V
KUALITAS DOKUMEN
Struktur Dokumen
Standar Dokumen
Proses
Produk
Pertukaran
Gaya Penulisan
Dokumentasi Online

BAB VI & VII


Document 1
7.1 Kelas Dokumentasi
7.1.1 Dokumentasi Proses
Dokumen-dokumen ini merekam proses pembangunan dan pemeliharaan. Rencana,
jadwal, dokumen kualitas proses dan standar organisasi dan proyek yang proses dokumentasi.
Dokumentasi proses dibagi ke dalam beberapa kategori:
1. Rencana, perkiraan dan jadwal. Ini adalah dokumen yang dihasilkan oleh manajer
yang digunakan untuk memprediksi dan mengontrol proses software.
2. Laporan, Ini adalah dokumen yang melaporkan bagaimana sumber daya digunakan
selama proses pembangunan.
3. Standar, Ini adalah dokumen yang menetapkan bagaimana proses yang harus
dilaksanakan. Ini dapat dikembangkan dari standar organisasi, nasional atau
internasional
4. Kertas kerja. Ini sering dokumen komunikasi teknis utama dalam proyek. Mereka
mencatat ide dan pemikiran dari para insinyur yang bekerja pada proyek, adalah versi
interim dokumentasi produk, menjelaskan strategi pelaksanaan dan mengatur
masalah-masalah yang telah diidentifikasi. Mereka sering, secara implisit, merekam
alasan untuk keputusan desain.
5. Memo dan pesan surat elektronik. Ini mencatat rincian komunikasi sehari-hari antara
manajer dan insinyur pengembangan
7.1.2 Dokumentasi Produk
Dokumentasi ini menjelaskan produk yang sedang maju. Dokumentasi sistem
menggambarkan produk dari sudut pandang para insinyur mengembangkan dan
mempertahankan sistem dokumentasi pengguna menyediakan produk deskripsi yang berorientasi
pada pengguna sistem.
Dokumentasi Pengguna
1. Akhir-pengguna menggunakan perangkat lunak untuk membantu dengan
beberapa tugas. Hal ini dapat menerbangkan pesawat terbang, mengelola
kebijakan asuransi, menulis buku, dll Mereka ingin tahu bagaimana
perangkat lunak dapat membantu mereka. Mereka tidak tertarik pada
komputer atau administrasi rincian.

2. Sistem administrator bertanggung jawab untuk mengelola perangkat


lunak yang digunakan oleh pengguna akhir. Ini mungkin melibatkan
bertindak sebagai operator jika sistem adalah sistem mainframe besar,
sebagai manajer jaringan sistem melibatkan jaringan workstation atau
sebagai guru teknis yang perbaikan masalah-pengguna akhir perangkat
lunak dan yang bekerja, dan ketika antara pengguna dan pemasok
perangkat lunak.
Different types of user documentation

7.2 Fungsi Deskripsi


Deskripsi fungsional dari sistem menguraikan persyaratan sistem dan secara
ringkas menjelaskan layanan yang disediakan. Dokumen ini harus memberikan
gambaran tentang sistem. Pengguna harus dapat membaca dokumen ini dengan
panduan pengantar dan memutuskan apakah sistem ini apa yang mereka butuhkan

7.3 Sistem Instalasi


Dokumen sistem instalasi ditujukan untuk administrator sistem. Ini harus
memberikan rincian tentang bagaimana untuk menginstal sistem di lingkungan
tertentu.
Ini harus berisi deskripsi dari file yang membentuk sistem dan konfigurasi hardware
minimal yang diperlukan.
7.4 Sistem Referensi
Referensi sistem manual harus menjelaskan fasilitas sistem dan
penggunaannya, harus memberikan daftar lengkap pesan kesalahan dan harus
menjelaskan bagaimana memulihkan dari kesalahan terdeteksi.
7.5 Panduan Sistem Administration

Panduan Sebuah sistem administrator yang lebih umum harus disediakan


untuk
beberapa
jenis
sistem
seperti
komando
dan
kontrol
sistem.
Ini harus menggambarkan pesan yang dihasilkan ketika sistem berinteraksi dengan
sistem
lain
dan
bagaimana
bereaksi
terhadap
pesan-pesan
ini.
Jika perangkat keras sistem yang terlibat, mungkin juga menjelaskan tugas operator
dalam menjaga hardware yang. Sebagai contoh, mungkin menjelaskan bagaimana
untuk membersihkan kesalahan dalam sistem konsol, bagaimana menghubungkan
peripheral baru, dll

BAB IX
Kualitas Dokumen
9.1 Pedoman Struktur Dokumen
1. Semua dokumen harus memiliki halaman cover yang mengidentifikasikan proyek, nama
dan jenis dokumen, pengarang, tanggal pembuatan dokumen, informasi penjaminan
kualitas, peruntukan dokumen dan tingkat kerahasiaan dokumen.
2. Dokumen yang lebih dari beberapa halaman, harus dibagi menjadi bab-bab dan sub bab.
Memiliki daftar isi, menggunakan penomoran bab dan sub bab yang konsisten. Setiap bab
memiliki penomoran halaman terpisah, sehingga memudahkan apabila ada perubahan di
salah satu bab saja, tidak perlu melakukan perubahan nomor halaman di keseluruhan
dokumen.
3. Apabila dokumen memiliki banyak penjelasan detil, informasi referensi harus diberi
index.
4. Apabila dokumen diperuntukkan pembaca yang memungkinkan pengetahuannya
berbeda, glossary perlu ditambahkan untuk menjelaskan istilah-istilah teknis dan akronim
yang digunakan di dokumen
9.2 Standart Dokumen
1. Standar dokumen merupakan dasar untuk melakukan penjaminan kualitas suatu
dokumen.
2. Dokumen yang dibuat berdasarkan standar yang benar akan memiliki tampilan, struktur
dan kualitas yang konsisten. Standart dokumentasi yang di gunakan pada proses
dokumentasi :
Standar proses Mendefinisikan proses yang harus diikuti untuk menghasilkan
dokumen yang berkualitas tinggi. Standar produk Standar yang mengatur dokumen itu
sendiri.Standar pertukaran / interchange standards. Standar pertukaran menjaga agar
setiap dokumen dapat kompatibel.

9.3 Standart Proses


1. Standar proses mengatur pendekatan / metode yang harus dilakukan dalam membuat
suatu dokumen.
2. Menentukan software / tools yg digunakan menulis dokumen dan prosedur penjaminan
kualitas yang dapat dilakukan untuk mengukur kualitas dokumen yang dihasilkan.
3. Standar penjaminan kualitas dokumen harus fleksibel dan mencakup semua tipe
dokumen.
4. Dalam beberapa kasus memang tidak perlu diterapkan standar penjaminan kualitas
dokumen, seperti pada dokumen lembar kerja atau memo.
9.4 Standart Produk
Standar Produk berlaku untuk semua dokumen yang diproduksi oleh pengembang software.
Beberapa standar yang seharusnya diperhatikan :
1. Standar Identifikasi Dokumen
2. Standar struktur dokumen
3. Standar presentasi Dokumen
4. Standar update Dokumen
9.5 Gaya Panduan Penulisan
1. Penggunaan kalimat aktif
2. Penggunaan tata bahasa dan ejaan yang tepat
3. Kurangi kalimat-kalimat yang panjang
4. Kurangi paragraf yang panjang
5. Tidak bertele-tele
6. Gunakan dan definisikan istilah secara tepat
7. Ulangi penjelasan untuk hal yang rumit dengan bahasan yang berbeda
8. Gunakan judul bab dan sub bab
9. Menggunakan bullets/items dibanding penjelasan dengan kalimat
10. Tidak mereferensikan informasi hanya dengan nomer referensi saja

Anda mungkin juga menyukai