Apa Itu Penulisan Teknis? Panduan Lengkap

Apabila Anda kesulitan dengan gadget baru, Anda akan mencari buku panduannya.

Apabila Anda mengalami kesulitan dalam menyiapkan perangkat lunak, Anda dapat memeriksa halaman bantuan.

Ketika mobil Anda mengeluarkan suara yang aneh, Anda membuka-buka buku panduan kotak sarung tangan.

Semua ini adalah contoh dari penulisan teknis - sesuatu yang kita andalkan setiap hari namun jarang kita pikirkan.

Menurut Glassdoor, seorang penulis teknis di SpaceX mendapatkan penghasilan antara $88.000 hingga $138.000 per tahun. 

Namun, kebanyakan orang masih belum memahami apa itu penulisan teknis.

Ini bukan hanya mengetik instruksi.

Ini bukan hanya menerjemahkan insinyur berbicara ke dalam bahasa Inggris.

Dan itu bahkan bukan hanya menciptakan panduan pengguna atau dokumen bantuan. 

Jadi, apa yang dimaksud dengan penulisan teknis? Apa bedanya dengan jenis tulisan lainnya? Apa saja bentuk-bentuknya yang berbeda? Bagaimana Anda bisa menjadi penulis teknis? Dan bagaimana AI dapat membantu di sepanjang prosesnya? 

Kami akan membahas semua itu - dan masih banyak lagi - dalam blog ini. Mari kita selami! 

Apa Itu Penulisan Teknis?

Dalam istilah awam, penulisan teknis berarti mengambil topik-topik yang rumit dan mendetail dan menjelaskannya dengan cara yang dapat diikuti oleh siapa saja (dengan latar belakang yang tepat). 

Sebagai contoh, ini termasuk:

• Panduan Pengguna - Buklet yang disertakan dengan ponsel Anda? Itu adalah tulisan teknis.
• Dokumentasi API - Para pengembang juga membutuhkan instruksi. API tidak menjelaskan dirinya sendiri.
• Laporan Teknis - Para insinyur dan ilmuwan mengandalkan ini untuk berbagi penelitian dan temuan.

Penulisan teknis bukan hanya tentang apa yang Anda tulis, tetapi juga bagaimana Anda menulisnya. Ini menggunakan:

• Suasana Hati Imperatif - Alih-alih "Anda harus mengklik tombol," itu hanya "Klik tombol." 

• Suara Pasif (Bila Diperlukan) - Jika siapa yang melakukan tindakan tidak menjadi masalah, kalimat pasif dapat membantu. "File telah dihapus" bekerja lebih baik daripada "Seseorang menghapus file" jika fokusnya adalah pada file.

Beberapa orang berpikir bahwa penulisan teknis hanyalah menulis untuk produk SaaS atau blog teknologi. 

Tapi ini bukan tentang pemasaran atau bercerita. 

Penulisan teknis memiliki jenis yang sangat berbeda (akan segera dibahas) - semuanya dengan tujuan yang sama: Menyajikan informasi dengan cara yang akurat, jelas, dan fungsional. 

Perbedaan Penulisan Teknis dengan Gaya Penulisan Lainnya

Mari kita pahami enam aspek yang membedakan penulisan teknis dengan gaya penulisan lainnya.

Penulis kreatif menggunakan ambiguitas atau metafora untuk memasukkan faktor yang menarik bagi audiens. 

Penulis teknis tidak menginginkan ambiguitas apa pun. 

Mereka ingin memprioritaskan kejelasan daripada ekspresi kreatif, tetapi itulah sifat karya ini. 

Mengapa Penulisan Teknis Sangat Penting di Berbagai Industri

Bayangkan seorang pilot membaca buku panduan ini di tengah penerbangan ketika dia perlu memahami sesuatu dengan segera:

"Sesuaikan vektor daya dorong untuk mengimbangi anomali propulsi asimetris dengan menerapkan protokol deviasi standar 5.3b dengan mempertimbangkan variabel kerapatan atmosfer"

Atau bayangkan seorang ahli bedah yang sedang meninjau panduan prosedur beberapa saat sebelum operasi penting: 

"Sayatan sejajar dengan bidang fasia dengan mempertimbangkan struktur neurovaskular yang mendasarinya sambil mempertahankan hemostasis selama urutan diseksi" 

Bahkan jika mereka adalah dokter atau pilot yang telah mempelajari hal ini sepanjang karier mereka, mereka tidak akan mau membaca ini dalam keadaan darurat. 

