Penulis Teknis: Apa Mereka dan Apakah Anda Membutuhkannya?

Diterbitkan: 2022-03-11

Panduan Penulis Teknis

Seorang penulis dapat mengisi beberapa posisi berbeda di dunia penulisan profesional. Sementara bisnis di luar industri cenderung menyalahgunakan terminologi, setiap jenis penulis mengisi peran tertentu dan memiliki tugas tertentu. Sangat penting untuk mempekerjakan tipe penulis yang tepat jika Anda ingin mereka melakukan pekerjaan sebaik mungkin.

  • Penulis, yang biasanya menulis konten yang kurang formal dan panjang seperti buku.
  • Copywriter biasanya menulis salinan bentuk pendek untuk iklan, posting media sosial, deskripsi produk, dan media lainnya.
  • Penulis teknis, yang biasanya menulis dokumentasi produk dan materi pusat bantuan.
  • Blogger biasanya fokus pada konten menengah untuk publikasi web.

Dan, tentu saja, Anda juga memiliki jenis penulis khusus industri, seperti penulis medis atau penulis hibah untuk sektor nirlaba. Selain itu, mereka semua juga bisa menjadi ghostwriter.

Seperti yang tersirat dari judul posting hari ini, saya akan menggali salah satu peran ini. Secara khusus, mari kita bicara tentang penulis teknis.

Daftar isi
Apa itu Penulis Teknis?
Apa, Khususnya, yang Dilakukan Penulis Teknis?
Keterampilan Apa yang Dibutuhkan Penulis Teknis?
Adakah yang Bisa Menjadi Penulis Teknis?
Apakah Anda Membutuhkan Penulis Teknis?

Apa itu Penulis Teknis?

Katakanlah Anda telah membeli produk baru. Anda menemukannya dan membukanya, dan menemukan manual 50 halaman yang penuh dengan diagram suku cadang, spesifikasi, dan instruksi bagaimana cara kerjanya. Ini semi-rumit, jadi Anda perlu merujuk manual.

Itulah yang dilakukan seorang penulis teknis, dan begitulah cara mereka mendapatkan gelar pekerjaan penulisan teknis .

"Seorang penulis teknis menulis dokumen perusahaan seperti manual instruksi, manual perantara hingga pengguna akhir, panduan referensi, panduan prosedur operasi, kertas putih, dan deskripsi produk khusus." – Markas Besar Penulis Teknis.

Konten yang dibuat oleh penulis teknis dapat dibuat untuk tujuan yang berbeda, termasuk:

  • Konten Penggunaan Bisnis Internal mencakup dokumentasi prosedur, panduan pengguna, manual, dokumen layanan, atau laporan.
  • Konten Penggunaan Bisnis Eksternal mencakup panduan penggunaan, panduan perbaikan, dokumentasi basis pengetahuan, dokumentasi layanan pelanggan, dan dokumentasi proposal klien.

Jadi, penulis teknis Anda mungkin membantu menyusun buku pegangan karyawan, menulis wiki basis pengetahuan internal Anda, atau membangun database layanan pelanggan atau FAQ. Mereka mungkin menulis manual untuk penggunaan produk atau mendokumentasikan proses bisnis untuk konsistensi internal. Mereka mungkin juga membuat laporan dan proposal untuk tim eksekutif di tingkat yang lebih tinggi dan memfasilitasi komunikasi antara tingkat C dan Direktur.

Contoh Konten Teknis Mailchimp

Seperti yang Anda duga, semua ini berada di bawah judul "dokumentasi teknis," maka penulis teknis. Konten itu sendiri, seperti yang Anda duga, bersifat teknis.

Penulis teknis dapat berupa:

  • Kontraktor lepas, bekerja per proyek.
  • Kontraktor jangka panjang, bekerja untuk mendokumentasikan segala sesuatu tentang bisnis sampai selesai.
  • Karyawan paruh waktu atau penuh waktu, mendokumentasikan segala sesuatu sesuai kebutuhan selama operasi.

Penulis teknis sangat jarang menjadi penulis bayangan. Seorang ghostwriter biasanya menukar tulisan dengan uang dengan menjual byline. Dokumentasi teknis jarang memiliki byline, jadi tidak perlu menyewa seorang penulis untuk orang lain daripada penulis biasa untuk memproduksinya. Harapannya tidak ada.

Apa, Khususnya, yang Dilakukan Penulis Teknis?

Bidang penulisan teknis yang luas cukup kompleks. Seorang penulis khusus di satu perusahaan mungkin memiliki tanggung jawab yang sama sekali berbeda dari seorang penulis di perusahaan lain.

