< Kembali

Panduan Menulis Artikel Pemrograman

✏️ Edit catatan ini.

Berikut adalah panduan singkat dalam menulis artikel pemrograman. Jika teman-teman memiliki pengalaman atau pengetahuan tertentu mengenai pemrograman dan ingin membagikannya untuk teman-teman lainnya, teman-teman dapat merumuskan pengalaman tersebut kedalam sebuah tulisan. Dengan demikian pengetahuan ataupun pengalaman tersebut akan lebih berguna.

Artikel ini disadur dari talk yang dibawakan oleh Rachel Nabors.

Pemilihan Topik

Pertanyaan paling sering muncul biasanya ketika ingin menulis, mengisi acara, talk, meetup, konferensi dan lain sebagainya adalah bagaimana memilih topik yang tepat.

Disaat kita baru belajar sebuah topik dan seolah kita sangat bersemangat untuk membangikan apa yang baru kita pelajari kepada banyak orang biasanya dapat menjadi sumber inspirasi untuk menulis sebuah artikel.

Inspirasi berikutnya yang tidak kalah menarik adalah ketika kita melakukan kesalahan dalam pekerjaan dan juga dapat dibungkus menjadi sebuah topik. Dilengkapi dengan solusi bagaimana menyelesaikan masalah tersebut tentunya.

Atau kamu baru saja berhasil menyelesaikan masalah tertentu di kantor. Pengalaman menyenangkan tersebut juga dapat menjadi topik pilihan.

Atau mungkin ketika googling ataupun membaca sebuah tutorial, kita seringkali berharap ada yang membahas sebuah topik dengan pendekatan yang berbeda, atau dengan studi kasus yang berbeda.

Nah ini kesempatan buat kita untuk membuatnya menjadi bentuk artikel atau tulisan. Buatlah tutorial yang diharapkan ada namun belum ada yang membuatnya.

Mungkin saja artikel ini sudah tersedia dalam bahasa selain bahasa Indonesia, kita bisa membuat versi bahasa Indonesia-nya. Namun jangan hanya melakukan translasi. Modifikasi juga agar sesuai dengan kebutuhan dan dengan bahasa kita sendiri.

Target Pembaca

Sebaiknya tentukan target pembaca ketika menulis sebuah artikel. Sehingga kita bisa berasumsi bahwa pembaca sudah mengenal terminologi atau konsep yang akan kita bahas. Sehingga sekiranya kita memperkenalkan konsep yang masih asing, kita bisa membahasnya lebih mendalam untuk target pembaca tersebut.

Dan tentunya pemilihan bahasa yang nyaman untuk digunakan atau dibaca oleh calon pembaca kita sesuai dengan targetnya. Jika artikel ditujukan untuk pembaca dari Indonesia, cobalah untuk menyajikan dengan Bahasa Indonesia. Jika artikel atau tutorial ditujukan untuk semua kalangan, menggunakan bahasa Inggris adalah ide yang baik.

Gunakan Struktur Yang Umum Digunakan

Artikel yang baik memiliki struktur yang jelas. Disadari atau tidak, ada tiga bagian utama: pembuka, inti, dan penutup atau kesimpulan.

Bagian Pembuka

Bagian pembuka sangat penting karena akan menentukan artikel kita menarik untuk dibaca atau tidak. Bagian pembuka yang baik biasanya dapat menjawab pertanyaan tentang: apa, kenapa, siapa, kapan, dimana dan bagaimana. Hal ini lazim disebut dengan istilah 5W & 1H.

Contohnya teman-teman bisa menulis tentang siapa target pembaca, apa saja yang akan dipelajari, kenapa topik ini penting, kapan topik ini akan berguna, dimana akan digunakan dan bagaimana implementasi diluar contoh tutorial ini.

Bagian Utama

Inti dari artikel juga butuh struktur yang kokoh. Strukturnya terdiri dari tiga bagian:

  1. Pengenalan konsep baru,
  2. Contoh kode,
  3. Penjelasan rinci dari beberapa baris kode yang dicontohkan
  4. Ulangi hingga artikel selesai

Struktur Artikel

Bagian Penutup

Bagian yang tidak kalah penting adalah bagian penutup atau kesimpulan. Di bagian ini kita akan menjabarkan apa saja yang sudah kita bahas sebagai pengingat. Bisa juga ditambahkan artikel terkait jika pembaca ingin menggali lebih dalam tentang materi pembahasan.

Contoh Interaktif

Apabila memungkinkan gunakan contoh kode yang interaktif. Teman-teman bisa menggunakan servis seperti codesandbox, codepen, expo snack dan lain sebagainya sehingga pembaca dapat menjalankan contoh kode dan dapat melihat hasilnya.

Gunakan Ilustrasi

Menurut Dr. Lynell Burmark, kata-kata diproses oleh short-term memory yang hanya dapat bertahan kurang-lebih dua menit saya. Sedangkan ilustrasi atau gambar langsung masuk ke long-term memory dan dapat lebih lama untuk diingat oleh otak kita.

Jadi gunakanlah ilustrasi sesering mungkin. Tidak perlu terlalu artistik dan harus membayar ilustrator untuk artikel kita, bisa gunakan servis seperti excalidraw, draw.io dan lain sebagainya untuk menggambarkan konsep yang ingin kita bahas.

Kesimpulan

Demikian panduan untuk menulis artikel pemrograman. Kita sudah membahas tentang bagaimana memilih topik, menentukan target pembaca, menyusun struktur, menggunakan contoh yang interaktif, dan juga ilustrasi agar artikel atau tutorial lebih menarik.

Berikut checklist untuk membuat artikel: