Panduan pemula untuk penulisan teknis (2021)

Ada sekelompok orang yang menganggap artikel yang ditulis oleh ilmuwan, dokter, pemrogram komputer, dan insinyur merupakan tulisan teknis.

Kelompok lain menganggap bahwa penulisan teknis hanya tentang menulis manual pengguna.

Keduanya tidak bisa lebih salah.

Tapi prasangka mereka cukup bisa dimengerti. Untuk orang biasa, ini adalah para profesional (dokter, ilmuwan, insinyur, dll.) yang dapat disebut 'teknis' dalam bahasa mereka. Mereka berasumsi bahwa whitepaper dan tesis yang ditulis oleh orang-orang yang disebut 'teknis' ini adalah inti dari penulisan teknis.

Demikian pula, manual pengguna adalah dokumen yang sebagian besar dari kita terpapar ketika memahami hal-hal teknis (peralatan dan produk yang kita gunakan). Jadi itu menjawab prasangka kedua.

Tetapi kenyataannya kebanyakan orang tidak menyadari bahwa penulisan teknis adalah tentang menulis konten untuk orang awam seperti kita. Faktanya, banyak artikel teknis ditulis hanya setelah benar-benar memahami apa yang sebenarnya dicari pembaca sejak awal.

Panduan ini telah dirancang dengan cermat untuk memberi Anda pemahaman mendalam tentang apa itu penulisan teknis, perbedaannya dengan penulisan konten biasa, dan langkah-langkah yang perlu Anda ikuti untuk menjadi penulis teknis.

Apa itu Penulisan Teknis?

Inilah bagaimana penulisan teknis didefinisikan beberapa tahun yang lalu -

“Praktek mencatat proses, manual pengguna untuk perangkat lunak, dan instruksi untuk peralatan.”

Dulu, penulisan teknis memang sebatas buku petunjuk saja. Namun, di dunia modern, penulisan teknis telah menjadi istilah umum yang mencakup lebih banyak definisi.

Hari ini, penulisan teknis didefinisikan sebagai -

“Dokumentasi proses teknis di hampir semua bidang. Ini melibatkan laporan, briefing, instruksi, dan banyak lagi."

Itu bisa di beragam bidang, seperti Teknik, Teknologi Informasi, Biotek, Keuangan, dll.

Singkatnya, jika Anda bekerja di bidang teknis apa pun, seseorang di sana menulis dokumentasi teknis untuk Anda dan produk atau layanan Anda.

Apa Tujuan Penulisan Teknis?

Penulis teknis dapat mengharapkan peran dan tanggung jawab mereka berubah berdasarkan industri dan perusahaan tempat mereka bekerja. Namun, sebagian besar penulis teknis akan bekerja dengan banyak tim. Mereka adalah jembatan yang menghubungkan staf teknis dan karyawan dan pelanggan yang kurang teknis. Sebagai penulis teknis, adalah tanggung jawab Anda untuk mengomunikasikan dengan tepat apa yang ingin disampaikan oleh staf teknis kepada pembaca dalam bahasa yang mereka pahami.

Mari kita perhatikan contoh sederhana. Perusahaan Anda telah datang dengan alat penjangkauan penjualan baru. Ada beberapa fitur untuk memulai, menjeda, dan menjadwalkan email ke pelanggan akhir. Pengguna biasa perlu mempelajari semua fitur ini untuk memanfaatkan aplikasi sepenuhnya. Sekarang Anda dapat membiarkan pengguna menemukan fitur mereka sendiri atau memberikan dokumen yang menjelaskan apa itu setiap fitur dan bagaimana menggunakannya untuk membuat hidup mereka lebih sederhana.

Bagi pengguna yang tidak paham teknologi, ini akan menjadi keuntungan. Tanpa dokumen ini, memahami dan menavigasi aplikasi bisa sangat menakutkan bagi mereka. Mereka mungkin kehilangan fitur yang dapat membuat pengalaman mereka lebih baik atau bahkan menggunakan fungsi tertentu dengan tidak semestinya.

Singkatnya, tujuan akhir dari penulisan teknis adalah untuk menghindari semua perangkap ini dan memastikan bahwa informasi dikomunikasikan dengan jelas dan sederhana.

Apa Perbedaan Antara Penulisan Teknis dan Bentuk Penulisan Lainnya?

Di bagian sebelumnya, kami telah mengutip bahwa ide inti di balik penulisan teknis adalah untuk mengkomunikasikan informasi dengan cara yang jelas. Tetapi Anda mungkin bertanya-tanya apakah demikian halnya dengan bentuk penulisan lainnya. Bagaimanapun, artikel apa pun dimaksudkan untuk menyampaikan beberapa informasi kepada pengguna dalam bahasa yang dapat dipahami pembaca. Nah, kesamaan dimulai dan berakhir di sana. Berikut adalah perbedaan utama antara penulisan teknis dan bentuk penulisan lainnya -

Area fokus

Sebuah dokumen teknis hanya berfokus pada mata pelajaran yang bersangkutan. Misalnya, panduan pengguna hanya berfokus pada fungsi produk. Namun, bentuk tulisan lain dapat memasukkan lebih banyak topik dan kreativitas ke dalam konten. Misalnya, sebuah blog tentang e-learning dapat berbicara tentang tips untuk mengadakan kelas dengan lebih baik dan juga tentang perkiraan biaya untuk memulai akademi e-learning Anda sendiri.

Tujuan yang dimaksud

Meskipun bentuk tulisan lain memberikan informasi, tujuan dari konten tersebut biasanya untuk hiburan untuk pemasaran. Di sisi lain, konten teknis hanya berfokus pada peningkatan pengalaman pengguna. Ini memberikan informasi, memberikan instruksi, dan menawarkan penjelasan untuk topik, aplikasi, atau peralatan, dan itu saja.

Nada Isinya

Potongan konten non-teknis biasanya ditulis dengan nada subjektif, di mana opini dan anekdot digunakan untuk membuat konten lebih menarik. Di sisi lain, penulisan teknis selalu bersifat objektif. Tidak boleh ada pendapat atau kebingungan dalam instruksi yang diberikan.

Format

Menulis umum dapat mengambil beberapa bentuk. Misalnya, ada banyak format untuk menulis blog agar menarik dan menghibur pembaca. Tapi itu tidak terjadi dengan penulisan teknis. Dalam penulisan teknis, selalu ada struktur yang harus diikuti. Ini memastikan bahwa informasi yang disampaikan langsung ke intinya, dan pengguna akhir dapat segera mulai menggunakan produk.

Gaya menulis

Pembeda utama lainnya antara penulisan umum dan penulisan teknis adalah suaranya. Dalam konten non-teknis, penulis sering menggunakan format orang pertama dan nada informal untuk membuat konten terasa percakapan dan menarik.

Dalam penulisan teknis, demi memudahkan pembaca, konten selalu ditulis dalam format orang ketiga. Ini juga sangat formal sehingga tidak memberikan ruang untuk interpretasi yang bervariasi dari konten yang disediakan.

Kosakata

Perbedaan utama lainnya antara keduanya adalah kosakata yang digunakan. Dalam penulisan konten biasa, kosakata yang digunakan seringkali bersifat menggugah untuk menginspirasi suatu tindakan atau emosi dalam diri pembaca.

Dalam penulisan teknis, kosakata sangat terspesialisasi dan tergantung pada jenis produk. Anda akan melihat istilah khusus digunakan dalam konten untuk memberikan instruksi atau penjelasan yang akurat kepada pembaca, hanya untuk membantu mereka.

Hadirin