Hal ini menciptakan kebingungan, dan frustrasi, yang ingin dihindari oleh siapa pun, apa pun situasinya.

Mari kita lihat lima alasan utama mengapa penulisan teknis adalah suatu keharusan: 

1. Pengurangan Risiko & Kepatuhan - Dalam industri seperti perawatan kesehatan, keuangan, dan penerbangan, kesalahan tidak hanya merugikan, tetapi juga bisa mematikan. 
   • Sebagai contoh, Bagaimana jika perawat salah menafsirkan instruksi dosis karena kata-kata yang tidak jelas? Pendokumentasian yang tepat dapat mencegah kesalahan ini. 

2. Pelestarian & Transfer Pengetahuan - Orang meninggalkan pekerjaan, dipromosikan, atau pensiun. Namun apa yang terjadi dengan semua pengetahuan yang ada di kepala mereka? Mereka didokumentasikan dengan baik menggunakan tulisan teknis. Proses yang terdokumentasi dengan baik berarti orang berikutnya bisa masuk tanpa harus memulai dari awal.

3. Kepuasan Pelanggan & Pengurangan Biaya Dukungan - Pernah mencoba menyiapkan perangkat baru dan akhirnya menonton tutorial YouTube secara acak karena manualnya tidak masuk akal? Dokumentasi yang buruk membuat pelanggan frustrasi dan membebani tim dukungan dengan panggilan yang tidak perlu. Panduan yang ditulis dengan baik akan menyelamatkan semua ini. 

4. Perlindungan Hukum - Kontrak, kebijakan, dan pedoman keselamatan berfungsi sebagai bukti dalam perselisihan.
   • Sebagai contoh, jika sebuah perusahaan dituntut karena produk yang rusak, hal pertama yang diperiksa oleh pengacara adalah dokumentasi. Apakah petunjuknya memperingatkan tentang risiko? Apakah prosedur keselamatan diuraikan dengan jelas? Jika tidak, perusahaan berada dalam masalah.

5. Efisiensi Diperoleh Melalui Standardisasi - Bayangkan sebuah perusahaan di mana setiap departemen mengikuti sistem yang berbeda untuk tugas yang sama. Satu tim melacak data di spreadsheet, tim lain menggunakan perangkat lunak khusus, dan tim ketiga hanya "mengingat-ingat". Ini berantakan. Penulisan teknis memastikan bahwa proses-proses tersebut terstandardisasi, dapat diulang, dan terukur

Pada intinya, penulisan teknis membantu mencegah kebingungan, menghemat waktu, dan membuat orang tetap aman. 

Jenis-jenis Penulisan Teknis (Dengan Contoh)

Banyak orang mendengar "penulisan teknis" dan langsung berpikir tentang manual pengguna yang kering dan robotik-jenis yang tidak pernah dibaca oleh siapa pun kecuali mereka benar-benar buntu. 

Namun, penulisan teknis lebih dari itu. 

Pada kenyataannya, hal ini ada di hampir setiap industri dan hadir dalam berbagai bentuk yang berbeda, masing-masing memiliki tujuan yang berbeda.

Berikut ini adalah enam jenis penulisan teknis yang paling penting (dengan contoh):

1. Dokumentasi Teknis - Ini adalah tipe klasik. Ini termasuk panduan pengguna, panduan produk, dan petunjuk pemecahan masalah.  
   • Sebagai contoh, Anda baru saja membeli mesin espresso baru, dan Anda bingung dengan banyaknya tombol. Daripada menebak-nebak, Anda membuka buku petunjuk dan mengikuti panduan langkah demi langkah untuk membuat secangkir kopi pertama Anda.
     
2. Dokumentasi Proses - Setiap perusahaan memiliki alur kerja, namun jika alur kerja tersebut hanya ada di kepala seseorang, itu adalah bencana yang menunggu untuk terjadi. Ini disebut SOP. 
   • Sebagai contoh, Anda harus membuat penghuni pertama khas toko roti. Tanpa SOP, setiap roti akan berbeda. Untungnya, SOP merinci setiap langkah-pengukuran yang tepat, waktu mengembang, suhu pemanggangan-setiap saat.
     
3. Dokumentasi API - Jika perangkat lunak adalah otak, API (Antarmuka Pemrograman Aplikasi) adalah sistem saraf. 
   • Sebagai contoh, Aplikasi rideshare menginginkan data lalu lintas waktu nyata, sehingga mereka mengintegrasikan API Google Maps. Tanpa dokumen API yang jelas, mereka akan menghadapi uji coba tanpa akhir.
     
4. Makalah Ilmiah/Penelitian - Ini ditulis oleh para peneliti tetapi harus dapat dibaca oleh dunia.  
   • Sebagai contohSebuah pengobatan kanker baru terlihat menjanjikan, tetapi sebelum digunakan, para ilmuwan harus mempublikasikan penelitian tentang cara kerjanya, efek samping, dan tingkat kelangsungan hidup. Yang lain meninjau data untuk memverifikasinya.
     
5. Buku Putih & Studi Kasus - Buku putih adalah "argumen yang meyakinkan" dari dunia teknis. Studi kasus membawanya lebih jauh, menunjukkan kisah sukses dunia nyata dengan hasil yang sebenarnya. 
   • Sebagai contoh, Sebuah perusahaan keamanan siber memperingatkan tentang ancaman perbankan baru dalam sebuah laporan resmi. Sebulan kemudian, mereka membagikan studi kasus tentang bagaimana alat mereka menghentikan serangan. Bank-bank mulai memperhatikan.
     
6. Dokumentasi Peraturan/Kepatuhan - Layanan kesehatan, keuangan, dan manufaktur bergantung pada peraturan. Dokumen kepatuhan membantu perusahaan mematuhi hukum, menghindari denda, tuntutan hukum, dan bencana publik.
   • Sebagai contoh, Perusahaan farmasi harus membuktikan bahwa obat penghilang rasa sakit yang baru aman sebelum menjualnya. Mereka menyerahkan dokumen yang berisi daftar bahan, dosis, dan efek samping untuk menghindari masalah hukum.

Keahlian Utama yang Dibutuhkan untuk Penulisan Teknis

Jika Anda pernah mengajari kakek dan nenek Anda cara menggunakan ponsel pintar tanpa membuat mereka merasa bodoh, maka Anda bisa menjadi seorang penulis teknis karena ini adalah keterampilan inti.

Setiap keterampilan lainnya dapat dipelajari. Berikut adalah daftar keterampilan yang harus dimiliki oleh seorang penulis teknis:

• Kemampuan Penelitian - Anda tidak perlu mengetahui semuanya, tetapi Anda perlu mengetahui cara menemukan informasi yang akurat dan dapat diandalkan.
  
• Analisis Pemirsa - Mengetahui siapa pembaca Anda, apa yang telah mereka ketahui, dan apa yang perlu mereka capai adalah hal yang membuat tulisan Anda berguna. Karena cara Anda menjelaskan pembaruan perangkat lunak kepada pengembang tidak sama dengan cara Anda menjelaskannya kepada pelanggan.
  
• Komunikasi yang Jelas/Keterampilan Bahasa yang Sederhana - Penulisan teknis bukanlah tentang terdengar pintar - ini tentang membuat orang lain merasa pintar. Ini berarti menghilangkan jargon, menggunakan bahasa yang sederhana, dan menulis dengan sangat jelas sehingga pembaca tidak perlu menebak-nebak apa yang Anda maksud.
  
• Arsitektur Informasi - Pembaca tidak selalu membaca dari awal hingga akhir, mereka memindai. Anda harus memahami cara mengatur konten dengan judul, poin-poin penting, dan alur yang logis sehingga informasi mudah ditemukan dan dicerna.
  
• Komunikasi Visual - Terkadang, sebuah gambar menjelaskan sesuatu lebih cepat daripada sebuah paragraf. Diagram alir, tangkapan layar beranotasi, dan infografis dapat menyederhanakan konsep yang paling membingungkan sekalipun. Penulis teknis yang baik tahu kapan harus menulis dan kapan harus menunjukkan.
  
• Kemahiran Alat - Mengetahui alat bantu yang tepat akan mempercepat proses. Sebagai contoh, perangkat lunak dokumentasi termasuk MadCap Flare atau Confluence, dan alat bantu desain adalah Snagit atau Figma.

• Keterampilan Pengeditan dan Revisi-Draf pertama tidak pernah sempurna. Penulis teknis harus menyempurnakan pekerjaan mereka untuk kejelasan, ketepatan, dan kelengkapan, memastikan setiap kata memiliki tujuan. Ini adalah tentang membuat dokumen semudah mungkin untuk digunakan.

Siapa yang Menggunakan Penulisan Teknis? (Industri yang Membutuhkannya)

Berikut adalah empat industri teratas yang paling banyak membutuhkan penulisan teknis.

Cara Menjadi Penulis Teknis 

Berikut adalah panduan langkah demi langkah untuk memasuki bidang ini:

Langkah # 1 - Pelajari Dasar-dasarnya

Anda tidak memerlukan gelar sarjana komunikasi atau literasi bahasa Inggris untuk memulai.

Anda dapat melangkah dan berkembang dalam karier ini meskipun Anda seorang guru, jurnalis, insinyur, atau bahkan seseorang dari bidang medis.

Ikuti kursus dan sertifikasi yang ramah bagi pemula di Coursera, Udemyatau Kursus Penulisan Teknis Google. 

Ikuti blog industri seperti  Tulis Dokumen dan STC (Masyarakat untuk Komunikasi Teknis).

Langkah # 2 - Membangun Portofolio

Pilihlah produk yang Anda gunakan sehari-hari (misalnya, pembuat kopi, aplikasi kebugaran, atau speaker pintar), dan tulislah panduan pengguna atau panduan pemecahan masalah. 

Apakah itu sempurna? Tidak. 

Apakah itu akan memberikan sesuatu yang konkret untuk ditunjukkan? Tentu saja. 

Komunitas sumber terbuka seperti GitHub terbuka untuk penulis teknis baru. 

Banyak proyek yang sangat membutuhkan bantuan dokumentasi, dan mereka tidak peduli jika Anda baru. 

Langkah # 3 - Dapatkan Peran Tingkat Pemula

Fokus pada posisi dengan "junior" atau "associate" dalam judul pada platform seperti LinkedIn, Memangdan Kami Bekerja dari Jarak Jauh. 

Jangan abaikan juga posisi kontrak - posisi ini biasanya lebih mudah didapatkan dan dapat mengarah ke posisi permanen.

Langkah # 4 - Tingkatkan Karier Anda

Setelah Anda memiliki kepercayaan diri dan pengalaman, incarlah posisi penulis teknis senior, penulis API, atau penulis UX.

Biasakan diri Anda dengan alat-alat seperti MadCap Flaredan Oksigen XML untuk penulisan terstruktur atau Penurunan harga dan Git jika Anda ingin bekerja dengan pengembang. Tetapi Anda tidak harus menguasai semuanya sekaligus.

Langkah # 5 - Mempersiapkan Wawancara

• Pertanyaan umum meliputi:
  • Bagaimana Anda menyederhanakan topik yang kompleks? → Tampilkan contoh penulisan sebelum dan sesudah.
  • Alat apa saja yang pernah Anda gunakan? Sebutkan semuanya.
  • Bagaimana Anda menangani umpan balik dari para insinyur? → Berikan contoh nyata atau hipotesis. 

Langkah # 6 - Terus Belajar & Naikkan Level

Bidang ini terus berkembang. Satu tahun semua orang berbicara tentang wiki, tahun berikutnya tentang dokumen sebagai kode. 

Orang-orang yang berkembang adalah mereka yang terus meningkatkan keterampilan. 

Ikuti TechWhirl dan Cherryleaf untuk tren.

Mulai hari ini. Tulis ulang manual produk, bagikan di LinkedIn, dan minta umpan balik.

Alat & Perangkat Lunak Penulisan Teknis

Alat bantu AI membuat tugas Anda lebih mudah dan efisien - dan penulisan teknis juga demikian.

Berikut ini adalah alat bantu penulisan teknis yang digunakan oleh para profesional:

1. Untuk penyusunan & pengeditan konten:

1. MS Word memungkinkan Anda membuat dokumen yang diformat secara profesional dengan kontrol yang tepat atas gaya, header, dan referensi silang. 
2. Google Docs memungkinkan beberapa anggota tim untuk bekerja secara bersamaan pada dokumen yang sama. 

2. Untuk dokumentasi & penerbitan terstruktur: 

1. MadCap Flare memungkinkan Anda mengelola satu sumber konten yang secara otomatis menerbitkan ke berbagai format. 
2. Adobe FrameMaker menangani spesifikasi teknis setebal 500 halaman dengan tabel yang rumit, diagram khusus, dan referensi silang. 

3. Untuk dokumentasi berbasis tim:

1. Pertemuan menjadi wiki internal perusahaan Anda di mana berbagai departemen mengelola dokumentasi mereka. 
2. Gagasan membantu tim produk Anda mengatur dokumentasi bersama dengan manajemen proyek. 

