Resume Kuliah Teknik Dokumentasi Aplikasi - Pertemuan 1

Matakuliah  : Teknik Dokumentasi Aplikasi

Dosen          : Ayuningtyas, S.Kom.,M.MT.,- MOS

NIM              : 09.39010.0043

Nama           : Ayu Paramita  

SOFTWARE CRISIS

Software crisis adalah sekumpulan masalah yang ditemukan dalam pengembangan software computer. Masalahnya tidak hanya terbatas pada software yang tidak berfungsi sebagaimana mestinya, tetapi krisis software ini terdiri dari masalah yang berhubungan dengan :

1. Bagaimana mengembangkan software
2. Bagaimana memelihara software ynag ada, yang berkembang dalam jumlah besar 
3. Bagaimana mengimbangi permintaan software yang makin besar.

Masalah:

Krisis software oleh beberapa masalah :

1. Estimasi jadwal dan biaya yang seringkali tidak tepat 
2. Produktivitas orang-orang software yang tidak dapat mengimbangi permintaan software 
3. Kualitas software yang kurang baik.

Penyebab :

Masalah yang berhubungan dengan krisis software disebabkan oleh :

1. Karakteristik software itu sendiri
   Karakteristik software adalah software yang bersifat logika dibandingkan fisik, oleh karena itu mengukur software harus merupakan suatu kesatuan, tidak seperti hardware. Software yang bersifat tidak aus ini menyebabkan kesalahan yang terjadi pada software. Umumnya terjadi pada tahap pengembangan. Manajer tingkat menengah dan tingkat atas yang tidak mempunyai latar belakang software, seringkali diberi tanggung jawab untuk mengembangkan software. Padahal tidak semua manajer itu dapat me-manage semua proyek.
   Praktisnya : software programmer atau software engineering mendapatkan latihan formal yang sedikit dalam hal tehnik baru pengembangan software.
2. Kegagalan mereka yang bertanggung jawab dalam pengembangan software.

APLIKASI

• Suatu subkelas perangkat lunak komputer
• Yang memanfaatkan kemampuan komputer langsung untuk melakukan suatu tugas yang diinginkan penguna 
• Biasanya dibandingkan dengan perangkat lunak sistem yang mengintegrasikan berbagai kemampuan komputer, tapi tidak secara langsung menerapkan kemampuan tersebut untuk mengerjakan suatu tugas yang menguntungkan pengguna 
• Contoh : pengolah kata, lembar kerja, dan pemutar media. 

DOKUMENTASI
 

Dokumentasi adalah Segala sesuatu yang tertulis, bergambar dan terekam yang berisikan penjelasan mengenai suatu hal atau informasi dari suatu peristiwa yang digunakan untuk membantu ingatan dan/atau dapat dijadikan pedoman.

Contoh Arsip:

•  Formulir
• Kartu Tanda Penduduk (KTP)
• Surat Ijin Mengemudi (SIM)
• Buku catatan pelajaran 
• Slip gaji
• Akte kelahiran
• Ijazah 
• Buku pelajaran 
•  Surat Tanda Nomor Kendaraan (STNK)
• dan lain sebagainya. 

Mengapa beberapa contoh tersebut dapat dikatakan sebagai arsip ?

• Karena beberapa contoh yang telah disebutkan memiliki fungsi mengingatkan tentang suatu hal 
• Buku catatan pelajaran contohnya, dapat digunakan untuk mengingat kembali bahan pelajaran yang pernah didapat sehingga nantinya dapat dibaca kembali saat akan menghadapi ujian.

DOKUMENTASI APLIKASI

Dokumentasi ini meliputi

