Jenis Dokumentasi Perangkat Lunak

Daftar Isi:

Anonim

Jika Anda pernah melihat direktori komputer pada drive jaringan di perusahaan Anda yang bernama "dokumen perangkat lunak" atau "panduan perangkat lunak" dan kemudian melihat dokumen yang memiliki izin untuk dilihat, Anda mungkin menyadari jumlah dokumen dan jenis dokumen untuk perangkat lunak tersebut. banyak sekali. Tampaknya juga beberapa dokumen yang ditempatkan dalam satu kategori juga berlaku untuk kategori lain. Dokumen perangkat lunak digunakan pada setiap tahap siklus hidup perangkat lunak biasa, sehingga merupakan tempat yang baik untuk menyelidiki jenis dokumen yang dibuat.

Usul

Proposal perangkat lunak menentukan persyaratan sistem perangkat lunak dan menjelaskan tujuan perangkat lunak dan masalah yang diselesaikannya. Ini juga akan menentukan perkiraan waktu proyek perangkat lunak akan mengambil dan faktor-faktor lain yang mempengaruhi proposal.

Studi kelayakan

Studi kelayakan biasanya dilakukan pada awal proyek. Tahap ini menentukan apakah pabrik perangkat lunak memenuhi kebutuhan bisnis pelanggan. Hasil dari studi kelayakan memutuskan apakah suatu proyek akan berjalan atau tidak.

Analisa Kebutuhan

Analisis persyaratan menyediakan sarana untuk menerjemahkan persyaratan bisnis ke dalam solusi perangkat lunak otomatis. Konsultan eksternal atau manajemen perusahaan biasanya melakukan tugas ini. Persyaratan menerjemahkan persyaratan bisnis menjadi spesifikasi aktual untuk perangkat keras, perangkat lunak, dan komponen.

Dokumen desain

Dokumen desain memberikan dasar untuk pengembangan perangkat lunak untuk memulai pada tingkat teknis. Seperti namanya, sejumlah desain grafis dan tekstual untuk basis data, antarmuka, komunikasi, pengembangan web, dan aspek lain dari perangkat lunak akan dirancang sebelum pengkodean dapat dimulai.

Dokumen Pengkodean

Pengodean dokumen merujuk pada kode sumber aktual yang digunakan untuk pemrograman perangkat lunak. Kode dapat ditulis dalam sejumlah bahasa komputer yang tersedia, termasuk Java, C ++, PHP, dan ratusan bahasa komputer lainnya tergantung pada sistem yang digunakan.

Menguji Dokumen

Tim pengujian dan pengembang membuat dokumen pengujian pada berbagai tahap siklus hidup perangkat lunak. Pengembang membuat dokumen pengujian unit untuk kode mereka sendiri. Tim pengujian atau orang lain yang tidak terkait langsung dengan kode melakukan pengujian integrasi dan pengujian persyaratan bisnis.

Panduan Pengguna dan Pemasaran

Panduan pengguna memberikan instruksi tentang cara kerja perangkat lunak baru. Jika sistemnya besar dan kompleks, panduan pengguna biasanya didukung oleh kursus pelatihan formal untuk staf. Dokumen pemasaran menggambarkan manfaat dari sistem perangkat lunak baru untuk pelanggan potensial.

Lisensi Perangkat Lunak

Penerbitan lisensi perangkat lunak membuat perangkat lunak menggunakan legal sejauh menyangkut pengguna akhir. Pengguna menggunakan perangkat lunak berdasarkan ketentuan lisensi perangkat lunak yang dikeluarkan oleh perusahaan pembuat. Tidak semua perangkat lunak memiliki persyaratan lisensi yang ketat, dan ini terutama berlaku untuk open source. Secara umum, sistem perangkat lunak memiliki beberapa bentuk dokumen lisensi yang menentukan bagaimana dan di mana perangkat lunak dapat digunakan.