Rangkuman dari Dokumentasi Pemrograman dan

Pengembangan Aplikasi Perangkat Lunak

Berikut beberapa ringkasan mengenai materi Dokumentasi
Pemrograman dan Pengembangan Aplikasi Perangkat Lunak:

Pengarsipan versi Perangkat Lunak

 Pengarsipan adalah proses, cara, atau perbuatan mengarsipkan.

Sedangkan arsip sendiri adalah tempat penyimpanan berkas
(program atau data) sebagai cadangan. Sehingga pengarsipan
perangkat lunak dapat diartikan sebagai proses mengarsipkan
perangkat lunak atau aplikasi yang telah kita buat.

 Version Control System merupakan tools untuk mengatur suatu

perubahan dan konfigurasi dari suatu aplikasi, termasuk juga
source code. Setiap perubahan yang dilakukan akan dicatat,
sehingga memperjelas siapa yang telah melakukan perubahan
tersebut. Selain itu, version control juga berfungsi sebagai backup
files atau pengarsipan.

 Kita bisa menggunakan c secara free  atau gratis kemudian

menyimpannya juga di layanan online yang tersedia seperti GitHub,
Bitbucket, dan Gitlab. Namun, salah satu yang cukup populer
adalah GitHub.

 GitHub merupakan layanan hosting repository Git berbasis web

yang juga memiliki banyak fitur seperti bug tracking dan task
management. Dengan menggunakan GitHub, kita bisa mengarsipkan
perangkat lunak atau aplikasi kapan pun dan di mana pun.

 Semua perubahan yang ada dalam repository Git dapat kita lihat
dalam halaman history. Kita juga dapat melihat detail dari
perubahan tersebut, seperti bagian mana yang ditambahkan atau
dihilangkan.
  Anda dapat menggunakan commit untuk menyimpan perubahan
yang ada dalam Git. Selain itu, Anda juga dapat menggunakan fitur
revert untuk kembali ke perubahan atau commit tertentu. 

Style Guide

 Saat Anda bekerja sebagai software developer, perusahaan tak

hanya menginginkan fitur-fitur aplikasi bisa berjalan dengan baik
ya. Perusahaan juga menginginkan kode dengan kualitas terbaik
dan mampu menjadi pendukung bisnis. Salah satu indikatornya
adalah Anda dapat melakukan perubahan dengan mudah pada
aplikasi saat terdapat fitur baru. Selain itu, perusahaan dapat
melakukan upaya (effort) seminimal mungkin untuk beradaptasi
dengan kebutuhan bisnisnya.

 Kode yang baik tak hanya mudah dibaca oleh komputer saja,
namun mudah dibaca oleh manusia. Kenapa demikian? Karena
programming kebanyakan tentang membaca, bukan menulis.

 Style Guide merupakan kumpulan peraturan mengenai bagaimana

cara penulisan kode yang baik bagi developer secara individu
maupun tim. Pada style guide tertulis secara lengkap aturan yang
harus diikuti oleh developer. Seperti penggunaan double atau
single quote, indentasi, semicolon, penamaan variabel, dan lainnya.

 Style guide yang sudah disepakati dan direkomendasikan oleh

banyak developer itulah yang disebut dengan Code Convention.
Tentunya setiap bahasa pemrograman memiliki berbagai referensi
style guide terkenal yang direkomendasikan untuk Anda ikuti.
Dalam bahasa JavaScript, Anda dapat mengikuti style guide dari
AirBNB JavaScript, Google JavaScript, dan Standard JavaScript.

 Siebe Hiemstra seorang Engineer dari Belanda berbagi alasan

mengapa style guide penting bagi developer:
 o Konsistensi
o Membantu Proses Onboarding
o Menambah Wawasan
o Membantu proses Code Review

 Selain itu, dengan mengikuti style guide, Anda akan dapat beberapa