•  Perencanaan (SDP=Software Development Plan) è ketika fase perencanaan 
• Requirements Analysis (SRS=Software Requirements Specification 
• IRS=Interface Requirements Specification 
• Dokumentasi Perancangan (SDD=Software Design Document) 
• Dokumentasi Pengujian (STP=Software Test Plan, STRp=Software Test Report) 
• Dokumentasi yang berhubungan dengan produk (SUM=Software User Manual, SPS=Software Product Specification, VDD=Version Description Document) 
• Dokumen lainnya

Doxygen merupakan softare pendukung perangkat lunak untuk memberikan dokumentasi pada kode2 komentar Source code.Pada Doxygen mendukung PHP,java,C,C++ dan lain-lain
  
    /**************************
     * Programmer Php Prowebpro
     * Created By Author Proweb
     * Class Untuk Menunjukan sifat alami hewan
     */
    class sifat{
        /*
         * @constructor Sifat  
         * @params Void
         */
        function sifat(){
        }
        /* Mendapatkan sifat
         *
         *  
         */
        function mendapatkan_sifat(){
        }
    }

Keperluan Dokumentasi pada suatu Proyek Pengembangan Sistem:

• Pendefinisian 
• Perencanaan
• Organisasi
• Pengawasan
• Penyelesaian
• Leading

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.

• What, menjelaskan prosedur apa yang digambarkan dalam sebuah dokumentasi 
• Who, menjelaskan siapa saja pihak yang terkait dalam sebuah prosedur aktivitas 
• Where, menjelaskan dimana prosedur atau rangkaian aktivitas dilaksanakan
•  When, menjelaskan kapan sebuah aktivitas dalam sebuah prosedur dilakukan 
• Why, menjelaskan rasionalitas mengapa sebuah aktivitas dilakukan 
• How, menjelaskan logika bagaimana sebuah prosedur berjalan.

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 Intranet, 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).

Di samping itu SOW ini akan membantu menentukan tanggung jawab sekuriti pada tingkat tinggi, perawatan dokumentasi, perangkat lunak, data, perangkat keras, dan pengelolaan sistem. Dengan kata lain akan mendefinisikan siapa yang berperan sebagai web-masters, document-master, dan document-owners. SOW juga mencegah permasalahan yang timbul di tahapan berikutnya dari pengembangan sistem.

2. Perencananaan

SOW menjabarkan biaya secara kasar, penjadwalan, kualitas, dan sumberdaya manusia pada suatu proyek. Dengan informasi ini perencanaan dilakukan dengan berdasarkan pada informasi ini. Perencanaan sebagai langkah berikutnya meliputi 6 tahapan yang dapat dilaksanakan secara berurutan ataupun paralel :

• Menyusun Work Breakdown Structure (WBS)

• Mengestimasi waktu pelaksanaan proyek

• Mengalokasikan sumber daya

• Menghitung pembiayaan

• Menyusun jadwal kerja

• Pengelolaan resiko

Menyusun WBS 

Pada dasarnya WBS merupakan suatu daftar yang bersifat top down dan secara hirarkis menerangkan komponen komponen yang harus dibangung, dan pekerjaan yang berkaitan dengannya. Sebagai contoh pada tabel di bawah ini

Nomor Pekerjaan	Pekerjaan
1.0	Home Page
1.1	Penentuan isi
1.2	Penentuan format dan layout
1.3	Penyusunan homepage
2.4	Sekuriti
2.5	Otentikasi
2.6	Pembatasan akses
2.7	Firewall
2.8	Event Logging
2.9	Enkripsi
2.10	Kebijaksanaan
3.11	Monitoring
3.12	Reporting (pelaporan)
3.1.1	Baseline dan trend analysis
3.2	Metrics
3.2.1	Penentuan metoda untuk menghitung waktu koneksi
3.2.2	Penentuakn metoda untuk menghitung throughput rate
3.2.3	Penentuan metoda untuk menghitung waktu respon
4.3.1	Perangkat keras
4.3.1.1	Penentuan kebutuhan perangkat keras client
4.3.1.2	Pemilihan perangkat keras client
4.3.1.3	Instalasi perangkat keras client
4.3.2	Perangkat lunak
4.3.2.3	Instalasi perangkat lunak
4.3.2.1.4	Instalasi FTP
4.3.2.1.5	Instalasi email
4.3.2.1.6	Instalasi telnet
4.3.2.1.7	Instalasi browser
4.3.2.1.8	Instalasi sistem operasi ^ A
4.3.2.9	Konfigurasi perangkat lunak
4.4	Server
4.5	Perangkat keras Server
4.1.6	Penentuan kebutuhan perangkat keras server
4.1.7	Pemilihan perangkat keras server
4.1.8	Instalasi perangkat keras server
4.9	Perangkat lunak
4.2.10	Directory listing - struktur
4.2.11	Platform
4.2.12	IP addres, URL dan nama domain
4.13	Client

Model WBS memberikan beberapa keuntungan

• Memberikan daftar pekerjaan yang harus diselesaikan 
• Memberikan dasar untuk mengestimasi, mengalokasikan sumber daya, menyusun jadwal, dan menghitung biaya 
• Mendorong untuk mempertimbangkan secara lebih serius sebelum membangun suatu proyek Intranet.

Mengestimasi waktu pelaksanaan proyek 

