Skodev
Belajar coding dalam bahasa Indonesia
Diskon kelas baru hingga 25%! Masukkan kupon "lebihcepat" di kelas ini
XSkodev
Belajar coding dalam bahasa Indonesia
Tips dan trik bagaimana cara menulis dari dan untuk developer. Bawa ide teknikal kamu menjadi bacaan yang nyaman dikonsumsi
Daftar Isi:
Developer tidak suka bertele-tele. Saat mencari jawaban dari pertanyaan, kita bisa lompat ke bagian jawaban Stackoverflow. Butuh informasi, bisa langsung ke bagian dokumentasi yang relevan.
Bagaimana dengan tulisanmu? masih banyak tulisan yang membuat perkenalan panjang atau mengulang semua konsep sebelum menyampaikan poinnya. Karena itu penting untuk developer mengerti cara menulis yang disukai oleh developer lainnya.
Konteks: Saya sudah bertahun-tahun menulis blog pemrograman dan menerbitkan buku Halo Koding.
Setiap tulisan ada target pembaca atau audience-nya. Jika tidak, maka yang akan terjadi:
Tentukan untuk siapa kamu menulis materi tersebut.
Contoh: kamu ingin membahas “async pada NodeJS”, maka tidak perlu lagi membahas Nodejs secara detail, cukup 1-2 kalimat intro saja.
Tulisan kita ada untuk dibaca orang. Pastikan menggunakan bahasa yang ringan dan mudah dimengerti. Hindari menggunakan jargon-jargon yang orang lain tidak familiar.
“Bagaimana jika ada materi bercabang yang harus disampaikan?” Kamu bisa menjelaskan dengan sederhana, satu atau dua kalimat. Bisa juga menuliskannya untuk materi (postingan) yang terpisah, lalu memberi link ke sana.
Contoh: Misalnya kamu menulis tentang “memori heap dan stack”, maka tidak perlu membahas seputar apa itu CPU, apa itu Monitor, kecuali pada bagian yang relevan seperti menceritakan alur kerja.
Jangan memberi judul yang “WAH”, namun poinnya tidak ada di sana. Pembaca akan kecewa berat. Sifat seorang developer pun yang biasa sharing, bisa merugikan kamu jika kamu punya citra negatif.
Jangan menulis 3-4 paragraf perkenalan tanpa poin yang pasti di sana.
Perlihatkan, jangan ceritakan. Perlihatkan kodenya, perlihatkan hasilnya, termasuk errornya.
Jangan berbicara panjang yang membuat orang jadi harus membayangkan berlapis-lapis. Jika perlu, sertakan kode, gambar, demo yang mendukung.
Developer akan kesal jika hasil usaha (copy-paste) di internet, tidak berjalan.
Pastikan demo kamu ada konteksnya, apa yang harus diinstall, yang harus dilakukan sebelum asal copy-paste kode tersebut.
Pastikan juga demo-nya terlah berjalan dengan baik, sebelum membagikannya.
Buat kode kamu untuk mudah disalin.
Buat konten kamu dengan poin-poin yang mudah diikuti. Jangan langsung menulis 1000 kata blog post tanpa ada heading di sana.
Karena itu sebelum menulis, sapa seperti koding, pecahkan masalah yang ingin kamu bahas, menjadi masalah-masalah kecil. Sehingga mudah untuk kamu tuangkan menjadi tulisan.
Bagi materi ke sub bagian (h2, h3) agar mudah dipahami. Beri judul heading yang relevan untuk poin yang ingin dibahas.
Pada umumnya, plaftorm blog atau dokumentasi, menyediakan “table of content” otomatis yang memperlihatkan apa saja heading dari tulisan ini.
Senada dengan versi TL;DR, pembaca bisa “skim” atau scan konten yang akan dia baca.
Untuk menghindari rasa bosan saat membaca, mainkan formatnya.
Analogi adalah permisalan. Berikan contoh di dunia nyata dalam menjelaskan konsep.
Contoh: Misalnya saya ingin menjelaskan konsep async, saya bisa memberi analogi berikut:
Bayangkan kita ke restoran, seorang pelayan bisa menerima pesanan setiap customer yang data, lalu menyajikannya pada saat ada makanan yang sudah siap. Inilah async.
Bedakan, jika pelayan ini menerima order dan menunggu makanan tersebut jadi, baru melayani pelanggan berikutnya. Tentu akan lambat, karena restorannya tidak memaksimalkan waktunya
Analogi ini saya dapatkan dari video youtube bertahun-tahun lalu ketika saya baru belajar konsep NodeJS, namun masih melekat hingga sekarang.
Ada banyak orang yang bisa menulis materi tertentu. Apa yang membuatnya unik dan berbeda? pengalaman pribadi kamu.
Kamu bisa berbagi pengalaman kamu, apa yang kamu lakukan, apa yang kamu pelajari, apa yang kamu alami, dan apa yang kamu pikirkan.
Jangan takut untuk punya opini yang berbeda!
Baca juga panduan membuat video untuk developer
Di dunia penulisan, ada yang namanya “SFD” alias “shitty first draft”.
Jika kamu baru saja selesai menulis, katakan ke diri kamu “Bagus, kamu sudah menulis versi pertama”.
Siap-siap berganti peran, menjadi seorang editor.
Apa yang perlu kamu lakukan sebagai editor?
Baca juga untuk apa developer menulis
Tulisan akhir yang baik, adalah tulisan yang sudah disunting. Pikirkan apa kalimat kamu yang bisa dihilangkan? apa poin yang sudah disampaikan berulan-ulang? Apakah ada bagian yang bisa disederhanakan?
Jangan langsung berekspektasi tinggi jika kamu baru menulis. Kalau otot untuk besar perlu rajin ke gym (bukan hanya satu kali), maka untuk melatih skill menulis kamu, perlu menulis yang banyak.
Bukan satu kali, lalu berharap langsung bagus
Kamu akan menulis banyak tulisan yang jelek, sampai kamu bisa menulis tulisan yang bagus.
Jika kamu tertarik dengan dunia kepenulisan, pelajari juga cara “menulis yang baik” dari berbagai penulis lain.
Kamu bisa belajar dengan membaca tulisan bagus yang banyak dan juga latihan menulis.
Semoga tulisan ini bisa membantu tulisan kamu. Silahkan bertanya atau berbagi seputar pengalaman menulis kamu!
Hai saya Hilman, membuat situs Sekolah Koding (Skodev) dan menulis buku untuk programmer (Halo Koding), Halo Koding . Sudah mengetik-ngetik alias programming sejak 2015. Semoga artikel dan situs ini bisa bantu karir kamu ya!