evilfactorylabs

loading...
Cover image for Tentang menulis tulisan teknis

Tentang menulis tulisan teknis

Rizaldy
such bio
・6 min read

Halo,

Perkenalkan gue @faultable dan di komunitas ini gue akan mencoba membantu untuk menuntun rekan komunitas sekalian untuk dapat berbagi pengetahuan dan pengalaman yang dimiliki, menggunakan media tulisan.

Ketika membuat tulisan tidak jarang ada pertanyaan "Gue nulis tentang ini layak untuk dibagikan gak, ya? yang seringkali ditanyakan kepada diri sendiri (yang mungkin karena memiliki keraguan) dan jika misalnya gue boleh menjawab, jawabannya adalah: Hell yes.

Berbagi adalah tentang "pemindahan" informasi dari pemberi ke penerima. Tugas paling berat dari berbagi adalah memastikan bahwa si penerima dapat menerima informasi dengan baik; jelas, dan yang paling penting: sesuai harapan.

Kabar buruknya, setiap orang memiliki cara menerima informasi yang berbeda-beda. Mungkin beberapa ada yang lebih suka dengan yang singkat-jelas-padat dan beberapa mungkin ke panjang-detail-mendasar. Namun kabar baiknya, kamu tidak perlu menganggap bahwa semua peserta adalah penontonmu, sebagaimana ketika menonton sebuah konser.

Namun bagi yang baru memulai, bagian ini pun masih relatif sulit untuk dilewati. Banyak cara untuk menghadapinya, namun jika gue boleh memberikan saran: jadikanlah dirimu sebagai penonton VIP alias kamu menulis untuk dirimu sendiri yang mana memindahkan informasi dari yang ada dipikiranmu ke sebuah media dalam bentuk tulisan.

Karena kamu yang paling mengetahui & mengerti dirimu sendiri dan dirimu yang lain sedang duduk menunggu pertujukanmu di kursi VIP, so, do your best.

Baiklah, jika kamu sudah memiliki alasan mengapa ingin berbagi dalam bentuk tulisan dan sudah memiliki energi untuk melakukannya, luangkan waktu 5 menit kedepan terlebih dahulu untuk menghindari kehilangan arah karena gue ingin berbagi peta yang biasa gue gunakan ketika membuat sebuah tulisan.

Menentukan maksud

Sederhananya, ini adalah tentang "apa yang ingin lo bagikan?" secara umum. Ingin menjelaskan Y dengan bahasa dan gayamu sendiri? Ingin membagikan pengalamanmu terkait X? Ingin memberikan pendapat terkait mengapa X dan bukan Y?

Gue ada 3 contoh tulisan yang pernah gue terbitkan di blog pribadi terkait 3 hal diatas:

  • Menjadikan Raspberry Pi sebagai router, sudah banyak artikel di internet tentang membuat router menggunakan Raspberry Pi, dan gue ingin memastikan diri gue bahwa gue memahami konsep router secara high-level seperti dari DHCP sampai ke netfilter, menggunakan bahasa, gaya, dan tools yang cocok untuk gue sendiri
  • Apakah saya butuh CDN?, ini pun pastinya sudah banyak artikel yang membahas tentang ini di internet yang menggunakan judul yang cta-able yang diterbitkan oleh penyedia web hosting ataupun CDN (yang besar kemungkinan jawabannya adalah "yes"). Ditulisan tersebut, gue mencoba berbagi pengalaman secara netral sebagai seorang operator yang menjalankan layanan di internet.
  • Apa & Mengapa menggunakan Tailscale, ditulisan ini meskipun gue tidak menjelaskan secara eksplisit alternatif yang dibandingkan, setidaknya semoga dapat memberikan sedikit gambaran terkait adanya sebuah perbandingan.

Menentukan maksud di awal dapat membantu kita (sebagai pemberi informasi) untuk tetap berada di konteks, seperti kita tidak perlu menjelaskan mengapa typeface di logo Nginx tidak menggunakan Helvetica ketika sedang berbagi tentang "menangani 1000 permintaan per-detik menggunakan Nginx dan Blockchain".

Jika kita sudah menentukan maksud dari apa yang ingin kita bagikan, let's move off.

Menentukan judul

Judul memang penting, namun yang gue yakin, tidak sepenting itu.

Gue yakin pasti ada yang membaca tulisan ini sekalipun judulnya adalah HeLL0 w0Rld ¯\(ツ)/¯ DCLXVI yang hanya tuhan dan @ri7nz yang mengerti maksudnya, anyway.

Menentukan judul berarti kita memberikan gambaran secara singkat tentang pemeran utama yang ada. Apakah itu Nginx? Apakah itu TypeScript? Apakah itu GCP? Apakah itu HeLL0 w0Rld ¯\(ツ)/¯ DCLXVI????

Seringkali kita tertarik ketika melihat ada kata kunci yang ada di sebuah judul (citation needed, GFY HN readers!) seperti jika kita tertarik dengan Postgres, tulisan apapun selagi membahas tentang Postgres, kemungkinan besar akan kita kunjungi.

Dan gue secara pribadi sangat membenci judul yang bersifat click-bait sekaligus membenci judul yang terlihat membosankan. Seperti, daripada menentukan tulisan yang berjudul "Membuat aplikasi Android menggunakan React Native" gue lebih suka dengan judul "Membuat dating app menggunakan Kotlin".

Ummm sorry maksud gue "Membuat dating app menggunakan React Native" ketika menjadikan "React Native" sebagai pemeran utama dan bukan si "Android" nya.

Sebagian orang percaya bahwa jika konten adalah raja maka judul adalah ratunya. Yes, but no. Gue termasuk orang yang percaya bahwa "distribusi" adalah ratunya, dan distribusi tidak selalu tentang SeaRcH eNginE OptiMization.

Sebagai kesimpulan, kamu bisa melewati terlebih dahulu penentuan judul ini ketika kamu sudah benar-benar mengetahui apa yang ingin kamu bagikan, sehingga kamu mungkin dapat menentukan judul yang 4 sehat 5 sempurna.

Namun jika belum, kamu bisa menentukan judul sesuka hatimu saja. Masih ingat kan jika dirimu sendirilah si penonton spesial tersebut?

Meracik kata, bahasa, dan tanda baca

Gue tipe orang yang praktikal, dan tidak menempuh pendidikan formal terkait sastra. Dalam menulis, gue selalu memilih kata yang biasa gue gunakan di dunia nyata, dalam komunikasi verbal.

oke tapi dengan sedikit saringan sejujurnya karena mulut gue sedikit kotor

Gue secara pribadi dalam menggunakan bahasa, memilah kata, dan menentukan tanda baca, sejujurnya menggunakan prinsip sakumaha aing weh alias sesuka gue. Gue menggunakan bahasa yang benar-benar gue pahami, memilih kata yang benar-benar nyaman untuk gue, dan menentukan tanda baca yang sekiranya relevan sehingga gue bisa memberikan instruksi secara implisit kepada pembaca kapan harus terus melanjutkan dan kapan harus berhenti berharap dan mundur.

Karena yang gue yakin, gue bukan sedang membuat paper ataupun menyusun tesis yang mungkin harus menggunakan EYD yang benar dan bahasa yang baik. Gue selalu menganggap bahwa berbagi dalam bentuk tulisan ini seperti sedang mengobrol dengan orang lain (atau diri sendiri lebih tepatnya) yang mana menggunakan bahasa sehari-hari yang mudah diterima & dimengerti.

Tentu ini bukanlah praktik terbaik, dan gue hanya memberikan sedikit pedoman.

Jangan perfeksionis

Karena kesempurnaan yang ada di dunia ini hanyalah ketidaksempurnaan (citation needed!!!).

