Daftar Isi:
Developer Enggak suka bertele-tele. Ketika mencari jawaban dari pertanyaan, kita Dapat Loncat ke bagian jawaban Stackoverflow. Butuh informasi, Dapat langsung ke bagian dokumentasi yang relevan.
Bagaimana dengan tulisanmu? Tetap banyak tulisan yang Membangun perkenalan panjang atau mengulang Segala konsep sebelum menyampaikan poinnya. Karena itu Krusial Kepada developer mengerti Langkah menulis yang disukai oleh developer lainnya.
Konteks: Saya sudah bertahun-tahun menulis blog pemrograman dan menerbitkan Kitab Halo Koding.
Mengetahui level pembaca
Setiap tulisan Eksis Sasaran pembaca atau audience-nya. Kalau Enggak, maka yang akan terjadi:
- Orang Ahli akan Jenuh membaca konsep-konsep yang sudah diketahui
- Pemula akan bingung dengan materi yang disampaikan.
Tentukan Kepada siapa Anda menulis materi tersebut.
Teladan: Anda Ingin membahas “async pada NodeJS”, maka Enggak perlu Tengah membahas Nodejs secara detail, cukup 1-2 kalimat intro saja.
Gunakan bahasa yang sederhana
Tulisan kita Eksis Kepada dibaca orang. Pastikan menggunakan bahasa yang ringan dan mudah dimengerti. Hindari menggunakan Ungkapan-Ungkapan yang orang lain Enggak familiar.
Hindari materi bercabang
“Bagaimana Kalau Eksis materi bercabang yang harus disampaikan?”
Anda Dapat menjelaskan dengan sederhana, satu atau dua kalimat. Dapat juga menuliskannya Kepada materi (postingan) yang terpisah, Lampau memberi link ke sana.
Teladan: Misalnya Anda menulis tentang “memori heap dan stack”, maka Enggak perlu membahas seputar apa itu CPU, apa itu Monitor, kecuali pada bagian yang relevan seperti menceritakan alur kerja.
Enggak berbohong
Jangan memberi judul yang “WAH”, Tetapi poinnya Enggak Eksis di sana. Pembaca akan kecewa berat. Sifat seorang developer pun yang Normal sharing, Dapat merugikan Anda Kalau Anda punya Imej negatif.
Enggak bertele-tele
Jangan menulis 3-4 paragraf perkenalan tanpa poin yang Niscaya di sana.
- Berikan judul dan subjudul yang relevan
- Berikan versi “TL,DR” (too long, didn’t read), yang Dapat mewakili materimu.
- Jangan bercabang menjelaskan sesuatu, Konsentrasi pada intinya. Tetapi tetap, menjaga konteks agar pembaca mengerti.
Show, don’t tell
Perlihatkan, jangan ceritakan. Perlihatkan kodenya, perlihatkan hasilnya, termasuk errornya.
Jangan berbicara panjang yang Membangun orang jadi harus membayangkan berlapis-lapis. Kalau perlu, sertakan kode, gambar, demo yang mendukung.
Sediakan kode… yang berjalan
Developer akan kesal Kalau hasil usaha (copy-paste) di internet, Enggak berjalan.
Pastikan demo Anda Eksis konteksnya, apa yang harus diinstall, yang harus dilakukan sebelum asal copy-paste kode tersebut.
Pastikan juga demo-nya terlah berjalan dengan Bagus, sebelum membagikannya.
Buat kode Anda Kepada mudah disalin.
Bagi ke poin-poin yang Terang
Buat konten Anda dengan poin-poin yang mudah diikuti. Jangan langsung menulis 1000 kata blog post tanpa Eksis heading di sana.
Karena itu sebelum menulis, Tegur seperti koding, pecahkan masalah yang Ingin Anda bahas, menjadi masalah-masalah kecil. Sehingga mudah Kepada Anda tuangkan menjadi tulisan.
Bagi materi ke sub bagian (h2, h3) agar mudah dipahami. Beri judul heading yang relevan Kepada poin yang Ingin dibahas.
Pada umumnya, plaftorm blog atau dokumentasi, menyediakan “table of content” Mekanis yang memperlihatkan apa saja heading
dari tulisan ini.
Senada dengan versi TL;DR, pembaca Dapat “skim” atau scan konten yang akan dia baca.
Bermain dengan format
Kepada menghindari rasa Jenuh Ketika membaca, mainkan formatnya.
- Gunakan format bold Kepada bagian Krusial
- Gunakan garis miring yang inging dihighlight
- Gunakan “quote” Kepada penekanan atau kutipan
- Gunakan gambar/video/GIF/kode Kepada visual
- Gunakan list seperti ini Kepada memberi Mengerti beberapa hal
- dan lainnya!
Berikan analogi sederhana
Analogi adalah permisalan. Berikan Teladan di dunia Konkret dalam menjelaskan konsep.
Teladan: Misalnya saya Ingin menjelaskan konsep async
, saya Dapat memberi analogi berikut:
Bayangkan kita ke restoran, seorang pelayan Dapat menerima pesanan setiap customer yang data, Lampau menyajikannya pada Ketika Eksis makanan yang sudah siap. Inilah async.
Bedakan, Kalau pelayan ini menerima order dan menunggu makanan tersebut jadi, baru melayani pelanggan berikutnya. Tentu akan lelet, karena restorannya Enggak memaksimalkan waktunya
Analogi ini saya dapatkan dari video youtube bertahun-tahun Lampau ketika saya baru belajar konsep NodeJS, Tetapi Tetap melekat hingga sekarang.
Berbagi pengalaman personalmu
Eksis banyak orang yang Dapat menulis materi tertentu. Apa yang membuatnya Aneh dan berbeda? pengalaman pribadi Anda.
Anda Dapat berbagi pengalaman Anda, apa yang Anda lakukan, apa yang Anda pelajari, apa yang Anda alami, dan apa yang Anda pikirkan.
Jangan takut Kepada punya opini yang berbeda!
Baca juga panduan Membangun video Kepada developer
Edit tulisanmu
Di dunia penulisan, Eksis yang namanya “SFD” alias “shitty first draft”.
Kalau Anda baru saja selesai menulis, katakan ke diri Anda “Bagus, Anda sudah menulis versi pertama”.
Siap-siap berganti peran, menjadi seorang editor.
Apa yang perlu Anda lakukan sebagai editor?
- Baca ulang tulisan Anda
- Pastikan poinnya tersampaikan dengan Bagus
- Catat apa yang perlu ditambahkan
- Cata apa yang perlu dikurangi
- Apakah Eksis typo?
- Apakah Eksis bagian yang Dapat disederhanakan?
- Setelah “edit pertama”, lakukan Tengah “edit kedua”.
Baca juga Kepada apa developer menulis
Apa yang perlu Anda kurangi?
Tulisan akhir yang Bagus, adalah tulisan yang sudah disunting. Pikirkan apa kalimat Anda yang Dapat dihilangkan? apa poin yang sudah disampaikan berulan-ulang?
Apakah Eksis bagian yang Dapat disederhanakan?
Tips Kepada pemula
Jangan langsung berekspektasi tinggi Kalau Anda baru menulis. Kalau otot Kepada besar perlu Giat ke gym (bukan hanya satu kali), maka Kepada melatih skill menulis Anda, perlu menulis yang banyak.
Bukan satu kali, Lampau berharap langsung bagus
Anda akan menulis banyak tulisan yang jelek, Tamat Anda Dapat menulis tulisan yang bagus.
Pro tips
Kalau Anda tertarik dengan dunia kepenulisan, pelajari juga Langkah “menulis yang Bagus” dari berbagai penulis lain.
Anda Dapat belajar dengan membaca tulisan bagus yang banyak dan juga latihan menulis.
Terima kasih sudah membaca!
Semoga tulisan ini Dapat membantu tulisan Anda. Silahkan bertanya atau berbagi seputar pengalaman menulis Anda!