Tugas umum yang akan Anda temukan dalam deskripsi pekerjaan penulis teknis dapat mencakup:

  • Meneliti spesifikasi teknis dari departemen bisnis, proses, atau produk.
  • Rencanakan dokumentasi teknis dalam urutan yang logis.
  • Pahami apa yang perlu dan apa yang tidak untuk audiens target.
  • Buat, salin, edit, dan sempurnakan dokumentasi.
  • Buat diagram dan ilustrasi lain yang diperlukan.
  • Pertahankan glosarium yang relevan, FAQ, atau pustaka terminologi terkait lainnya.
  • Kembangkan laporan teknis atau proposal formal untuk penggunaan bisnis tingkat tinggi.

Banyak penulis akan memiliki sertifikat penulisan teknis, artikel jurnal yang diterbitkan atau karya yang sudah ada, dan pengalaman bertahun-tahun di bidangnya. Mereka harus dapat menunjukkan bahwa mereka memiliki karir menulis teknis di industri spesifik Anda.

Manual yang menyertai mobil Anda, yang mengajarkan Anda cara mengganti ban atau menggunakan lampu sein, adalah bagian dari tulisan teknis. Begitu juga dengan manual servis, dimaksudkan untuk mekanik dan bukan pengguna akhir. Basis pengetahuan layanan mandiri pelanggan di situs web pembuat mobil juga diisi dengan konten teknis.

Semua Manual Haynes, Pusat Bantuan Google, dan bahkan hal-hal seperti Studi Kasus adalah contoh penulisan teknis.

Contoh Artikel Bantuan Google Search Console

Penulis teknis harus ahli tanpa henti di bidangnya (tetapi tidak harus bersertifikat). Seorang penulis teknis untuk produsen mobil perlu memahami desain mobil luar dan dalam. Seorang penulis teknis di bidang medis perlu cukup tahu tentang biokimia untuk mendokumentasikan pengobatan dengan benar. Seorang penulis teknis untuk bisnis perlu memahami bagaimana fungsi bisnis, untuk menulis dokumentasi proses dengan tepat.

Konon, penulis teknis sering meminta pakar materi pelajaran meninjau produk akhir mereka dan menyetujuinya. Misalnya, seorang penulis medis mungkin memiliki tinjauan ahli biokimia yang sebenarnya dan memastikan keakuratannya. Seorang penulis teknis yang membuat manual produk mungkin meminta pengacara memeriksanya sebelum diterbitkan untuk menjamin tidak ada apa pun di dalamnya yang mampu menimbulkan tanggung jawab bagi perusahaan.

Bagaimanapun, dokumentasi teknis harus akurat, dan perlu ditulis untuk audiens yang tepat.

Untuk menggunakan contoh pembuat mobil lagi, dokumen spesifikasi penjualan, manual pengguna, dan manual perbaikan harus berisi informasi teknis yang serupa. Namun, informasi dengan nilai paling bervariasi, tingkat detail teknis bervariasi, dan ruang lingkup dokumentasi berubah.

Contoh Panduan Otomatis

Memberikan Manual Haynes kepada pengguna akhir tidak tepat. Itu karena orang-orang yang ingin membeli mobil, ingin memecahkan masalah kendaraan mereka, dan orang-orang yang memperbaiki kendaraan secara profesional memiliki kebutuhan yang berbeda. Kebutuhan kebanyakan orang akan pengetahuan otomotif melibatkan penggunaan lampu sein dan pengisian ban, bukan mengganti saluran udara atau mengganti catalytic converter.

Keterampilan Apa yang Dibutuhkan Penulis Teknis?

Penulis teknis memerlukan seperangkat keterampilan menulis dan keterampilan komunikasi tertentu agar efektif.

1. Pertama, mereka harus menjadi komunikator yang sangat efektif. Seorang penulis teknis perlu menyampaikan informasi yang akurat dan teknis kepada pengguna akhir untuk memahami dan menguraikannya. Jika panduan diisi dengan informasi kompleks yang terlalu sulit untuk mereka pahami, itu akan membingungkan hingga tidak berguna. Jika terlalu sederhana, pengguna tidak akan mendapatkan nilai apa pun.

Pada saat yang sama, penulis teknis mungkin perlu mengajukan pertanyaan praktis kepada ahli materi pelajaran. Dalam dokumentasi mereka, mereka mungkin menemukan pertanyaan yang tidak mereka miliki dan tidak dapat menemukan jawabannya. Mereka perlu bertanya kepada ahli yang relevan tentang apa yang perlu mereka ketahui untuk dokumentasi. Dan, karena ahli mungkin tidak tahu kapan harus berhenti, penulis teknis juga perlu tahu cara mengekstrak nilai spesifik dari respons yang berpotensi panjang.

Contoh Komunikasi Slack untuk Konten Teknis