Tentu saja, penonton juga sangat bervariasi di antara keduanya. Dalam penulisan teknis, audiens selalu terspesialisasi dan tahu barang-barang mereka. Mereka adalah orang-orang yang akan membeli produk atau layanan Anda. Mereka juga bisa menjadi analis bisnis atau manajer produk yang membutuhkan informasi tentang program atau layanan untuk memanfaatkannya dengan lebih baik. Di sini, penulis teknis akan menemukan bahwa tujuan mereka adalah untuk memastikan bahwa semua pemangku kepentingan yang diperlukan mendapatkan informasi yang diperlukan tepat waktu. Penulis tidak dipaksa untuk menarik lebih banyak orang untuk membacanya.

Dalam bentuk tulisan lain, audiens lebih digeneralisasi. Mungkin ada perbedaan besar dalam kelompok usia, profesi, dll. Singkatnya, tidak ada kelompok orang tertentu untuk siapa tulisan itu dirancang. Penulis juga harus fokus pada konten yang disiarkan ke lebih banyak orang (yang tertarik dengan topik).

Contoh Penulisan Teknis

Berikut adalah contoh penulisan teknis paling populer atau jenis konten yang akan Anda temukan ditulis oleh penulis teknis -

Prosedur Operasi Standar

Ini adalah dokumen yang dirancang untuk memberikan konten instruksional dan informasi kepada pengguna tentang prosedur operasi yang tepat dalam suatu organisasi. Dokumen-dokumen tersebut akan mencakup aturan, peraturan, dan pedoman mereka untuk proses dan situasi. Selain itu, ini juga akan memberikan informasi tentang prosedur eskalasi dan orang-orang yang harus dihubungi untuk kejadian tertentu.

Instruksi Manual

Sebagian besar dari kita akrab dengan instruksi manual. Bisa berupa buklet kecil yang kita dapatkan saat kita membeli alat elektronik baru seperti smartphone, atau bisa juga berupa buku tebal yang kita terima dengan barang yang lebih besar, seperti mobil. Semua dokumen ini ditulis oleh penulis teknis. Disini, penulis bertujuan untuk memberikan informasi tentang cara menggunakan perangkat atau peralatan dengan benar.

Penafian Hukum

Ini juga disebut klausa lindung nilai. Mereka biasanya ditulis untuk memberikan penafian kepada pembaca tentang apa itu organisasi dan tidak bertanggung jawab saat menggunakan produk atau layanannya. Penulis teknis sering kali harus berkonsultasi dengan pakar hukum dan pengembang produk untuk memahami apa yang dapat dan tidak dapat ditulis dalam penafian hukum.

Penafian hukum memiliki tingkat kerumitan tambahan berdasarkan pasar tempat produk atau layanan dijual. Ini karena negara yang berbeda memiliki persyaratan hukum yang berbeda bagi perusahaan untuk mendukung dan melayani pelanggan mereka di wilayah tersebut.

Ada banyak jenis lainnya. Yang disebutkan di atas hanyalah beberapa contoh penulisan teknis untuk referensi Anda.

Bagaimana Anda Menjadi Penulis Teknis?

Jika Anda tertarik untuk menjadi penulis teknis, ada kabar baik. Tidak hanya ada banyak cara untuk memasuki bidang ini, tetapi selalu ada permintaan yang meningkat untuk penulis teknis di antara perusahaan di seluruh dunia. Mereka membutuhkan bantuan Anda untuk menulis dokumentasi teknis untuk produk, layanan, dan proses mereka. Pada catatan positif itu, berikut adalah hal-hal berbeda yang dapat Anda lakukan untuk menjadi penulis teknis -

Belajar menulis

Meskipun ini mungkin terdengar jelas, belajar menulis tidak hanya melibatkan merangkai kalimat. Anda harus mempelajari berbagai subtopik dalam menulis, seperti menggunakan suara yang berbeda untuk jenis tulisan yang berbeda, memahami cara mendeskripsikan dan merujuk ke ilustrasi dengan jelas, dan banyak lagi.

Ketahui Berbagai Tahapan Menulis

