8+ Contoh Dokumen Technical Writing Beserta Penjelasannya

Technical Writer adalah profesi penulis dengan tugas utama menulis dokumen bersifat teknik menggunakan bahasa yang lebih mudah dipahami. Contoh dokumen technical writing sangat beragam dan masing-masing memiliki tujuan spesifik serta kerangka penulisan yang berbeda-beda.

Meskipun demikian, semua dokumen teknis tersebut memiliki sifat yang sama, yaitu informatif, sistematis, jelas, mudah dipahami, dan bermanfaat bagi penggunanya. 

Jenis-jenis dan Contoh Dokumen Technical Writing

Technical Writer akan melakukan berbagai riset secara mendalam dan bekerja sama dengan tim IT, developer, teknisi, dan tim lainnya untuk memperoleh sumber informasi terpercaya. Informasi tersebut kemudian akan menjadi referensi utama dalam penulisan dokumen teknis.

Dokumen teknis yang paling sering dijumpai dalam kehidupan sehari-hari berupa buku panduan atau user manual book. Selain itu, masih banyak jenis-jenis dokumen teknis yang ditulis oleh seorang Technical Writer.

Apa saja dokumen yang ditulis oleh penulis teknis? Jika belum tahu, maka berikut ini beberapa contoh dokumen teknis yang ditulis oleh Technical Writer, yaitu:

1. User Manual Book

Apa yang dimaksud dengan manual book? User manual book adalah buku panduan berisi spesifikasi produk, aturan, cara instalasi hingga cara menggunakannya. User manual book menjadi dokumen penting karena memberikan informasi lengkap hingga cara menggunakannya, sehingga pengguna tidak akan merasa kesulitan. 

Produk yang memiliki user manual book biasanya berupa alat elektronik, seperti smartphone, televisi, mesin cuci, laptop, dan lainnya. Selain itu, kini user manual book juga sangat penting ditulis untuk melengkapi produk digital, seperti aplikasi.

Jenis user manual book cukup beragam, yaitu instruction, training manual, service manual, SOP, organizational policy manual, dan lainnya.

Berikut ini, sedikit gambaran contoh manual book alat elektronik ASUS PC Notebook, yaitu:

2. Press Release

Selain user manual, contoh dokumen technical writing lainnya adalah press release yang bersifat formal dan aktual. Dokumen press release adalah jenis dokumen yang berisi pengumuman paling update atau terbaru terkait bisnis.

Press release ditulis penulis teknis dengan singkat dan mudah dipahami serta harus memiliki struktur lengkap. Struktur dokumen press release yang dimaksud berupa judul, isi berita press release, informasi kontak perusahaan, hingga kutipan langsung dari pihak yang berkepentingan.

Seperti apa contohnya? Berikut ini contoh dokumen press release PT Kimia Farma yang dapat ditulis oleh penulis teknis, yaitu:

3. Dokumen Terms & Conditions

Dokumen Terms and Conditions adalah dokumen berisi persyaratan dan ketentuan yang mengatur penggunaan suatu produk/ layanan antara dua pihak, seperti produsen dan pengguna. 

Term & Conditions sebagai pernyataan legal bahwa pengguna yang menyetujuinya harus mengikuti semua persyaratan dan ketentuan sebelum menggunakan produk/ layanan dari produsen.

Berikut ini contoh dokumen Term and Conditions Fimela.com yang ditulis oleh penulis teknis, yaitu:

4. API Documentation

API documentation juga merupakan contoh dokumen technical writing. Jenis dokumen yang satu ini berisi kumpulan panduan atau pedoman yang menjelaskan tata cara memprogram hingga menggunakan API untuk keperluan pengguna.

Secara umum, terdapat empat jenis API Documentation, yaitu tutorial menggunakan API, contoh kode permintaan/ respons API secara umum, dokumentasi referensi, dan catatan rilis pembaharuan API.

Technical Writer membuat dokumentasi API dengan menggunakan automation atau manual tools. Meskipun demikian, penulis teknis tetap harus memahami tentang API, mengenali audiens, menulis petunjuk dengan detail, uji/ verifikasi dokumen, dan memperbarui dokumen secara konsisten.

Komponen penting yang ada di dalamnya berupa syarat penggunaan, instruksi otentikasi, contoh permintaan & tanggapan umum, dan informasi detail setiap titik akhir, operasi, dan sumber daya.

Contoh technical writing untuk penulisan API documentation, yaitu:

5. Dokumen FAQ (Frequently Asked Questions)