2. Terkait, penulis teknis membutuhkan pemahaman yang kuat tentang bahasa mereka. Mereka harus tepat dengan apa yang mereka katakan dan tulis ke tingkat membaca yang praktis, yang ditargetkan secara khusus untuk audiens mereka. Kesalahan teknis, pilihan kata yang buruk, makna yang kacau; semuanya mengerikan untuk dokumentasi teknis.

3. Selanjutnya, mereka harus memiliki perspektif yang berorientasi pada detail. Seorang penulis teknis membutuhkan mata untuk detail kecil karena detail kecil harus akurat. Mereka tidak dapat mengabaikan detail tertentu karena detail tersebut mungkin diperlukan.

Z
Z
Z
Apakah blog Anda menghasilkan bisnis? Jika tidak, mari kita perbaiki.

Kami membuat konten blog yang mengubah - tidak hanya untuk diri kami sendiri, tetapi juga untuk klien kami.

Kami memilih topik blog seperti hedge fund memilih saham. Kemudian, kami membuat artikel yang 10x lebih baik untuk mendapatkan posisi teratas.

Pemasaran konten memiliki dua bahan - konten dan pemasaran. Kami telah mendapatkan sabuk hitam kami di keduanya.

Jika Anda menjalankan bisnis berbasis internet dan ingin meningkatkan, jadwalkan panggilan untuk berbicara dengan pendiri kami:
Panggilan Strategi Gratis

Misalnya, di salah satu panduan cara saya di beberapa layanan web atau lainnya, saya mungkin menulis sesuatu seperti:

"Masuk ke dasbor Anda dan temukan bagian Laporan di bilah sisi."

Itu cukup baik bagi saya karena saya tidak menulis dokumentasi teknis; Saya sedang menulis panduan cara yang cukup sederhana. Sementara itu, seorang penulis teknis mungkin menulis:

"Dari dasbor, klik judul Laporan di bilah sisi kiri, ketiga dari atas."

Mereka lebih spesifik karena bagian dari dokumentasi teknis adalah kekhususan. Tentu saja, itu contoh umum.

4. Penulis teknis juga membutuhkan pemahaman tentang alur logis. Saat mendokumentasikan proses bisnis, penulis Anda akan membutuhkan keterampilan berpikir kritis, dan langkah-langkah perlu diatur dengan tepat. Pertimbangkan, misalnya, resep. Anda menulis petunjuk langkah demi langkah untuk memanggang sepotong roti satu demi satu, sesuai urutannya. Namun, Anda mungkin dapat mengatur ulang beberapa; misalnya, tidak ada alasan untuk meletakkan "panaskan oven" di awal ketika ada satu jam pemeriksaan adonan sebelum dipanggang; tidak ada yang mau membiarkan oven mereka menyala selama itu tanpa apa pun di dalamnya.

Produsen mobil yang berbeda memiliki pola yang berbeda. Semakin panjang atau besar sebuah dokumentasi, semakin banyak pilihan yang ada, dan semakin penting untuk membangun sebuah konvensi. Manual otomatis mungkin dimulai dengan kegunaan, lalu beralih ke fitur tersembunyi dan perbaikan kecil.

Contoh Panduan Mobil Dari Toyota

5. Ini terkait dengan persyaratan lain untuk penulis teknis, yaitu sumber tunggal. Sumber tunggal berarti mengambil kumpulan informasi dan menghasilkan banyak konten yang ditujukan untuk audiens yang berbeda. Contoh mobil dari manual pengguna dan manual Haynes adalah contoh yang baik; keduanya berisi informasi tentang mobil yang sama dari sumber yang sama (produsen), tetapi yang satu jauh lebih teknis.

6. Beberapa penulis teknis mungkin juga memerlukan kode dasar atau pengetahuan pengembangan web. Misalnya, seorang penulis teknis yang membuat dokumentasi layanan pelanggan mungkin perlu mengetahui cukup banyak tentang HTML, CSS, JavaScript, atau Sintaks Wiki untuk memulai dokumentasi berbasis web dari awal atau dalam suatu kerangka kerja. Penulis teknis jarang menulis salinan teks murni - umumnya ada keterampilan lain yang diperlukan agar mereka dianggap sebagai penulis teknis.

Contoh Kode Konten Teknis

Misalnya, seorang penulis teknis pada pengembangan tumpukan penuh kemungkinan memiliki dua keterampilan: penulisan teknis dan pemrograman. Tidak ada cara lain bagi seorang penulis untuk membuat konten programmer yang akurat seperti ini tanpa menjadi seorang programmer.

Adakah yang Bisa Menjadi Penulis Teknis?

Jujur, tidak.

Penulisan teknis adalah jenis tulisan tertentu yang berisiko tinggi. Ini memiliki standar kualitas yang sangat curam karena dokumentasi yang buruk dapat menyebabkan banyak masalah bagi perusahaan. Dokumentasi yang buruk dapat secara dramatis mengurangi pengalaman dan kepuasan pengguna dengan suatu produk. Proses penulisan teknis yang efisien dapat menghemat jutaan dolar dalam skala bisnis.

Misalnya, perusahaan pengembang perangkat lunak memiliki panduan yang terlalu membingungkan atau sulit dipahami pengguna. Dalam hal ini, tingkat churn mereka akan lebih tinggi dari rata-rata, dan mereka akan kehilangan banyak pelanggan - semuanya karena penulisan yang buruk.

Penulis teknis membutuhkan perpaduan spesifik dari kepribadian yang berorientasi pada detail dan kemampuan bersosialisasi untuk terlibat dengan para ahli materi pelajaran. Seringkali, seorang penulis teknis juga memerlukan gelar atau sertifikat teknis dalam materi pelajaran mereka untuk menulis tentang hal itu dengan tepat.

Misalnya, seorang penulis medis mungkin mendapatkan gelar keperawatan atau gelar 4 tahun dalam ilmu kedokteran atau ilmu komputer. Penulis bahkan dapat mengambil kursus penulisan teknis khusus untuk konten medis. Mereka tidak perlu mengejar program Magister atau Doktor, tetapi mereka membutuhkan setidaknya beberapa pendidikan formal seperti gelar Sarjana.

Contoh Kelas dan Sarjana

Banyak penulis konten teknis memilih industri yang diminati dan berspesialisasi di dalamnya.

Yang mengatakan, penulis teknis tidak selalu membutuhkan gelar ini untuk memasuki suatu bidang. Seringkali, yang mereka butuhkan hanyalah gelar dalam bahasa Inggris atau Penulisan, Jurnalisme, Komunikasi Teknis, atau bidang teknis seperti Teknik (meskipun itu cenderung kurang umum.)

Saya telah menjadi penulis selama lebih dari satu dekade, tetapi sebagai seorang blogger, saya tidak akan berkembang sebagai penulis teknis. Saya bisa belajar caranya, tentu saja, tetapi saya harus menekan banyak kebiasaan saya (seperti menulis dengan sudut pandang orang pertama atau santai).

Apakah Anda Membutuhkan Penulis Teknis?

Mungkin!

Hampir setiap bisnis membutuhkan beberapa tingkat penulisan bisnis dan dokumentasi teknis. Saya menjalankan operasi kecil, tetapi saya masih menghasilkan hal-hal seperti Panduan Gaya Rumah, ringkasan konten, atau Kebijakan Privasi situs saya.

Namun, saya tidak akan mengatakan bahwa saya membutuhkan seorang penulis teknis. Saya dapat menulis teknis antara templat online dan standar yang lebih rendah yang diperlukan untuk dokumentasi internal saya.

Contoh Konten Teknis pada Konten Didukung

Misalkan bisnis Anda beroperasi di bidang di mana Anda memiliki kebutuhan layanan pelanggan lebih dari sekadar menjawab telepon dan berbicara dengan klien. Dalam hal ini, Anda mungkin mendapat manfaat dari memiliki penulis teknis yang membuat dokumentasi. Jika Anda memiliki departemen besar dengan proses khusus untuk menghasilkan laporan atau bekerja dengan ATS, penulis teknis dapat mendokumentasikan proses tersebut.

Dan, tentu saja, jika bisnis Anda menghasilkan produk teknis, dan produk itu lebih rumit daripada pena atau sepatu, kemungkinan besar membuat panduan pengguna atau pusat bantuan online untuk pengguna Anda adalah ide yang bagus.

Meski begitu, tidak semua perusahaan menggunakan penulis teknis untuk manual mereka. Pertimbangkan Ikea; mereka terkenal karena hanya menggunakan piktogram dalam instruksi perakitan mereka, sebagian karena mereka ingin satu bagian dokumentasi relevan dengan seluruh dunia, apa pun bahasanya. Seorang penulis teknis mungkin telah menghasilkan itu, tetapi tidak menulis sebanyak itu adalah desain grafis.

Saya dapat mengatakan satu hal: menulis teknis adalah keterampilan khusus, dan itu adalah keterampilan yang sulit untuk dikembangkan.

Penulis teknis menghasilkan rata-rata $75.000 per tahun, menurut Biro Statistik Tenaga Kerja AS, dengan penulis teknis kelas atas dan sangat terampil mencapai $100.000 per tahun, dan itu dengan alasan yang bagus. Mereka sepadan dengan beratnya dalam emas dalam situasi yang tepat.

Apakah Anda mempertimbangkan untuk mempekerjakan seorang penulis teknis? Apakah Anda memiliki pertanyaan untuk kami tentang penulis teknis dan bagaimana mereka berbeda dari copywriter atau penulis konten? Tolong beri tahu saya di bagian komentar! Saya akan dengan senang hati membantu dan memulai percakapan tentang hal ini.