Di hampir semua proyek penulisan teknis, Anda akan memiliki tiga langkah ini -

#1. Perencanaan

Perencanaan proyek sering diprakarsai oleh atasan atau klien Anda. Pada langkah ini, persyaratan dasar ditentukan, seperti jenis dokumennya, materi pelajaran, tujuan, ruang lingkup, dan audiens yang akan ditargetkan.

Jika semuanya tidak diberikan pada awalnya, Anda harus berbicara dengan klien atau atasan Anda dan mendapatkan detail tersebut melalui percakapan. Terkadang mereka mungkin tidak yakin dengan apa yang mereka cari. Sebagai penulis teknis, tugas Anda juga memastikan bahwa Anda dapat mengomunikasikan kebutuhan Anda untuk menyelesaikan proyek.

Dengan pertanyaan dan percakapan yang tepat, langkah ini dapat menghemat banyak waktu dan tenaga.

#2. Memahami Persyaratan Audiens

Jika Anda dapat mempersempit audiens Anda pada langkah pertama, langkah kedua memerlukan pemahaman siapa audiens Anda dan apa yang mereka cari.

Kumpulkan sebanyak mungkin informasi tentang audiens Anda sebelum Anda mulai menulis. Misalnya, apakah pembaca Anda memiliki keahlian teknis di bidang tersebut? Apakah mereka dapat memahami istilah dan jargon yang rumit? Atau apakah mereka benar-benar baru di lapangan?

Selain itu, penonton mungkin juga memiliki harapan ketika mereka membaca dokumentasi teknis. Apa yang akan mereka cari? Apakah mereka mencari pemahaman mendalam tentang produk, atau apakah mereka orang awam hanya ingin tahu cara menggunakan produk? Memberikan apa yang benar-benar diinginkan pembaca akan menentukan seluruh proses penulisan Anda. Ingat - mereka mengajukan pertanyaan, dan Anda harus memberikan jawaban yang akurat.

Selain itu, pengembang yang mencari dokumentasi tentang API sama sekali berbeda dari pelanggan yang membeli perabot baru yang perlu disatukan. Mereka adalah dua audiens yang berbeda dengan persyaratan yang berbeda dalam dokumentasi teknis mereka.

#3. Menulis untuk Audiens

Setelah memahami kebutuhan audiens, pahami bagaimana Anda akan membuat dokumen untuk memenuhi kebutuhan tersebut. Kesalahan umum yang cenderung dilakukan oleh penulis adalah membuat dokumen yang dapat diterima dengan sangat baik oleh penulis lain tetapi memberikan sedikit atau tidak ada nilai bagi pengguna akhir.

Jadi sebelum Anda mulai mengetik di keyboard Anda, tanyakan pada diri Anda pertanyaan-pertanyaan ini -

• Apakah dokumen mudah diakses oleh audiens yang saya maksud?
• Apakah dokumen mudah dipahami dari sudut pandang audiens?
• Bagaimana pembaca akan menggunakan dokumen ini?
• Apakah dokumen ini mudah dinavigasi?
• Apakah dokumen terlalu rumit untuk pembaca saya?
• Apakah dokumen terlalu sederhana untuk pembaca saya?

Kembangkan Keterampilan Menulis Teknis

Bidang mana pun yang Anda pilih untuk menulis, bidang tersebut akan melibatkan beberapa tingkat keahlian teknis. Anda tidak dapat menulis dokumentasi perangkat lunak tanpa mengetahui apa itu sintaks, API, dan bahasa pemrograman. Jika Anda ingin menulis dokumen tentang C++, setidaknya Anda harus mengetahui cara kerja C++. Jika Anda dapat membuat kode dengannya, itu lebih baik.

Lakukan Banyak Riset

