Cara Membuat Dokumentasi Perangkat Lunak

Unduh PDF
Unduh PDF

Dokumentasi perangkat lunak yang baik, baik berupa dokumentasi spesifikasi bagi pemrogram dan penguji, dokumen teknis untuk pengguna internal, atau manual dan berkas pertolongan untuk pengguna akhir, akan membantu pengguna memahami fitur dan fungsi perangkat lunak. Dokumentasi yang baik adalah dokumentasi yang spesifik, jelas, dan relevan, dengan seluruh informasi yang diperlukan pengguna. Artikel ini akan memandu Anda untuk menulis dokumentasi perangkat lunak bagi pengguna teknis dan pengguna akhir.

Metode 1
Metode 1 dari 2:

Menulis Dokumentasi Perangkat Lunak untuk Pengguna Teknis

Unduh PDF
  1. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/5\/57\/Write-Software-Documentation-Step-1.jpg\/v4-460px-Write-Software-Documentation-Step-1.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/5\/57\/Write-Software-Documentation-Step-1.jpg\/v4-728px-Write-Software-Documentation-Step-1.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Dokumen spesifikasi digunakan sebagai manual referensi bagi perancang antarmuka, pemrogram yang menulis kode, dan penguji yang memverifikasi kinerja perangkat lunak. Informasi yang perlu disertakan akan bergantung pada program yang tengah dibuat, tetapi mungkin menyertakan beberapa hal berikut:
    • Berkas penting dalam aplikasi, seperti berkas yang dibuat tim pengembang, basis data yang diakses saat program beroperasi, dan aplikasi pihak ketiga.
    • Fungsi dan subrutin, termasuk penjelasan kegunaan fungsi/subrutin, nilai masukan, dan keluaran.
    • Variabel dan konstanta program, dan bagaimana seluruh variabel/konstanta tersebut digunakan.
    • Struktur program secara keseluruhan. Untuk program berbasis kandar, Anda mungkin perlu menjelaskan masing-masing modul serta pustaka. Atau, jika Anda menulis manual untuk program berbasis web, Anda mungkin perlu menjelaskan berkas mana yang digunakan oleh setiap halaman.
  2. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/6\/6f\/Write-Software-Documentation-Step-2.jpg\/v4-460px-Write-Software-Documentation-Step-2.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/6f\/Write-Software-Documentation-Step-2.jpg\/v4-728px-Write-Software-Documentation-Step-2.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Semakin banyak dokumentasi teknis yang tercantum dalam kode program, akan semakin mudah pula dokumentasi tersebut diperbarui dan dirawat, juga digunakan untuk menjelaskan berbagai versi program yang berbeda. Secara minimal, dokumentasi pada kode program harus menyertakan kegunaan fungsi, subrutin, variabel, dan konstanta.
    • Jika kode sumber Anda panjang, Anda dapat menulis dokumentasi dalam berkas pertolongan, yang kemudian dapat diindeks atau dicari dengan kata kunci tertentu. Berkas dokumentasi terpisah akan berguna jika logika program terpecah dalam beberapa halaman dan menyertakan berkas dukungan, seperti aplikasi web.
    • Beberapa bahasa pemrograman (seperti Java, Visual Basic.NET, atau C#) memiliki standar dokumentasi kode tersendiri. Dalam kasus tersebut, ikuti standar dokumentasi yang harus disertakan dalam kode sumber.
  3. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/8\/85\/Write-Software-Documentation-Step-3.jpg\/v4-460px-Write-Software-Documentation-Step-3.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/8\/85\/Write-Software-Documentation-Step-3.jpg\/v4-728px-Write-Software-Documentation-Step-3.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Dalam beberapa kasus, alat dokumentasi ditentukan dari bahasa program yang digunakan. Bahasa C++, C#, Visual Basic, Java, PHP, dan lain-lain memiliki alat dokumentasi tersendiri. Namun, jika tidak, alat yang digunakan akan bergantung pada dokumentasi yang diperlukan.
    • Pengolah kata seperti Microsoft Word cocok digunakan untuk membuat berkas teks dokumentasi, selama dokumentasi tersebut ringkas dan sederhana. Untuk membuat dokumentasi panjang dengan teks yang kompleks, kebanyakan penulis teknis memilih alat dokumetasi khusus, seperti Adobe FrameMaker.
    • Berkas pertolongan untuk mendokumentasikan kode sumber dapat dibuat dengan program pembuat berkas dukungan, seperti RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare, atau HelpLogix.
    Iklan
Metode 2
Metode 2 dari 2:

Menulis Dokumentasi Perangkat Lunak untuk Pengguna Akhir

Unduh PDF
  1. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/8\/85\/Write-Software-Documentation-Step-4.jpg\/v4-460px-Write-Software-Documentation-Step-4.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/8\/85\/Write-Software-Documentation-Step-4.jpg\/v4-728px-Write-Software-Documentation-Step-4.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Meskipun alasan utama dokumentasi perangkat lunak adalah untuk membantu pengguna memahami cara penggunaan aplikasi, ada beberapa alasan lain yang mungkin mendasari pembuatan dokumentasi, seperti membantu bagian pemasaran menjual aplikasi, meningkatkan citra perusahaan, dan mengurangi biaya dukungan teknis. Dalam beberapa kasus, dokumentasi diperlukan untuk memenuhi regulasi atau aturan hukum lainnya.
    • Namun, dokumentasi bukanlah pengganti antarmuka yang baik. Jika suatu aplikasi memerlukan banyak dokumentasi untuk dapat dioperasikan, sebaiknya aplikasi tersebut dirancang agar lebih intuitif.
  2. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/3\/35\/Write-Software-Documentation-Step-5.jpg\/v4-460px-Write-Software-Documentation-Step-5.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/3\/35\/Write-Software-Documentation-Step-5.jpg\/v4-728px-Write-Software-Documentation-Step-5.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Umumnya, pengguna perangkat lunak memiliki pengetahuan komputer yang terbatas di luar aplikasi yang digunakan oleh mereka. Ada beberapa cara untuk memenuhi kebutuhan dokumentasi mereka:
    • Perhatikan jabatan pengguna perangkat lunak. Misalnya, administrator sistem umumnya memahami berbagai aplikasi komputer, sementara sekretaris hanya menguasai aplikasi yang ia gunakan untuk memasukkan data.
    • Perhatikan pengguna perangkat lunak. Meskipun jabatan mereka umumnya sesuai dengan tugas yang dijalankan, jabatan tersebut mungkin memiliki beban kerja yang berbeda, tergantung tempat usaha. Dengan mewawancarai calon pengguna, Anda dapat mengetahui apakah penilaian Anda akan jabatan mereka sudah tepat.
    • Perhatikan dokumentasi yang sudah ada. Dokumentasi dan spesifikasi fungsi perangkat lunak dapat menunjukkan apa saja yang harus diketahui pengguna agar dapat menggunakannya. Namun, ingatlah bahwa pengguna mungkin tidak tertarik mengetahui "jeroan" program.
    • Ketahui hal-hal yang diperlukan untuk menyelesaikan tugas, dan hal apa saja yang diperlukan sebelum dapat menyelesaikannya.
  3. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/5\/5b\/Write-Software-Documentation-Step-6.jpg\/v4-460px-Write-Software-Documentation-Step-6.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/5\/5b\/Write-Software-Documentation-Step-6.jpg\/v4-728px-Write-Software-Documentation-Step-6.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Dokumentasi perangkat lunak dapat disusun dalam 1 atau 2 format, yaitu buku referensi dan buku panduan. Terkadang, menggabungkan kedua format adalah solusi yang baik.
    • Format referensi digunakan untuk menjelaskan seluruh fitur perangkat lunak, seperti tombol, tab, kolom isian, dan kotak dialog, dan cara kerjanya. Sebagian berkas pertolongan ditulis dengan format ini, terutama berkas yang sensitif terhadap konteks. Saat pengguna mengeklik Help di layar tertentu, pengguna akan menerima topik yang relevan.
    • Format buku panduan digunakan untuk menjelaskan cara melakukan suatu hal dengan perangkat lunak. Buku panduan umumnya dibuat dalam format cetak atau PDF, meskipun beberapa halaman pertolongan juga menyertakan panduan melakukan hal tertentu. (Umumnya, format buku panduan tidak sensitif terhadap konteks, tetapi mungkin ditautkan dari topik yang sensitif terhadap konteks). Buku panduan umumnya berbentuk panduan, dengan ringkasan tugas yang akan dilakukan dalam deskripsi dan panduan yang diformat dalam bentuk langkah.
  4. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/d\/d9\/Write-Software-Documentation-Step-7.jpg\/v4-460px-Write-Software-Documentation-Step-7.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/d\/d9\/Write-Software-Documentation-Step-7.jpg\/v4-728px-Write-Software-Documentation-Step-7.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Dokumentasi perangkat lunak untuk pengguna mungkin dikemas dalam salah satu atau beberapa format berikut: buku manual cetak, berkas PDF, berkas pertolongan, atau pertolongan daring. Setiap jenis dokumentasi dirancang untuk menunjukkan cara menggunakan fungsi perangkat lunak, baik berupa panduan maupun tutorial. Dokumentasi daring dan halaman pertolongan juga mungkin menyertakan video demonstrasi, teks, dan gambar statis.
    • Berkas pertolongan dan dukungan daring harus terindeks dan dapat dicari menggunakan kata kunci agar pengguna dapat menemukan informasi yang diperlukan dengan cepat. Meskipun aplikasi pembuat berkas pertolongan dapat membuat indeks secara otomatis, Anda tetap dianjurkan untuk membuat indeks secara manual dengan kata kunci yang umum dicari.
  5. {"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/f\/fd\/Write-Software-Documentation-Step-8.jpg\/v4-460px-Write-Software-Documentation-Step-8.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/f\/fd\/Write-Software-Documentation-Step-8.jpg\/v4-728px-Write-Software-Documentation-Step-8.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"}
    Buku manual cetak atau PDF dapat dibuat dengan program pengolah kata seperti Word atau penyunting teks canggih seperti FrameMaker, tergantung panjang dan kompleksitas berkas. Berkas pertolongan dapat ditulis dengan program pembuat berkas pertolongan, seperti RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix, atau HelpServer.
    Iklan

Tips

  • Teks pada dokumentasi program sebaiknya disusun sedemikian rupa agar mudah dibaca. Letakkan gambar sedekat mungkin dengan teks yang sesuai. Pecah dokumentasi berdasarkan bagian dan topik secara logis. Setiap bagian atau topik harus menjelaskan masalah tertentu, baik tugas maupun fitur program. Masalah terkait dapat dijelaskan dengan tautan atau daftar referensi.
  • Setiap alat dokumentasi yang dijelaskan di artikel ini dapat dilengkapi dengan program pembuat tangkapan layar, seperti SnagIt jika dokumentasi Anda memerlukan banyak tangkapan layar. Layaknya dokumentasi lain, Anda juga harus menyertakan tangkapan layar untuk membantu menjelaskan cara kerja aplikasi, alih-alih "memikat" pengguna.
  • Memperhatikan gaya bahasa sangatlah penting, terutama jika Anda menulis dokumentasi perangkat lunak bagi pengguna akhir. Sebut pengguna dengan kata ganti "Anda", alih-alih "pengguna".
Iklan

Hal yang Anda Butuhkan

  • Program pembuat dokumentasi
  • Program pembuat tangkapan layar

wikiHow Terkait

Cara
Menghapus Tinta Dari Kertas
Cara
Menghilangkan Lecek pada Kertas
Cara
Menulis Komentar
Cara
Menganalisis Tulisan Tangan (Grafologi)
Cara
Menulis Apendiks
Cara
Menulis Tanggal dalam Bahasa Inggris
Cara
Menulis Nama Pasangan yang Sudah Menikah di Amplop
Cara
Mengatakan Aku Cinta Kamu dalam Bahasa Urdu
Cara
Menulis Buku Harian
Cara
Mengutip Nomor Halaman dengan Format APA
Cara
Mengenal Karakter Seseorang Lewat Tulisan Tangan
Cara
Membuat Tanda Tangan yang Menarik
Cara
Menjelaskan Latar dalam Cerita
Cara
Menulis Pernyataan Minat (Expression of Interest)
Iklan

Referensi

  1. http://www.softwaredocumentation.info/DocumentingSoftware.aspx
  2. http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm
  3. http://www.techscribe.co.uk/ta/how-to-write-instructions.htm
  4. Rodney Ruff, Omaha, NE; berpengalaman menjadi penulis teknis dan pembuat berkas dokumentasi sejak 1997.

Tentang wikiHow ini

Bahasa lain
Halaman ini telah diakses sebanyak 44.373 kali.

Apakah artikel ini membantu Anda?

Iklan