Dengan memanfaatkan daftar pekerjaan pada WBS, dapat dilakukan pekerjaan memperkirakan waktu yang dibutuhkan untuk menyelesaikan setiap pekerajaan tersebut. Perkiraan dilakukan dengan beberapa pertimbangan : ketersediaan sumber daya dan kompleksitas. Kemudian dijabarkan dalam kalendar atau ow time. Biasanya optimasi dilakukan secara:

• most optimistic - Waktu ideal untuk menyelesaikan pekerjaan, diasumsikan segala sesuatunya berjalan lancar, dan sempurna. 
• most likely - Waktu yang dibutuhkan pada kondisi kebanyakan, tipikal dan normal. 
• most pessimistic - Waktu yang dibutuhkan ketika keadaan paling sulit terjadi.

Estimasi waktu dilakukan dan dibagi dalam unit (misal 8 jam hari). Estimasi waktu untuk suatu proyek Intranet lebih sulit dari proyek pengembangan aplikasi lainnya. Hal ini karena masih sedikit proyek yang dapat digunakan sebagai patokan menghitung waktu pelaksanaan. Dalam mengestimasi waktu ini juga harus dipertimbangkan beberapa hal, misal pengalaman teknologi server yang digunakan, keahlian Perl, CGI, Java dan HTML, browser, dan juga bekerja dalam lingkungan TCP/IP.

Penentuan resiko

Prioritas penting ditentukan pada seetiap proyek, termasuk juga pada proyek Intranet. Sebab seperti halnya Internet ada beberapa permasalahan sekuriti (seperti akses tanpa hak), dan karena adanya banyak komponen pembentuk sistem (misal browser dan server) yang terlibat, resiko dapat menjadi tinggi. Penentuan resiko akan membantu melakukan identifikasi resiko yang dihadapi setiap komponen. Dengan informasi ini seorang manajer proyek dapat menentukan tingkat kepentingan setiap tugas dan menentukan estimasi waktu untuk itu. Manajer proyek dapat berkonsentrasi pada waktu dan sumber daya pada elemen yang terkritis dari penjadwalan.

Menyusun jadwal kerja

Pada dasarnya ada dua jenis model deskripsi penjadwalan :

• Bar Chart, yang hanya menerangkan ow time dari setiap pekerjaan dan tanpa keterkaitan antar pekerjaan. Deskripsi ini paling baik digunakan pada presentasi 
• 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

Mengalokasikan sumber daya

Pada dasarnya harus dilakukan pengimbangan waktu setiap pekerjan dan ketersedian dan kemampuan sumber daya. Harus ditentukan level load dari sumber daya, agar tak ada personal yang bekerja terlalu berat, dan ada yan terlalu ringan. Pada proyek Intranet hal ini sulit, karena tidak tersedianya sumberdaya manusia yang memiliki keahlian tersebut, oleh sebab itu harus disusun jadwal yang realistis. Dan bahkan mungkin dilakukan revisi penjadwalan.

Menghitung pembiayaan

Yang menjadi permasalahan, apakah biaya yang akan dikeluarkan sesua dengan SOW. Jika sesuai, maka pekerjaan perencanaan selesai, bila tidaak 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.

3. Organisasi

Proses ini adalah proses yang melibatkan penyusunan suatu infrastruktur yang akan memaksimalkan efisiensi dan efektifitas ketika melaksanakan proyek. Yang harus dipertimbangkan adalah :

• Struktur team

• Dokumentasi

• Pertemuan

Struktur team    

Ditentukan dengan menjelaskan:

• Penjelasan peranan 
• Tanggung jawab 
• Hubungan pelaporan

SOW sebaiknya menyediakan dasar untuk menjelaskan peranan utama, tanggung jawab, dan hubungan pelaporan. Informasi ini membantu untuk mepersiapkan struktur team, seperti untuk menghasilkan :

• Diagram organisasi 
• Matriks tanggung jawab.

Dokumentasi

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

Pertemuan 

Terdiri dari 3 jenis :

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

Pihak yang menghadiri pertemuan ini dapat bervariasi, tapi miimal pihak pengguna harus ada yang diundang. Ini menyebabkan mereka tidak saja merasa terlibat tetapi juga memperoleh informasi mengenai sekuriti, hak akses, dan kandungan dokumen. Hal ini akan mendorong dapat diselesaikannya proyek ini. 

4. Pengawasan 

Proses ini menjamin bahwa proyek Intranet efektif pembiayaanya, dan sesuai dengan

