Teknik Dokumentasi Aplikasi

Pengembangan Dokumentasi Aplikasi
Pengajar : Ayuningtyas, S.Kom.,M.MT.,- MOS

  

Dokumentasi Perencanaan Proyek

1.      Pengantar

·         Pendeskripsian masalah lingkungan

·         Tujuan Client, organisasi

·         Solusi dan ruang lingkup

Memastikan bahwa masalah-masalah yang ada dari perencanaan dan pelaksanaan dari sumber daya sudah diperkirakan sebelumnya.

2.      Proposal

·         Fungsi yang diberikan pada solusi yang diajukan serta strategi untuk pengembangan solusi tersebut.

·         Keuntungan serta kerugian solusi tersebut.

3.      Keterbatasan Sistem

·         Ketersediaan pada lingkungan pengguna.

·         Prioritas Customer.

4.      Estimasi

·         Budget atau biaya

·         Analisis resiko

·         Staff dan Organisasi

·         Perangkat lunak dan perangkas keras yang dibutuhkan.

5.      Procedures

·         Model-model proses

·         Standarisasi jaminan kualitas dan kendali poduk

·         Data pengujian dan sumber data

6.      References

·         Dokumentasi yang digunakan dalam pengembangan

·         Kamus istilah

·         Dokumentasi Spesifikasi Desain

1.      Pendahuluan

·         Garis besar permasalahan

·         Lingkungan aplikasi dan karakteristik pengguna

·         Tujuan Proyek

2.      Spesifikasi

·         Fungsi perangkat lunak dan teknik yang digunakan

·         Kinerja yang harus dicapai

·         Spesifikasi interaksi manusia dan mesin yang digunakan.

3.      Desain Arsitektur

·         Modul hirarki dan diagram interface

·         Deskripsi fungsi dan data.

4.      Desain secara detil

·         Dekomposisi modul

·         Deskripsi modul dan spesifikasi interface

·         Deskripsi proses dan struktur data

5.      Referensi

·         Dokumentasi yang digunakan untuk mengembangkan desain

·         Daftar terminology

·         Dokumentasi Pengembangan Sistem

1.      Defiisi Kebutuhan

2.      Spesifikasi

3.      Desain

4.      Implementasi dan pemilihan teknologi

5.      Pengujian (testing)

·         Dokumentasi Maintenance

       Dalam hal ini menjelaskan tata cara dalam perawatan dan pengelolaan sebuah sistem dengan baik.       Dengan cara :

·         Mantenance manual

·         Trouble shoting manual

·    Tingkat kerusakan yang ditulis biasanya hanya sampai pada level yang ringan dan tak perlu penaganan khusus.

·         Dokumentsai Source code

          Penamaan variable, constraint, procedure, function yang jelas dan konsisten. Dan member keterangan pada header setiap procedure, yang berisi :

·         Fungsi dan procedure

·         Variable local masukan dan keluaran.

Pada header program diberi :

·         Nama penulis program

·         Editor

·         Complier dan library yang digunakan

·         Tanggal pembuatan software

·         Deskripsi singkat tentang software

Pada setiap modul diberikan sebuah informasi diantaranya :

·         Nama Judul

·         Fungsi

·         Parameter interface dan modus

·         Prasyarat perangkat keras dan sistem operasi

·         dll

·         Dokumentasi Testing

·         Identifier

·         Spesifikasi kebutuhan

·         Rencana pengujian

·         Perangkat bantu dan program bantu yang digunakan

·         Data pebgujian dan intruksi pengujian

·         Hasil pengujian serta analisis.