Dokumen FAQ juga merupakan salah satu jenis dokumen yang ditulis oleh penulis teknis. FAQ berisi pertanyaan-pertanyaan yang sering diajukan terkait produk/ layanan sekaligus jawaban penjelasannya. Pada umumnya, FAQ dapat dengan mudah ditemukan di website perusahaan.

Jenis dokumen ini sangat bermanfaat untuk memberi informasi kepada user terkait segala sesuatu yang berkaitan dengan produk/ layanan dari perusahaan. Pertanyaan dan jawaban dalam FAQ ditulis oleh penulis teknis dengan singkat, jelas, informatif, solutif, dan menggunakan bahasa yang mudah dipahami.

Penulis teknis harus melakukan riset mendalam terlebih dahulu untuk menemukan pertanyaan-pertanyaan yang akan dicantumkan di dalam FAQ. Selain itu, penulis teknis juga harus melakukan update FAQ dengan menambah pertanyaan atau mengganti jawaban dengan data yang lebih update.

Contoh dokumen FAQ dari Google, yaitu:

6. Service Level Agreements (SLA)

SLA atau Service Level Agreements adalah dokumen kontrak yang dibuat dan disetujui oleh dua pihak selaku penyedia dengan pengguna layanan. Dokumen ini memberikan informasi terkait jenis layanan yang akan diberikan kepada pengguna dan standar layanan yang harus dipenuhi oleh penyedia.

Di dalam bisnis, dokumen SLA sangat diperlukan terutama dalam hubungan kerja sama penyedia dan pengguna layanan secara berulang atau jangka panjang.

Penulis teknis harus mampu menulis SLA dengan detail berdasarkan riset yang sudah dilakukan. Isi dari dokumen SLA setidaknya berupa ringkasan perjanjian, deskripsi perjanjian, metrik performa perjanjian, hingga proses penghentian dan persetujuan/ tanda tangan.

Contoh dokumen technical writing berupa Service Level Agreements, yaitu:

7. Dokumen SRS (Software Requirement Specification)

Apa yang dimaksud dokumen SRS? SRS adalah dokumen berisi penjelasan fungsi dari suatu software beserta cara kerjanya untuk memenuhi kebutuhan pengguna. Penjelasan yang dimaksud berupa spesifikasi fungsional dan non fungsional dari software tersebut.

SRS sangat berperan penting dalam pengembangan suatu software karena dapat menjelaskan roadmap yang memberikan arahan untuk semua pihak yang terlibat dalam project hingga menghasilkan software bermanfaat bagi pengguna.

Cakupan dokumen SRS meliputi project overview, tujuan pengembangan software, deskripsi software, performa software, external interfaces, batasan desain, dan lain sebagainya.

Contoh penulisan dokumen SRS, yaitu:

8. Functional Specification Document (FSD)

Contoh dokumen technical writing lainnya adalah FSD (Functional Specification Document). FSD adalah dokumen yang ditulis dengan tujuan memberikan gambaran fungsi sistem software, aplikasi seluler, atau pun aplikasi web secara detail untuk setiap tahapannya.

Contoh dokumen FSD, yaitu:

9. Annual Report

Apa itu annual report? Annual report adalah dokumen berisi laporan keuangan dari seluruh aktivitas perusahaan dalam periode waktu tertentu. Isi dokumen ini lebih detail dan komprehensif jika dibandingkan dengan laporan keuangan perusahaan.

Annual report dapat memberikan gambaran tentang status kondisi keuangan perusahaan, analisis manajemen tentang kondisi tersebut, hingga rencana masa depan perusahaan.

Penulis teknis harus bekerja sama dengan tim lainnya dalam perusahaan terutama bagian finance untuk membantu dalam penulisan annual report. Penulis teknis juga harus bekerja sama dengan praktisi humas terutama untuk menulis annual report yang diberikan ke investor atau pemegang saham.

Berikut ini contoh dokumen annual report dari Pertamina, yaitu:

Contoh dokumen technical writing sangat beragam mulai dari user manual, FAQ, SLA, hingga Annual Report. Seluruh dokumen yang ditulis penulis teknis harus ditulis berdasarkan informasi terpercaya dan riset mendalam melibatkan berbagai pihak dalam perusahaan.

Technical Writer dapat memiliki kemampuan menulis berbagai jenis dokumen teknis ini dengan belajar secara langsung di perusahaan hingga mengikuti sertifikasi atau kelas technical writing berkualitas.

Referensi:

digitalskola.com

technoinfinity.co.id