4. Untuk mengelola dan melacak perubahan dokumen:

1. GitHub memungkinkan pengembang untuk memperbarui dokumentasi bersamaan dengan perubahan kode.
2. BitBucket terintegrasi dengan pipeline CI/CD Anda sehingga dokumentasi secara otomatis dibuat dan digunakan pada setiap rilis.

5. Untuk penelitian, struktur konten, dan keterbacaan yang lebih baik:

1. Penulis Esai membantu Anda mendokumentasikan algoritme yang canggih ke dalam konteks, penjelasan, dan contoh yang sesuai. 
2. Penulis SEO memastikan dokumentasi Anda yang menghadap ke publik menggunakan terminologi yang konsisten dan mengikuti praktik terbaik dalam hal keterbacaan. 
3. Obrolan AI membantu penulis teknis Anda menyederhanakan konsep yang rumit. Ini menyarankan penjelasan alternatif dan mengidentifikasi area di mana pengguna mungkin memerlukan konteks tambahan. 

Bagaimana AI Dapat Meningkatkan Efisiensi Penulisan Teknis

Berikut ini adalah bagaimana AI dapat membantu Anda dalam penulisan teknis: 

1. Otomatisasi

Memulai dari halaman kosong memang sulit. Anda dapat menggunakan AI untuk membuat draf konten awal berdasarkan data terstruktur.

Ini mengurangi waktu yang dibutuhkan untuk membuat manual, panduan, dan laporan. 

Bagaimana cara melakukannya...

Gunakan alat bantu AI seperti AI Chatbot untuk menghasilkan garis besar dasar atau bahkan draf pertama.

Kemudian, sempurnakan bahasanya dengan menggunakan terminologi khusus industri, dan periksa faktanya. 

2. Tata Bahasa & Kejelasan

Gunakan alat bantu AI untuk memeriksa jargon, kalimat pasif, dan masalah keterbacaan. 

Berikut ini cara menggunakannya...

Jalankan konsep melalui AI Paraphraser. Alat ini membantu menulis ulang kalimat yang rumit, menyarankan alternatif bahasa yang lebih sederhana, dan meningkatkan keterbacaan secara keseluruhan.

3. Penataan Konten

Dokumen yang terstruktur dengan baik akan mencegah kebingungan.

AI dapat mengatur konten secara logis dengan mengelompokkan topik terkait, menambahkan judul, dan menyarankan tata letak. 

Berikut ini cara menggunakannya..

Gunakan Penulis Esai AI untuk membuat laporan, manual, dan dokumentasi.

Kesimpulan

Penulis teknis menerjemahkan "bahasa insinyur" menjadi "bahasa manusia".

Itulah alasan mengapa pilot dapat mendaratkan pesawat dengan aman tanpa membaca buku panduan setebal 10.000 halaman di tengah penerbangan, mengapa ahli bedah berfokus pada penyelamatan nyawa alih-alih menguraikan instruksi yang samar, dan mengapa Anda dapat menggunakan mesin pembuat kopi yang mewah tanpa menimbulkan semburan air panas yang tidak disengaja di dapur Anda. 

Di dunia kita yang kompleks ini, komunikasi yang jelas sangatlah penting.

Penulisan teknis yang baik dapat menghemat waktu, uang, frustrasi, dan terkadang nyawa (dalam konteks medis dan keselamatan).

Di masa mendatang, kita akan melihat lebih banyak video dalam bentuk panduan interaktif dan dokumen yang disesuaikan dengan tingkat keahlian Anda. 

Jika Anda ingin melenturkan otot-otot penulisan teknis Anda, pilihlah sesuatu yang rumit yang Anda pahami dengan baik - mungkin cara kerja fotosintesis, aturan offside dalam sepak bola, atau bahkan cara membuat souffle yang sempurna - dan jelaskan pada teman Anda dengan cara yang paling jelas dan sederhana. 

Jika mereka memahami bahwa alih-alih tampilan yang terlalu berkilau, selamat!

Anda telah menemukan keterampilan inti seorang penulis teknis: membuat sesuatu yang rumit menjadi tidak rumit.

Butuh bantuan ekstra? AI yang tidak terdeteksi Alat-alat ini menyempurnakan tulisan Anda dan menjaganya tetap sempurna. Cobalah sekarang!

Jangan ragu untuk menjelajahi Detektor AI dan Humanizer di widget di bawah ini!