SOFTWARE DOCUMENTATION

WHY DO YOU NEED Software Documents?

Untuk memberikan kemudahan dalam melakukan maintenance/tracking/troubleshooting dalam software Memberikan komunikasi yang koheren antara sesama tim pengembangdevelopment lebih efektif,efisien, on schedule Memberikan informasi ke manajemen tentang rencana dan biaya yang dibutuhkan dalam proses pengembangan software Sebagai standard kualitas User Dokumentasi: Memberikan informasi kepada pengguna cara menggunakan sistem Memberikan informasi kepada administrator cara mengelola sistem

2 TYPES OF DOCUMENTATION

Process Documentation
Mencatat proses dalam pengembangan dan maintenance.

Product Documentation
Mendeskripsikan produk yang sedang dikembangkan.

PROCESS DOCUMENTATION
Rencana, perkiraan dan jadwal biasa disebut sebagai PROJECT MANAGEMENT LIFE CYCLE, digunakan oleh manajemen untuk memprediksi dan mengarahkan proses software. Laporan berisi tentang sumberdaya yang digunakan dan kemajuan dari proses Standard atau SOP berisi bagaimana proses harus diimplementasikan (tahap demi tahap hirarki approval) Working papers berisi ide dan pikiran dari anggota tim (brainstorming atau pun meeting) Memos & email berisi tentang email dan memo berkaitan dengan pelaksanaan proses

PROJECT MANAGEMENT LIFE CYCLES

PROCESS DOCUMENTATION (CONTD)

Process Documentation berubah menyesuaikan dengan perkembangan project Process Documentation beberapa bersifat temporer digunakan sebagai catatan yang dapat digunakan untuk keperluan perencanaan, mengetahui proses eksternal yang ikut terlibat, mengetahui ide-ide yang berkembang.

PRODUCT DOCUMENTATION

Terdiri dari :
User Documentationcara menggunakan produk System Documentationmemberikan gambaran fungsi, struktur, relasi

data dan model software yang dikembangkan yang berguna untuk maintenance/upgrade, serta menjelaskan bagaimana system tersebut berkerja

Lebih bersifat permanen yang digunakan untuk maintenace maupun perbaikan dan upgrading.

USER DOCUMENTATION

Harus disusun untuk memenuhi kebutuhan setiap level user yang berbeda pengetahuan/peran. User documentation dibuat untuk:

System Evaluators or management Novice Users Experienced Users System Administrators

SYSTEM DEVELOPMENT LIFE CYCLE (SDLC)

SYSTEM DOCUMENTATION
Kebutuhan/masalah/latar belakang dan sistem/sesuatu yang berhubungan

:
Scope Definition dan Problem Analysis menghasilkan PROJECT CHARTER

DOCUMENT
Requirement Analysis menghasilkan SRS DOCUMENT System architecture menghasilkan SYSTEM ARCHITECTURE

DOCUMENT yang berisi :

Deskripsi tentang arsitektur sistem (decompotition modul) Deskripsi tentang arsitektur setiap program didalam sistem (logical model) Deskripsi tentang pemilihan teknologi

SYSTEM DOCUMENTATION (CONTD)

Deskripsi tentang fungsionalitas dan antar muka dalam setiap komponen sistem (alur proses,physical model (alur data), GUI) Source code terstruktur menghasilkan SOURCE CODE DOCUMENT Menjelaskan setiap blok kode dalam modul Menjelaskan relasi antar modul/fungsi Validation documents atau TESTING DOCUMENT yang menjelaskan

bagaimana setiap program yang dibuat sudah memenuhi kebutuhan,

didalamnya juga terdapat testing plan

SYSTEM DOCUMENTATION (CONTD)

System maintenance guide berupa MAINTENANCE DOCUMENT Deskripsi tentang ketergantungan antara hardware dan software (KONFIGURASI) Deskripsi tentang bagaimana mengenali MASALAH dalam sistem Deskripsi bagaimana melakukan pencatatan SYSTEM PERFORMANCE secara auto maupun manual Deskripsi bagaimana melakukan BACK UP, dan TUNING Deskripsi mengenai perbaikan-perbaikan terhadap versi yang lama

MAINTAIN QUALITY DOCUMENTATION

DOCUMENT QUALITY penting untuk menjaga KEBERLANGSUNGAN

sistem.Untuk itu dokumentasi :

Harus JELAS bagaimana cara menggunakan sistem tersebut Harus mudah untuk dapat dipahami dan diikuti Harus selalu terbaharui Ketika sistem dalam dalam MAINTENANCE terkadang lupa untuk

membuat PEMBAHARUAN dokumentasi

TIDAK HARUS orang yang MENGEMBANGKAN aplikasi yang MEMBUAT PEMBAHARUAN aplikasi

MINIMAL STRUCTURING GUIDELINES

Cover page dengan identifikasi data berupa: judul, no dokumen, nama project, tim pengembang, tanggal pelaksanaan project, status dokumen (revision number if exist), peruntukan dokumen, sifat kerahasiaan, dll. Dokumen yang terdiri lebih dari beberapa halaman sebaiknya dipecah menjadi Bab dengan sub bab. Gunakan tabel of content untuk memudahkan struktur. Gunakan index untuk item yang membutuhkan referensi detil. Buat glossary yang ditujukan untuk pengguna yang berbeda latar belakang keilmuan.
[2] From the IEEE Standard 1063-2001 Software User Documentation

TYPES OF DOCUMENT STANDARDS

Process standards mendefinisikan bagaimana proses membuat dokumen dengan kualitas yang baik Product standards mendefinisikan bagaimana bentuk seharusnya, bagaimana dokumen harus di maintain, apa yang harus disertakan dalam dokumen. Interchange standards berisi bagaimana melakukan editing terhadap dokumen jika ingin maintain, dan format standard yang digunakan dalam perubahan dokumen.

DOCUMENT WILL BE PROVIDED

PROCESS DOCUMENTATION
PROJECT MANAGEMENT DOCUMENT (TIME, COST, SCOPE, RESOURCE) PROGRESS REPORT DOCUMENT SOP PROJECT DEVELOPMENT DOCUMENT MEETING, BRAINSTORMING, EMAIL, FORUM

PRODUCT DOCUMENTATION
USER DOCUMENTATION

SYSTEM EVALUATORS OR MANAGEMENT NOVICE USERS EXPERIENCED USERS SYSTEM ADMINISTRATORS

SYSTEM DOCUMENTATION (SDLC)

PROJECT CHARTER DOCUMENT SRS DOCUMENT SAD DOCUMENT SOURCE CODE DOCUMENT TESTING DOCUMENT MAINTENANCE DOCUMENT

STANDARD DOCUMENTATION
PROCESS STANDARD PRODUCT STANDARD INTERCHANGE STANDARD

TIPS: IMPLEMENT GOOD TECHNICAL WRITING TECHNIQUES

Gunakan grammar yang baik Ejaan harus benar Hindari verbosity baiknya gunakan point atau bullet Hindari ambiguitas

TIPS: IMPLEMENT GOOD TECHNICAL WRITING TECHNIQUES (CONTD)

Ulangi ide-ide yang complex, jelaskan dengan cara lebih dari satu,

dimungkinkan untuk memberikan dari sisi yang yang lain Ketika ada referensi, jangan hanya mereferensi pada no saja. Sebaiknya gunakan sedikit deskripsi dari referensi tersebut
Do NOT say: Refer to section 1.2. Instead, say: Refer to section 1.2, which describes the interface functional design.

Questions ?