6 Contoh Technical Writing Beserta Penjelasan Lengkap

digitalskola

digitalskola

24 Februari 2024

Berbicara mengenai profesi di bidang digital writing, kebanyakan orang akan fokus pada profesi copywriter atau content writer. Namun, faktanya ada pilihan profesi lain di bidang ini yang juga memiliki prospek karier menarik, yaitu profesi technical writer. Profesi ini masih tergolong underrated alias kurang dilirik di Indonesia, padahal gaji dan peluang yang ditawarkan juga tak kalah dengan profesi lainnya di bidang digital writing. Sebagai gambaran, contoh technical writing hasil tulisan technical writer yang sering kita temui sehari-hari adalah manual book. 

Untuk kamu yang masih penasaran dengan profesi technical writer dan ingin tahu lebih lengkap contoh technical writing, simak artikel ini sampai akhir! 

BACA JUGA: UX Writer: Definisi, Hasil Tulisan, Hingga Prospek Karier

Mengenal Technical Writing dan Profesinya 

Mengenal Technical Writing dan Profesinya 

Mengutip Career Explorer, technical writer adalah penulis yang memiliki tugas spesifik untuk membantu pengguna memahami permasalahan teknis. Sesuai namanya, hasil tulisan profesi ini umumnya bukan dalam bentuk konten atau artikel, tapi lebih banyak berupa dokumen teknis seperti: 

  • User manuals
  • Software installation guides
  • API documentation
  • Service level agreements
  • Press release
  • Annual reports 

Berbeda dengan content writer atau copywriter yang biasanya tergabung ke tim konten atau marketing, technical writer justru umumnya tergabung ke tim IT karena saat bekerja, technical writer akan berkolaborasi dengan developer, engineer, dan lainnya untuk mengumpulkan berbagai informasi agar bisa diubah menjadi tulisan yang mudah dipahami oleh pengguna. Dalam proses penulisannya, technical writer harus memperhatikan berbagai aspek seperti:

  • Tata bahasa = Singkat, jelas, dan mudah dipahami
  • Visual = Gambar, diagram, dan video yang relevan
  • Topik = Topik dan subtopik sesuai kebutuhan user

Selain itu, technical writer juga harus memposisikan diri sebagai user saat menulis. Jika kamu ingin tahu lebih banyak mengenai profesi technical writer, baca selengkapnya di artikel ini. 

Contoh Technical Writing: Manual Book 

        Contoh Technical Writing (Photo by Samsung)

Contoh technical writing yang paling umum ditemukan di kehidupan sehari-hari adalah manual book atau buku panduan yang berisi pedoman, petunjuk, aturan penggunaan, dan informasi lainnya dari produk. Tentunya, setiap beli produk apapun mulai dari handphone, laptop, atau bahkan TV pasti kamu akan dapetin buku panduan ini. Fakta menariknya, manual book ini jadi aspek wajib saat perusahaan launching produk. Sebagai gambaran, berikut contoh isi manual book:

Contoh Technical Writing: Manual Book 
               Contoh Technical Writing (Photo by Samsung)

Di manual book milik Samsung ini dijelaskan cara menggunakan produk TV mereka dengan lengkap seperti:

  • Cara memasang TV pada dinding
  • Cara mencegah TV jatuh
  • Cara merawat TV
  • Cara menghubungkan kamera ke TV
  • Cara pemecahan masalah dan pemeliharaan TV

Faktanya, tidak hanya produk Samsung, manual book juga dibutuhkan oleh perusahaan lainnya yang memiliki produk fisik maupun produk digital karena manual book  jadi alat utama agar user bisa memahami produk. Saking pentingnya, manual book juga dikategorikan lebih spesifik sesuai jenisnya:

  • Instruction/User Manual → Instruksi cara mengoperasikan produk 
  • Training Manual → Instruksi cara menyelesaikan pekerjaan/proses/tugas tertentu
  • Service Manual → Instruksi cara menjaga suatu mesin agar tetap berjalan dalam masa pakainya 
  • Manual (SOP) → Informasi terhadap anggota organisasi/perusahaan berisi instruksi dalam menyelesaikan proses tertentu
  • Organizational Policy Manual →  Dokumen perusahaan berisi kebijakan, prosedur, dan best practice perusahaan