keuntungan seperti:
o Memahami dan membaca kode jadi lebih mudah.
o Memelihara kode jadi lebih mudah untuk dipelihara.
o Mengurangi kesalahan programmer yang sering terjadi.
o Mengurangi beban secara kognitif saat memuat kode.
o Menjadi lebih fokus pada permasalahan logika kode
dibandingkan style-nya saat berdiskusi dengan rekan kerja
Anda.

Komentar pada Kode

 Komentar memiliki beberapa macam jenis.

o Singleline atau satu baris (//)
o Multiline atau beberapa baris (/* … */)

 Selain menginformasikan apa yang terjadi dalam baris kode,

komentar juga berfungsi untuk menonaktifkan suatu perintah
dalam baris kode. Contohnya seperti ini:

1. print("Congratulations, You Win.");

2. // playSound("orchestra.mp3");

3. player.saveScore();

 Ingat, tak semua kode perlu dikomentari ya. Terlebih jika sebuah
hal yang mendasar, seperti perintah print.
  Walaupun komentar tidak mempengaruhi performa kode, tetapi
harus kita pastikan komentar yang dibuat cukup membantu untuk
menjelaskan kode yang ada. Oleh karena itu, bijaklah dalam
menuliskan komentar dalam kode. Jika dirasa komentar tidak
diperlukan, Anda bisa menghapusnya.

Dokumentasi Teknis Aplikasi

 Dokumentasi adalah deskripsi tertulis yang komprehensif dari

perangkat lunak dalam berbagai bentuk dan tingkat perincian yang
secara jelas mendefinisikan persyaratan, konten, komposisi, desain,
kinerja, pengujian, penggunaan, dan pemeliharaan.

 Dokumentasi teknis akan menceritakan mengenai produk dengan

cara yang mudah untuk digunakan, dibaca, dimengerti, dan
tentunya membantu pembaca.

 Dokumentasi Teknis dibagi menjadi beberapa jenis dan area sesuai

kebutuhan, berikut detailnya:
o End-user support: Dokumen ini biasanya berisi tentang
panduan pengguna, sistem bantuan secara online, catatan
rilis, panduan pelatihan, panduan cara instalasi, atau prosedur
operasional. Intinya adalah apa pun yang mendukung
pengguna dengan produk Anda.
o Marketing support: Dokumen ini fokus pada produk dan
digunakan untuk memasarkan perusahaan Anda. Contohnya
berupa video pelatihan berbasis komputer, presentasi,
bantuan secara online, atau sebuah halaman untuk arahan
teknis.
o Development support: Dokumen ini berisi mengenai segala
spesifikasi teknis dan fungsional, panduan pengembangan
produk perangkat lunak, glosarium, atau prosedur serta tools
untuk membantu tim dalam melakukan pekerjaan mereka.
 o Organization support: Dokumen ini berisi segala informasi
mengenai perusahaan seperti struktur organisasi, panduan
bekerja, alur kerja, kebijakan-kebijakan, aturan yang ada, dan
hal lain yang perlu diketahui karyawan untuk melakukan
pekerjaan mereka.

 Dokumentasi teknis itu sendiri dapat dilakukan secara offline

maupun online.

 Ketika Anda membuat dokumentasi secara online, maka dapat

diakses kapan saja dan di mana saja. Tentunya ini akan
memudahkan dan tidak memakan waktu lama untuk
memahaminya sehingga lebih efisien dan uptodate.

 Beda cerita jika Anda mendokumentasikan sebuah aplikasi atau

produk, namun disimpan dalam bentuk offline seperti catatan atau
mungkin dalam bentuk buku. Jika dibutuhkan dalam keadaan
terdesak, informasi tersebut tidak bisa langsung didapatkan.
Bahkan proses pencariannya juga akan lebih rumit dibandingkan
dokumentasi teknis secara online.

 Manfaat yang akan didapatkan ketika kita mengimplementasikan

dokumentasi teknis ketika pembuatan aplikasi.
o Meningkatkan retensi pengguna.
o Menghemat waktu dan tenaga.
o Meningkatkan penjualan produk Anda.

 Berikut merupakan langkah singkat untuk membangunnya.

o Tentukan siapa targetnya, apakah untuk rekan tim Anda atau
untuk pengguna aplikasi Anda.
o Pikirkan dengan matang dan jelas apa yang ingin Anda
sampaikan ke dalam dokumentasi teknis. 
o Gunakanlah outline atau kerangka tulisan terlebih dahulu
ketika membangunnya.
o Anda juga dapat menggunakan ilustrasi dan teks dalam
dokumentasi tersebut.
 o Terakhir, jika Anda sudah menyelesaikan dokumentasi teknis,
maka pastikan kembali. Anda bisa membacanya kembali dan
bila ada yang kurang sesuai segera Anda revisi.

 JSDoc merupakan salah satu tools yang dapat digunakan untuk

membuat dokumentasi teknis dari komentar yang diberikan pada
berkas program Javascript.

 Sebelum Anda mengomunikasikan perihal dokumentasi, Anda perlu

memperhatikan beberapa hal penting berikut. 
o Pastikan apa yang sudah Anda tulis dalam dokumentasi sudah
benar dan sudah sesuai.
o Perlu kamu tahu bahwa suatu dokumentasi teknis tidak hanya
ditujukan kepada Anda saja melainkan untuk orang lain. 
o Ketika menyampaikan pun harus dengan adab atau beretika
atau sopan santun.
o Pastikan Anda mendokumentasikan teknis aplikasi secara
online, serta memikirkan juga siapa saja yang dapat
mengaksesnya karena keamanan dokumentasi teknis juga
perlu dipikirkan.

Tips Cara Mengomunikasikan Dokumentasi kepada Stakeholders

(pemegang kepentingan perusahaan)

Sebelum Anda mengomunikasikan perihal dokumentasi, Anda perlu

memperhatikan beberapa hal penting berikut. 

 Pastikan apa yang sudah Anda tulis dalam dokumentasi sudah

benar dan sudah sesuai. Luangkan waktu untuk membaca kembali.
Sebab, sebuah typo saja bisa menimbulkan masalah.

 Dokumentasi ini tidak hanya ditujukan kepada Anda saja. Namun,

untuk orang lain. Oleh karena itu, ketika Anda menuliskan
dokumentasi teknis jangan terlalu berpikir secara tertutup. Jangan
 sampai hanya karena Anda merasa baik-baik saja, maka semua itu
sudah selesai ya. Pastikan Anda memposisikan sebagai pembaca,
baik atasan maupun stakeholder lainnya.

 Ketika menyampaikan pun harus dengan adab ya. Sebab, sebaik

apapun dokumentasi yang dibuat jika Anda menyepelekan masalah
adab maka akan menimbulkan masalah. Contohnya, ketika sudah
menentukan deadline pembuatan maka Anda harus menepatinya.
Kalau dirasa ada yang salah, maka segeralah katakan. Jangan
sampai ketika deadline datang, namun Anda justru memberikan
seribu alasan karena dokumentasi belum siap.

 Pastikan Anda mendokumentasikan teknis aplikasi secara online.

Seperti yang sudah dijelaskan pada materi sebelumnya,
mendokumentasikan secara online akan memberikan banyak
manfaat. Namun, Anda perlu memikirkan juga siapa saja yang
dapat mengaksesnya karena keamanan dokumentasi teknis juga
perlu dipikirkan. Jangan sampai hal yang bersifat rahasia, justru
karena keteledoran Anda menjadikan kebocoran informasi.

Semoga rangkuman ini dapat membantu Anda untuk memahami sub-

modul Dokumentasi Pemrograman dan Pengembangan Aplikasi
Perangkat Lunak. Semangat