Tips menulis artikel atau tutorial tentang programming

Hai semuanya! untuk teman-teman yang suka berbagi ilmu, tentu media menulis sudah tidak asing lagi. Media pencari populer pun sampai saat ini pun masih berbasis text atau tulisan. Jadi wajar saja kalau kita masih terus memanfaatkan media tulisan seperti blog atau artikel untuk berbagi, termasuk untuk teman-teman di dunia programming.


Saya ada beberapa tips yang bisa kamu coba, jangan sungkan untuk membagikan apa yang sudah kamu dapatkan selama ini dan terlewatkan di sini.


[[table-content]]


Memilih topik yang ingin dibahas


Seringkali saat mengobrol atau menulis, tanpa sadar kita terlalu banyak membahas sesuatu, orang yang membaca pun akhirnya tidak fokus. Sangat penting untuk kamu menentukan poin-poin apa sebenarnya inti dari tulisanmu. Jangan terbawa suasana. Jika terlalu panjang kamu bisa membaginya ke beberapa artikel. Jika pendek, itu semakin bagus, karena kebanyak orang pun ingin mencari "inti" dari pertanyaan yang ingin dia jawab.


Mengetahui level target pembaca


Jika tidak mengetahui target pembaca sebenarnya, akhirnya kita akan membuat konten yang "terlalu mudah atau terlalu susah" untuk salah satu pihak. Atau yang sering terjadi, kamu menjadi membahas sesuatu dari awal (dari sangat dasar) padahal poin dari artikel kamu bukan hal tersebut.


Sebagai contoh kamu ingin mengajarkan bagaimana membuat sistem drag dan drop gambar dengan javascript. Tapi kamu selalu menulis "jika kamu tidak tahu apa itu javascript" atau "kalau kamu belum tahu apa itu event, event adalah....". Akhirnya kita menjelaskan semuanya dari awal lagi. Padahal bukan itu poinnya. Bikin asumsi di awal, siapa yang ingin kamu ajarkan, apakah orang yang sudah mengerti javascript? atau yang belum. Sehingga kamu tidak kehilangan pembaca di tengah jalan.


Membagikan kode jika perlu


Artikel yang membahas seputar teknikal kode, jangan lupa menyelipkan kode agar bisa dilihat langsung. Menjelaskan hal yang teknikal tanpa memperlihatkan kode aslinya akan sulit untuk dicerna.


Sebagai contoh kita mau membahas "fungsi drag dan drop javascript", maka saya akan memperlihatkan kodenya seperti ini misalnya:


function drop(ev) {
  ev.preventDefault();
  var data = ev.dataTransfer.getData("text");
  ev.target.appendChild(document.getElementById(data));
}


Memberikan analogi sederhana


Tidak semua konsep yang ada di programming mudah dipahami begitu saja. Untuk membantu orang lain mencernanya, berikan analogi atau permisalan sederhana.


Sebagai contoh kita ingin mengenalkan konsep array. Kita bisa bilang “bayangkan ada beberapa kotak”, sehingga pembaca atau penonton bisa membayangkan “oh.. array ini seperti tempat penyimpanan”


Pastikan memberi contoh yang memang mudah dipahami, jangan sebaliknya justru semakin membuatnya kompleks


Jangan takut berbagi


Apa yang menurut kamu sudah jelas, belum tentu untuk orang lain.

Apa yang menurut kamu mudah, bisa jadi sulit untuk orang lain.

Jangan malu atau takut membagikan apa yang kamu tahu.

Mengajar atau berbagi bukan sok pintar,

justru sebaliknya,

dengan berbagi kita siap menerima masukan dan belajar dari orang lain


Selamat menulis dan berkarya!


menulis softskill
avatar hilmanski

Ditulis oleh @hilmanski

"luaskan ilmu & luaskan manfaat"