yang direncanakan. Proses ini terdiri dari :

• Status collection 
• Change control 
• Corrective action

Status collection and Assesment

Proses ini akan mengumplulkan data tentang penyelesaian suatu pekerjaan atau pencapaian suatu milestone. Kemudian membuat penilaian mengenai perkembangan yang dilakukan. Proses ini memiliki sisi bisnis dan teknsi. Sisi teknis melibatkan penilaian kualitas pekerjaan yang dilakukan misal bagaimana HTML dan CGI yang disusun. Pada sisi bisnis meliputi pada tingkatan mana pekerjaan itu dilakukan berdasarkan waku tertentu.

Change control

Proses ini melibatkan pekerjaan mengevaluasi pelaksanaan teknis dan jadwal. Dalam pelaksanaan membutuhkan jawaban akan pertanyaan seperti :

• Apakah sebenarnya perubahan yang terjadi (misal arsitektur jaringan). 
• Apa dampaknya bagi finansial, jadwal, dan kualitas sistem. 
• Bagaimana penanganan perubahan tersebut, misal terhadap user dan komunitas sistem informasi. 
• Bilamana perubahan tersebut akan menyebabkan suatu efek, misal setelah intranet terpasang dan berjalan.

Corrective action

Langkah ini melakukan revisi pendekatan yang dilakukan untuk pencapai tujuan proyek sesuai dengan SOW dan perencanaan. Langkah ini 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. 

5. Penyelesaian proyek

Pada proses ini terlibat melakukan pengumpulan dan analisi data dan melakukan transisi yang baik dari proses pengembangan ke implementasi. Keluaran utama dari proses ini adalah hal yang dipelajari selama pelaksanaan proyek - lesson learned document . Dokumen ini mengidentifikasi apa yang dilakukan dengan baik, dan apa yang tak berhasil dilakukan. Hal itu berdasarkan data yang dikoleksi mengenaik unjuk kerja proyek melalui kumpulan hasil statistik, wawancara, dan review setelah implementasi. Dokumen ini berguna bagi organisasi besar yang mungkin akan melakukan pemasangan site Intranet yang berjumlah banyak. Pengalaman yang diperoleh dari proyek pertama ini akan memberikan pandangan bagi manajer proyek untuk proyek mendatang.

Suatu hal yang penting lagi adalah bagaimana hasil dari proyek ini. 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. Oleh karena itu, sebaiknya bila seorang anggota team telah melakukan suatu tugas berat, sebaiknya segera dibebas tugaskan bila memang telah tidak ada pekerjaannya lagi. Ini menyebabkan personal tersebut dapat bertugas di proyek Intranet yang lainnya lagi. 

6. Leading

Tahapan ini penting sekali hanya akan terjadi bila ke lima proses sebelumnya dilakukan dengan benar. Pada tahapan ini dibutuhkan pembentukan suatu lingkungan kerja yang mendorong pihak yang terlibat, sehingga dapat tercapainya tujuan. Untuk mencapai hal tersebut, manajer proyek haruslah :

1. Membuat visi yang jelas bagi proyek 
2. Berkomunikasi dengan efektif 
3. Menjaga motivasi yang tinggi 
4. Menjaga fokus dari visi 
5. Menyediakan lingkungan yang mendukung 
6. Mendorong penyusunan team.

Bebeberapa langkah tersebut sulit dilaksanakan karena biasanya manajer proyek tidak terlalu memiliki kendali dalam penggunaan sumber daya. Hal ini menjadi lebih rumit untuk proyek intranet yang melibatkan banyak pihak orang dengan keahlian terbatas, orientasi fungsi yang tak jelas. Web master dan document owner, bukanlah nama pekerjaan yang unik tapi juga membutuhkan keahlian khusus.

Suatu proyek akan dapat dilakukan dengan baik bila telah dilakukan proses enginering yang baik. Ini berlaku baik untuk pengembangan program dengan produk jadi, atau dengan kontraktor atau juga dengan team sendiri. Akan lebih baik menghabiskan waktu lebih lama untuk melakukan disain dan penataan awal yang baik, daripada terburu-buru melakukan implementasi. Sehingga sudah sewajarnya dilakukan standardisasi, dan penggunaan dokumentasi yang baik. Biasanya suatu team pengembang sistem informasi cenderung untuk meninggalkan metodologi standard dengan alasan keterbatasan waktu. Rapid Application Development (RAD) bukanlah merupakan suatu alasan untuk tidak menggunakan teknik-teknik disain yang baik.