Contoh Technical Writing: Document Terms & Conditions

Contoh Technical Writing: Document Terms & Conditions
               Contoh Technical Writing (Photo by Apple)

Contoh technical writing selanjutnya adalah dokumen yang bisa kamu dapatkan setelah membeli produk tertentu, yaitu Terms & Conditions (T&C). The Guardian menyebut hanya 7% orang membaca seluruh dokumen T&C. Padahal, ternyata dokumen yang jarang dibaca orang ini adalah contoh kerja keras yang dihasilkan oleh profesi technical writer yang bertugas untuk menuliskan hal super teknis agar lebih komunikatif dan bisa dipahami oleh konsumen ketika membeli atau menggunakan suatu produk. Contonya, di dokumen T&C Apple berisi berbagai informasi terkait salah satu produknya yaitu layanan media Apple seperti:

  • Cara pembayaran, pajak, dan pengembalian data
  • Aturan penggunaan layanan dan konten
  • Ketersediaan konten dan layanan
  • Syarat tambahan Apple Music
  • Syarat Pass dan Multi-Pass

Meskipun jarang dibaca, ternyata dokumen ini sangat penting untuk perusahaan. Mengutip dari TermsFeed, dokumen T&C berfungsi untuk menyatakan secara legal aturan-aturan yang harus diikuti dan harus disetujui oleh pelanggan untuk mendapatkan akses ke produk atau layanan yang dijual bisnis.

Contoh Technical Writing: Document Frequently Asked Question

Contoh Technical Writing: Document Frequently Asked Question
             Contoh Technical Writing (Photo by Creator Pinterest)

Contoh technical writing selanjutnya adalah dokumen FAQ yaitu dokumen yang jadi elemen penting dan tidak bisa terpisahkan dari sebuah website perusahaan. Sebenarnya, secara istilah FAQ artinya adalah pertanyaan yang sering diajukan. Oleh karena itu, awalnya FAQ jadi tulisan yang ditulis technical writer untuk menjawab pertanyaan terkait website. Namun, saat ini, FAQ juga memuat pertanyaan mengenai segala hal yang berkaitan dengan produk atau layanan yang ditawarkan bisnis seperti:

  • Detail produk atau layanan
  • Kegunaan platform aplikasi

Sebagai contoh, FAQ di website Creator Pinterest mencakup berbagai pertanyaan standar yang sering ditanyakan oleh penggunanya, seperti:

  • Apa itu Pinterest?
  • Bagaiman cara kerjanya?
  • Apa itu pin?
  • Audiens seperti apa yang ada di Pinterest?

Technical writer di sini berperan untuk menuliskan jawaban dari setiap pertanyaan yang sering ditanyakan dengan singkat, jelas, dan mudah dipahami. Contohnya seperti berikut ini: 

Contoh Technical Writing: Document Frequently Asked Question
             Contoh Technical Writing (Photo by Creator Pinterest)

Sebagai technical writer, saat menulis FAQ ada beberapa step yang harus dilakukan, diantaranya:

  • Mengumpulkan semua pertanyaan yang relevan dengan kebutuhan pelanggan. Biasanya dikumpulkan dari pertanyaan aktual atau dari survei
  • Menyusun jawaban FAQ yang ringkas, jelasn, akurat, mudah dipahami, dan komprehensif agar bisa memberikan solusi yang tepat untuk pelanggan
  • Memantau dan menganalisis FAQ secara berkala dan menambahkan beberapa pertanyaan baru yang banyak ditanyakan pelanggan

BACA JUGA: Stuck dengan Pekerjaan? Mungkin Switch Career adalah Solusi.

Contoh Technical Writing: API Documentation

Contoh Technical Writing: API Documentation
                Contoh Technical Writing (Photo by HubSpot Blog)

API documentation atau dokumentasi API adalah kumpulan panduan yang menjelaskan cara menggunakan atau memprogram API. Technical writer umumnya menggunakan manual tools atau automation tools untuk menulis dokumentasi API yang menyediakan berbagai informasi tentang cara kerja:

  • Perangkat lunak
  • Perangkat keras
  • API Web