Ini bukan hanya untuk belajar tentang bagaimana menulis tugas penulisan teknis Anda berikutnya. Anda ingin tetap mengikuti apa yang terjadi di bidang Anda sehingga Anda dapat menjelaskan istilah dan konsep kepada pengguna Anda dengan lebih baik. Jika audiens Anda terdiri dari pemrogram perangkat lunak tingkat lanjut, Anda harus tetap berada di level mereka untuk memastikan bahwa konten Anda bermanfaat bagi mereka.

Dengan semua keterampilan menulis teknis ini, Anda akan siap untuk mengambil peran sebagai penulis teknis, apakah Anda akan melakukannya penuh waktu atau mengambil proyek lepas penulisan teknis. Tetapi penting untuk diingat bahwa dipersiapkan sebagai penulis teknis adalah pengalaman yang berkelanjutan.

Peran Penulis Teknis

Menulis adalah salah satu bagian dari menjadi seorang penulis teknis, bahkan jika itu adalah peran utama. Jika Anda ingin menjadi penulis teknis sepenuhnya yang dapat mengerjakan proyek apa pun, penting untuk memahami semua peran yang diharapkan akan Anda ambil saat mengambil pekerjaan menulis teknis.

Menulis, Mengedit, dan Mengoreksi Dokumen

Tentu saja, sebagai penulis, Anda diharapkan mengetahui cara menulis dokumentasi teknis. Seperti disebutkan di atas, ini dapat mencakup berbagai dokumentasi, dari manual pengguna hingga penafian hukum. Selain itu, penulis teknis juga diharapkan untuk mengedit dan mengoreksi dokumen untuk memastikan keakuratan dan keterbacaannya. Jika Anda bekerja dengan penulis teknis lain di tim Anda, Anda akan memeriksa tulisan masing-masing untuk memastikan bahwa itu memenuhi standar kualitas dan memberikan informasi yang diperlukan kepada audiens.

Berkoordinasi dengan Pemangku Kepentingan Proyek

Setiap proyek akan memiliki pengembang, insinyur, manajer, pelanggan, dan pemangku kepentingan lainnya. Pekerjaan Anda juga akan mencakup koordinasi dan komunikasi dengan mereka tentang apa yang dibutuhkan dokumen, siapa yang akan dijangkau, dan apa yang harus ada di dalamnya.

Anda juga perlu memahami jenis anggaran yang tersedia untuk proyek tertentu dan mengalokasikan waktu, sumber daya, dan upaya Anda sesuai dengan itu. Jika tidak ada cukup sumber daya atau waktu untuk menyelesaikan proyek tertentu, Anda akan diminta untuk memastikan bahwa Anda dapat mengamankan sumber daya tersebut dari manajer dan pemimpin proyek.

Bekerja dengan Perangkat Lunak Eksperimental untuk Menyediakan Dokumentasi

Jika Anda menulis untuk perangkat lunak yang memiliki pembaruan rilis reguler, Anda perlu memahami fungsi dan fitur perangkat lunak eksperimental untuk mendidik pengguna tentang isi setiap pembaruan. Ini dapat mencakup catatan tambalan, perbaikan bug, dll. Biasanya, catatan tambalan dan perbaikan bug jauh lebih pendek daripada dokumentasi teknis tradisional, tetapi jadwal rilisnya lebih sering.

Mengevaluasi dan Merekomendasikan Standar dan Pedoman

Sebagai penulis teknis, Anda akan mengikuti pedoman dan standar tertentu berdasarkan proyek atau organisasi tempat Anda bekerja. Pedoman dan standar ini perlu diperbarui dan diubah pada kesempatan yang berbeda. Proses dan produk akan berubah, jadi standar dan pedoman perlu ditinjau dan dipantau sesekali untuk memastikan mereka memenuhi kebutuhan audiens, produk/layanan, dan organisasi.

Keterampilan yang Dibutuhkan untuk Penulisan Teknis

Jika Anda ingin menjadikan ini sebagai profesi pilihan Anda, pahamilah bahwa ada lebih banyak keterampilan yang dibutuhkan daripada menulis. Penulis teknis yang hebat memiliki berbagai keterampilan untuk memastikan mereka mampu membuat dokumentasi teknis yang hebat. Berikut adalah berbagai keterampilan yang dibutuhkan untuk penulisan teknis -

#1. Kemampuan menulis

Ini adalah pemberian. Penulis teknis harus memiliki keterampilan bahasa yang sempurna dan pemahaman yang mendalam tentang tata bahasa, nada, dan kosa kata untuk membuat dokumen mereka mudah dipahami oleh audiens.

#2. Riset

Penulis teknis perlu mengetahui cara menyelami suatu subjek dan menemukan informasi yang akan sulit ditemukan. Pembaca ingin mengetahui gambaran keseluruhan saat mereka membaca dokumentasi Anda, dan terserah Anda untuk melakukan pekerjaan berat.

#3. Kerja tim

Seringkali, Anda akan menemukan diri Anda sebagai bagian dari tim, bekerja bersama penulis teknis, insinyur, pemimpin tim, manajer, dan pakar hukum lainnya. Anda harus belajar bekerja secara efektif dengan tim untuk menjadi penulis teknis yang hebat.

#4. Sumber tunggal

Sumber tunggal memungkinkan Anda menghasilkan banyak dokumen menggunakan dokumen sumber yang sama. Ini bagus ketika Anda memiliki tugas yang mengharuskan Anda membuat beberapa panduan pengguna untuk audiens yang berbeda tetapi dengan dokumen sumber yang sama.

Satu audiens bisa menjadi pengguna yang kuat, sementara yang lain bisa menjadi orang awam. Di sini, mereferensikan satu dokumen dan membuat beberapa dokumen untuk setiap audiens dapat membantu Anda mengelola waktu dan sumber daya secara efektif.

#5. Menjadi Sistematis

Penulisan teknis, meskipun menyeluruh, juga tidak boleh kehilangan keterbacaan. Dokumen teknis yang diteliti dengan baik tidak ada gunanya jika tidak terstruktur dan disajikan dengan benar. Pembaca akan berjuang untuk menavigasi dokumen, menjadi tugas bagi pembaca untuk memahami. Menjadi sistematis dan terorganisir dalam tulisan Anda akan membantu Anda menyelesaikan proyek Anda lebih cepat sambil juga memastikan bahwa audiens dapat dengan jelas dan efektif memperoleh nilai dari pekerjaan Anda.

#6. Keterampilan Desain Web

Di dunia yang terhubung saat ini, sebagian besar dokumentasi jarang diletakkan di atas kertas untuk dikonsumsi. Meskipun ini opsional, mempelajari keterampilan desain dan pengembangan web dapat membantu membuat dokumentasi Anda mudah diakses di situs web untuk pengguna online yang mencari petunjuk dan informasi.

Membungkus

Apakah Anda berencana untuk mengambil pekerjaan lepas teknis menulis atau berencana untuk bekerja penuh waktu di lapangan, Anda harus memahami dan menguasai semua yang disebutkan di atas. Pekerjaan menulis teknis bisa sangat bermanfaat jika dilakukan dengan benar, karena Anda memberikan informasi yang jelas dan mudah dimengerti kepada ribuan, jika tidak jutaan orang.

Tetapi pada saat yang sama, dari apa yang telah Anda lihat dengan contoh di atas, ini juga merupakan profesi yang sangat menuntut yang mengharuskan Anda untuk tetap mengikuti tren, pasar, inovasi terbaru, dan lainnya untuk setiap bidang yang Anda rencanakan untuk menempatkan layanan Anda. .

Jika Anda membutuhkan konten teknis dan membutuhkan layanan profesional untuk menyusun panduan pengguna yang fantastis yang didukung dengan jaminan kualitas bertenaga AI, Scalenut memiliki semua keahlian yang Anda butuhkan. Hubungi kami dengan kebutuhan Anda sekarang.