Dalam konteks menulis, terkadang kita terbunuh oleh asumsi-asumsi yang salahsatunya menyebabkan tulisan tersebut hanya sampai di status draft. Entah sebuah perasaan bahwa tulisanmu kurang jelas, sebuah pemikiran bahwa tulisanmu terlalu singkat, sebuah bisikan bahwa topik pembahasanmu kurang menarik, apapun.

Mantranya untuk menepis asumsi-asumsi tersebut gue rasa satu: persetan.

Yang gue yakini, manusia selalu tumbuh; berkembang dan belajar. Dan juga, pasti pernah membuat sebuah kesalahan.

Asumsi-asumsi yang ada dipikiran lo tersebut gue rasa hal yang wajar karena bukankah kita cenderung khawatir terhadap apapun yang bersifat ketidakpastian?

Kabar baiknya, sesuatu yang paling pasti di dunia ini hanyalah ketidakpastian, klo menurut orang random bernama Albert Einstein. Yang berarti, seharusnya tidak ada yang pasti di dunia ini.

Jadi, ya, persetan dengan asumsi. Kamu tidak perlu menjadi data-driven untuk menentukan hal yang ingin dibagikan dengan cara riset pasar; menganalisa semantik penulisan, ataupun mengalanisa terkait pemilihan topik yang ingin kamu bagikan.

Cukup bagikan. Setiap penampilan pasti memiliki penontonnya masing-masing.

Just let it flow

Ini yang terakhir, just let it flow.

Dan yang paling penting, gue rasa, jangan jadikan aktivitas berbagi dalam bentuk tulisan ini menjadi aktivitas yang menyebalkan.

Jika dirasa seperti itu, mungkin bisa coba untuk dibiasakan dulu. Jika masih, mungkin tulisan bukanlah media yang cocok untukmu.

Setiap kali gue menerbitkan tulisan, perasaan yang gue rasakan adalah bahagia, termasuk ketika masih dalam proses menulis tersebut.

Tidak jarang gue menyisipkan sedikit lelucon untuk lebih merenyahkan suasana yang gue yakini lelucon tersebut bersifat lucu (atau setidaknya lucu dalam pikiran sendiri, kalau mengutip dari sang pengamat @ervan0707 ).

Apapun yang terjadi, biarkanlah terus mengalir. Seiring berjalan waktu, gue yakin kita akan memiliki topik yang sangat antusias untuk kita bagikan; kita akan mendapatkan pembaca yang tertarik dengan tulisan kita (terlepas tentang apa yang kita tulis), mendapatkan "suara dan nada" yang cocok dengan personalitas kita, dan akan mendapatkan timbal balik terkait apa yang kita lakukan (dalam bentuk apapun itu).

Yang pasti, teruslah berpraktek. Berlatih. Berkembang.

Dan yang paling penting, harus membahagiakan~

Penutup

Gue mohon maaf jika tulisan ini tidak membahas terkait "menulis tulisan teknis" sebagaimana yang dijanjikan di judul ini.

Namun yang menariknya, mungkin kamu masih terus membaca bahkan sampai di paragraf ini.

Sekali lagi, gue masih yakin kalau judul memang penting, namun tidak sepenting itu. Maksud gue dalam menerbitkan tulisan ini adalah untuk merangkul pembaca untuk mulai membagikan apapun yang ingin dibagikan dalam bentuk tulisan, di situs ini.

Jika maksud gue tersebut ternyata tidak sampai ke pemikiran pembaca alias menjadi salah paham, please let me know dan bisa pertimbangkan untuk menyuarakannya di kolom komentar dibawah.

Dan jika ternyata tidak menjadi kesalahpahaman, give me some love by clicking on one of the available reactions on the side (atau bisa dengan menuliskan komentar juga!).

Jika ada yang ingin ditanyakan; memberikan kritik/saran, juga bisa suarakan dikolom komentar, oke?

Sebagai penutup, semoga tulisan ini bisa menjadi salah satu batu loncatan pertama kamu dalam aktivitas berbagi dalam bentuk tulisan.

Jadi, gimana? Udah siap berbagi, ya?

Discussion (0)