Di industri, ada berbagai jenis dokumentasi API. Berikut empat jenis yang paling umum ditemukan di industri:

  • Dokumentasi referensi = Berisi metode, parameter, dan tipe data
  • Tutorial = Berisi tutorial yang memberi petunjuk langkah demi langkah untuk menggunakan API
  • Contoh kode = Berisi contoh permintaan dan respons API yang paling umum
  • Catatan rilis = Berisi pembaruan mengenai perubahan pada API seperti fitur baru, perbaikan bug, atau patch keamanan

Dalam pengerjaannya, technical writer harus membuat dokumentasi API yang memiliki komponen berikut ini:

  • Instruksi otentikasi yang bisa menjaga data API agar tetap aman dan terlindungi
  • Informasi mendetail mengenai setiap titik akhir, operasi, dan sumber daya
  • Contoh permintaan dan tanggapan umum
  • Syarat penggunaan

Untuk bisa menulis dokumentasi API yang memiliki komponen-komponen di atas, kamu harus:

  • Memahami API 
  • Mengenali audiens 
  • Mampu menulis petunjuk yang terperinci
  • Meninjau, uji, dan verifikasi dokumentasi
  • Memperbarui dokumentasi secara terus-menerus

BACA JUGA: Wajib Diasah! Ini Cara Meningkatkan Softskill untuk Jobseeker

 Contoh Technical Writing: Service Level Agreement

 Contoh Technical Writing: Service Level Agreement
              Contoh Technical Writing (Photo by Juro)

Contoh technical writing selanjutnya adalah service level agreement yaitu kontrak yang menetapkan sekumpulan kewajiban yang akan diberi kepada pihak lain seperti customer dan vendor. Umumnya, dokumen ini digunakan antara badan bisnis dan pelanggannya atau departemen yang memberikan layanan berulang kepada departemen lain dalam sebuah bisnis. Konten yang dimuat dalam service level agreement adalah:

  • Ringkasan perjanjian mulai dari waktu dan tanggal berlaku hingga pengenalan tentang kewajiban masing-masing pihak
  • Deskripsi perjanjian
  • Metrik performa perjanjian
  • Proses penghentian dan tanda tangan

Berikut contohnya:

 Contoh Technical Writing: Press Release 

 Contoh Technical Writing: Press Release 
                   Contoh Technical Writing (Photo by Apple)

Contoh technical writing lainnya adalah siaran pers yaitu dokumen formal dan faktual yang dikeluarkan oleh organisasi atau perusahaan yang memuat pengumuman terkait bisnis. Dokumen teknis satu ini memiliki format khusus yang mencakup:

  • Judul
  • Informasi/isi pengumuman
  • Informasi kontak perusahaan
  • Kutipan langsung dari pemangku kepentingan

Belajar dan Praktik Technical Writing Bersama Mentor Expert

Belajar dan Praktik Technical Writing Bersama Mentor Expert
            Belajar Technical Writing  (Photo by Firmbee.com from Unsplash)

Ingin praktik membuat hasil tulisan technical writing? Kamu bisa belajar skill sekaligus praktik bersama mentor expert di kelas Technical Writing Specialist dari Digital Skola. Di kelas ini, tak hanya belajar teori, kamu juga akan praktik langsung membuat tulisan technical writing yang bisa dijadikan bahan portfolio:

  • Praktik membuat images dalam Technical Document Template
  • Praktik membuat flowcharts dalam Technical Document Template
  • Praktik membuat graphs and charts dalam Technical Document Template
  • Praktik membuat tables dalam Technical Document Template
  • Praktik membuat index & variabel dalam Technical Document Template
  • Live Mentoring Project dalam membuat Tech Document Template
  • Praktik membuat Technical Document Template jenis SRS dan API Doc

Selama praktik menulis technical writing, hasil tulisan kamu juga bisa dapat fasilitas live mentoring project yaitu hasil tulisan kamu akan di-review langsung oleh mentor expert yang merupakan praktisi ahli di bidangnya sehingga hasil tulisan yang akan dicantumkan portfolio merupakan hasil tulisan terbaik yang kamu buat. Tunggu apalagi? Cek info lengkapnya dengan klik button di bawah ini!

chat