Pendampingan dan Dokumentasi Teknis
Kembangkan anggota tim junior melalui pemrograman berpasangan dan masukan yang tepat waktu, tulis ADR untuk keputusan arsitektur, serta pelihara dokumentasi yang terus diperbarui dan tepercaya.
Pendampingan dan Dokumentasi Teknis adalah pelajaran Frontend Academy gratis di CoddyKit. Ini adalah pelajaran 3 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Frontend Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Frontend Academy mencakup 4 pelajaran total.
Senior Berarti Mengembangkan Orang Lain
Pada tingkat senior, tugas Anda bukan menulis kode paling banyak — melainkan membuat tim Anda menjadi lebih baik. Bimbing pengembang junior, tulis dokumentasi yang memperluas jangkauan pengetahuan Anda, lakukan tinjauan kode yang mengajarkan sesuatu, dan bentuk arsitektur agar orang lain dapat bergerak cepat dengan aman.
Membimbing Melalui Pemrograman Berpasangan
Pemrograman berpasangan adalah cara tercepat untuk mengembangkan pengembang junior. Duduklah bersama (atau berbagi layar), biarkan mereka memegang kendali sementara Anda mengarahkan. Tahan keinginan untuk mengambil alih — jelaskan cara berpikir Anda dan ajukan pertanyaan sokratik.
Tantangan dengan Tingkat Kesulitan yang Tepat
Berikan tugas kepada pengembang junior yang sedikit melampaui kemampuan mereka saat ini. Terlalu mudah = tidak ada perkembangan. Terlalu sulit = kewalahan dan frustrasi. Sesuaikan tingkatnya: 'Saya rasa Anda bisa mengerjakan ini dengan sedikit bantuan — saya siap berpasangan jika Anda mengalami kebuntuan.'
Tinjauan Kode sebagai Pengajaran
Untuk PR pengembang junior, jelaskan alasan di balik setiap komentar yang tidak sepele. Sertakan tautan ke dokumentasi, PR sebelumnya, atau artikel yang relevan. Tinjauan yang buruk: 'gunakan useCallback'. Tinjauan yang baik: 'Fungsi ini dibuat ulang setiap kali tampilan dirender — meneruskannya ke komponen anak yang menggunakan memo menyebabkan perenderan ulang yang tidak perlu. useCallback menyimpan fungsi ini dalam memo. Berikut contoh PR yang menerapkan hal ini: #1234'.
Catatan Keputusan Arsitektur (ADR)
ADR mendokumentasikan pilihan arsitektur yang penting: apa yang kita putuskan, alasannya, alternatif yang dipertimbangkan, dan kompromi yang diterima. Diri Anda di masa depan akan berterima kasih kepada diri Anda saat ini.
# ADR-0007: Use TanStack Query for server state
Date: 2026-05-01
Status: Accepted
## Context
We currently scatter useEffect+fetch+useState patterns across the app.
Cache invalidation is inconsistent, race conditions cause stale data.
## Decision
Adopt TanStack Query (@tanstack/react-query v5) for all server state.
## Consequences
+ Built-in caching, deduplication, optimistic updates.
+ Standard pattern across team.
- Adds ~13KB gzipped.
- Team needs to learn query keys conventions.
## Alternatives Considered
- SWR: smaller, but fewer features (no mutations).
- Apollo Client: overkill (we don't use GraphQL).
- Custom hook: doesn't solve cache invalidation.
## References
- React Query docs: ...Tempat Menyimpan ADR
Simpan ADR di docs/adr/ dalam repositori, dengan nomor berurutan. ADR berada berdampingan dengan kode yang dijelaskannya. Alat yang dapat digunakan: adr-tools dan log4brains untuk antarmuka web yang mudah dijelajahi.
Kualitas README
Setiap paket, pustaka, dan fitur utama memerlukan README. Sertakan: fungsinya, cara memasang, cara menggunakan (dengan contoh kode), cara berkontribusi, cara menjalankan pengujian, dan cara men-debug. Pengembangan berbasis README: tulis README terlebih dahulu, lalu bangun sesuai spesifikasi tersebut.
Komentar Kode Sebaris — Kapan Menggunakannya
Komentar harus menjelaskan mengapa, bukan apa. Kode menunjukkan apa yang dilakukan. Komentar menjelaskan: aturan bisnis, kompromi yang tidak langsung terlihat, tautan ke tiket atau galat, serta peringatan tentang jebakan.
// BAD: comment restates the code
// Increment counter by 1
counter++;
// GOOD: comment explains business context
// Stripe webhook can arrive twice — increment only if signature is fresh.
// See: https://stripe.com/docs/webhooks/best-practices#idempotency
if (!seen.has(event.id)) counter++;Buku Panduan untuk Tugas Operasional
Dokumentasikan cara melakukan tugas operasional yang berulang atau berisiko: 'Cara mengganti kunci API Stripe', 'Cara memulihkan diri dari penerapan yang gagal', 'Cara men-debug respons API yang lambat'. Anggota tim baru dapat mengikutinya tanpa harus menghubungi Anda.
Dokumentasi yang Terus Diperbarui
Dokumentasi usang lebih buruk daripada tidak memiliki dokumentasi. Beri tanggal pada dokumentasi. Tinjau setiap tiga bulan. Hapus dokumentasi yang tidak pernah diperbarui. Lebih baik lagi: buat dokumentasi dari kode (Storybook untuk komponen, TypeDoc untuk API, OpenAPI untuk titik akhir).
Paparan Teknologi dan Sesi Berbagi
Sampaikan paparan selama 20–30 menit kepada tim mengenai hal yang telah Anda pelajari: pustaka baru, kisah penelusuran galat, atau pola yang Anda anggap berguna. Hal ini memaksa Anda menata pemikiran sekaligus mengajari orang lain.
Membangun Rasa Aman secara Psikologis
Pengembang junior yang takut bertanya tidak akan berkembang. Biasakan mengatakan 'Saya tidak tahu'. Ciptakan suasana yang aman untuk melakukan kesalahan — rayakan evaluasi setelah kejadian, bukan kegiatan menyalahkan. Sebagai orang senior, reaksi Anda menentukan suasana bagi tim.
Jebakan Menjadi Pemrogram Heroik
Jangan menjadi orang yang memperbaiki setiap insiden produksi sendirian. Dokumentasikan perbaikannya, berpasanganlah dengan rekan satu tim pada kesempatan berikutnya, dan otomatisasikan diagnosisnya. Tim yang bergantung pada aksi heroik Anda adalah tim yang rapuh.
Pemeriksaan Singkat
Apa tujuan utama sebuah Catatan Keputusan Arsitektur (ADR)?
Ringkasan: Mentoring & Dokumentasi
Senior = mengembangkan orang lain, bukan menulis kode paling banyak. Lakukan pemrograman berpasangan; ajarkan melalui tinjauan kode; berikan tantangan dengan tingkat kesulitan yang tepat. ADR di docs/adr/ mencatat alasan di balik keputusan. README untuk setiap paket. Komentar menjelaskan mengapa, bukan apa. Buku panduan untuk tugas operasional. Dokumentasi yang terus diperbarui (Storybook, TypeDoc, OpenAPI) lebih baik daripada markdown statis. Bangun rasa aman secara psikologis. Hindari pemrograman heroik.
Pertanyaan yang Sering Diajukan
Apakah pelajaran “Pendampingan dan Dokumentasi Teknis” gratis?
Ya — teks lengkap “Pendampingan dan Dokumentasi Teknis” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Frontend Academy, upgrade ke CoddyKit PRO. Kursus Frontend Academy mencakup 4 pelajaran total.
Apa yang akan aku pelajari di “Pendampingan dan Dokumentasi Teknis”?
Kembangkan anggota tim junior melalui pemrograman berpasangan dan masukan yang tepat waktu, tulis ADR untuk keputusan arsitektur, serta pelihara dokumentasi yang terus diperbarui dan tepercaya. Kamu berlatih Frontend Academy dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.
Apakah aku perlu pengalaman untuk memulai Frontend Academy?
Tidak diperlukan pengalaman sebelumnya. Frontend Academy di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 3 dari 4.
Berapa lama pelajaran “Pendampingan dan Dokumentasi Teknis” memakan waktu?
Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.
Bisakah aku menulis dan menjalankan kode dalam pelajaran Frontend Academy ini?
Ya. Setiap pelajaran Frontend Academy menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.
Semua pelajaran dalam kursus ini
- Wawancara Desain Sistem Frontend
- Budaya Tinjauan Kode dan Praktik Terbaik PR
- Pendampingan dan Dokumentasi Teknis
- Tetap Terkini: Membaca Spesifikasi dan Proposal