Podcast
Questions and Answers
Apa yang sebaiknya dilakukan jika Anda merasa ada yang salah dengan dokumentasi yang sedang disiapkan?
Apa yang sebaiknya dilakukan jika Anda merasa ada yang salah dengan dokumentasi yang sedang disiapkan?
Mengapa adab dalam penyampaian penting saat berkomunikasi dengan atasan dan stakeholder?
Mengapa adab dalam penyampaian penting saat berkomunikasi dengan atasan dan stakeholder?
Apa yang perlu dipikirkan terkait keamanan dokumentasi teknis secara online?
Apa yang perlu dipikirkan terkait keamanan dokumentasi teknis secara online?
Apa akibat dari menyepelekan masalah adab saat menyampaikan dokumentasi?
Apa akibat dari menyepelekan masalah adab saat menyampaikan dokumentasi?
Signup and view all the answers
Apa yang harus dilakukan ketika deadline pembuatan dokumentasi sudah ditentukan?
Apa yang harus dilakukan ketika deadline pembuatan dokumentasi sudah ditentukan?
Signup and view all the answers
Apa yang dimaksud dengan pengarsipan perangkat lunak?
Apa yang dimaksud dengan pengarsipan perangkat lunak?
Signup and view all the answers
Apa fungsi utama dari Version Control System?
Apa fungsi utama dari Version Control System?
Signup and view all the answers
Apa keuntungan menggunakan GitHub dalam pengarsipan perangkat lunak?
Apa keuntungan menggunakan GitHub dalam pengarsipan perangkat lunak?
Signup and view all the answers
Apa yang dimaksud dengan Style Guide dalam pemrograman?
Apa yang dimaksud dengan Style Guide dalam pemrograman?
Signup and view all the answers
Mengapa kode yang baik penting dalam pengembangan perangkat lunak?
Mengapa kode yang baik penting dalam pengembangan perangkat lunak?
Signup and view all the answers
Apa yang dapat dilihat dalam halaman history repository Git?
Apa yang dapat dilihat dalam halaman history repository Git?
Signup and view all the answers
Apa fungsi commit dalam Git?
Apa fungsi commit dalam Git?
Signup and view all the answers
Apa tujuan utama dari Style Guide bagi developer?
Apa tujuan utama dari Style Guide bagi developer?
Signup and view all the answers
Apa yang dimaksud dengan Code Convention dalam pengembangan perangkat lunak?
Apa yang dimaksud dengan Code Convention dalam pengembangan perangkat lunak?
Signup and view all the answers
Mengapa mengikuti style guide penting bagi developer?
Mengapa mengikuti style guide penting bagi developer?
Signup and view all the answers
Apa jenis komentar yang tidak dipengaruhi oleh kode lainnya?
Apa jenis komentar yang tidak dipengaruhi oleh kode lainnya?
Signup and view all the answers
Apa manfaat menggunakan dokumentasi teknis secara online?
Apa manfaat menggunakan dokumentasi teknis secara online?
Signup and view all the answers
Apa yang harus diperhatikan saat menulis dokumentasi teknis?
Apa yang harus diperhatikan saat menulis dokumentasi teknis?
Signup and view all the answers
Apa tujuan utama komentar dalam kode?
Apa tujuan utama komentar dalam kode?
Signup and view all the answers
Apa saja jenis dokumentasi teknis yang biasanya ada?
Apa saja jenis dokumentasi teknis yang biasanya ada?
Signup and view all the answers
Apa yang harus dilakukan jika sebuah komentar dirasa tidak diperlukan?
Apa yang harus dilakukan jika sebuah komentar dirasa tidak diperlukan?
Signup and view all the answers
Apa pentingnya JSDoc dalam pengembangan perangkat lunak JavaScript?
Apa pentingnya JSDoc dalam pengembangan perangkat lunak JavaScript?
Signup and view all the answers
Apa yang dimaksud dengan 'Development support' dalam dokumentasi teknis?
Apa yang dimaksud dengan 'Development support' dalam dokumentasi teknis?
Signup and view all the answers
Mengapa komentar yang tidak relevan perlu dihindari dalam kode?
Mengapa komentar yang tidak relevan perlu dihindari dalam kode?
Signup and view all the answers
Apa keuntungan terbesar dari mengikuti style guide bagi developer?
Apa keuntungan terbesar dari mengikuti style guide bagi developer?
Signup and view all the answers
Apa yang harus dipastikan sebelum mendokumentasikan aplikasi secara online?
Apa yang harus dipastikan sebelum mendokumentasikan aplikasi secara online?
Signup and view all the answers
Study Notes
Pengarsipan Versi Perangkat Lunak
- Pengarsipan adalah proses menyimpan berkas program atau data sebagai cadangan.
- Version Control System (VCS) mengatur perubahan dan konfigurasi aplikasi, termasuk kode sumber.
- Setiap perubahan dicatat, mencatat siapa yang melakukannya.
- VCS berfungsi sebagai backup files.
- Git adalah alat VCS gratis, bisa disimpan di layanan online seperti GitHub, Bitbucket, dan Gitlab.
- GitHub adalah hosting repository Git populer dengan fitur bug tracking dan task management.
- Riwayat perubahan aplikasi dapat dilihat di halaman history Git.
- Detail perubahan (ditambahkan atau dihapus) dapat dilihat.
- Commit digunakan untuk menyimpan perubahan di Git.
- Fitur revert mengembalikan ke commit tertentu.
Style Guide
- Perusahaan menginginkan kode berkualitas tinggi, mudah diubah, dan mudah diadaptasikan.
- Kode yang baik mudah dibaca manusia, bukan hanya komputer.
- Style Guide adalah aturan penulisan kode (individu atau tim).
- Code Convention adalah style guide yang disepakati banyak developer.
- Bahasa pemrograman memiliki style guide direkomendasikan (misalnya, JavaScript: Airbnb, Google, Standard).
- Keuntungan mengikuti style guide:
- Memudahkan membaca dan memahami kode.
- Memudahkan pemeliharaan kode.
- Mengurangi kesalahan programmer.
- Mengurangi beban kognitif.
- Fokus pada logika kode, bukan style.
- Faktor penting style guide menurut Siebe Hiemstra (Engineer dari Belanda):
- Konsistensi kode.
- Memudahkan onboarding.
- Menambah wawasan.
- Memudahkan code review.
Komentar pada Kode
- Komentar menjelaskan kode, dan bisa menonaktifkan baris kode.
- Dua jenis komentar: singleline (
//
) dan multiline. - Tidak semua kode perlu komentar, terutama untuk hal-hal dasar.
- Komentar harus membantu memahami kode, hindari jika tidak perlu.
- Contoh komentar (menonaktifkan baris kode):
print("Selamat, Anda Menang.");
// playSound("orchestra.mp3");
player.saveScore();
Dokumentasi Teknis Aplikasi
- Dokumentasi teknis mendefinisikan persyaratan, konten, desain, kinerja, pengujian, penggunaan, dan pemeliharaan perangkat lunak.
- Dokumentasi teknis membuat aplikasi mudah digunakan, dibaca, dan dimengerti.
- Jenis dokumentasi teknis:
- End-user support: Panduan pengguna, bantuan online, rilis catatan, pelatihan.
- Marketing support: Video, presentasi, bantuan online, halaman teknis.
- Development support: Spesifikasi, panduan pengembangan, glosarium, prosedur, tools.
- Organization support: Struktur organisasi, panduan kerja, kebijakan, alur kerja.
- Dokumentasi offline sulit diakses langsung dan diperbarui.
- Dokumentasi online efisien dan mudah diakses.
- Manfaat implementasi dokumentasi teknis:
- Meningkatkan retensi pengguna.
- Menghemat waktu dan tenaga.
- Meningkatkan penjualan produk.
- Langkah membuat dokumentasi teknis:
- Tentukan target (rekan tim atau pengguna).
- Tentukan informasi yang disampaikan.
- Gunakan outline/kerangka tulisan.
- Gunakan ilustrasi dan teks.
- Periksa dan revisi dokumentasi.
- JSDoc digunakan untuk membuat dokumentasi teknis dari komentar di kode Javascript.
Mengomunikasikan Dokumentasi kepada Stakeholder
- Pastikan informasi dalam dokumentasi akurat dan lengkap.
- Sasarkan dokumentasi untuk pembaca lain, bukan hanya penulis.
- Pertimbangkan posisi pembaca (atasan, stakeholder).
- Berkomunikasi dengan beradab dan sopan.
- Pastikan deadline dipenuhi, beri tahu masalah jika ada.
- Dokumentasi online meningkatkan akses.
- Pertimbangkan keamanan dan akses dokumentasi.
Studying That Suits You
Use AI to generate personalized quizzes and flashcards to suit your learning preferences.
Description
Pelajari tentang pengarsipan versi perangkat lunak dan sistem pengelolaan versi seperti Git. Quiz ini mencakup konsep dasar seperti commit, revert, dan pentingnya kode berkualitas tinggi yang mematuhi pedoman gaya. Tes pengetahuan Anda tentang bagaimana VCS membantu dalam pengelolaan perubahan.