Dokumen-Dokumen yang Dibuat oleh Seorang Technical Writer

Technical writer memiliki tanggung jawab yang luas dalam membuat berbagai jenis dokumentasi untuk membantu berbagai pemangku kepentingan dalam memahami dan menggunakan produk atau sistem dengan efektif. Setiap dokumen yang dibuat oleh technical writer, memiliki tujuan spesifik dan audiens yang berbeda. Dokumen-dokumen yang dibuat bertujuan dapat menghasilkan dokumentasi yang jelas, informatif, dan bermanfaat bagi semua pengguna.

Berikut merupakan beberapa jenis dokumen yang dibuat oleh technical writer:

Dokumen Spesifikasi Kebutuhan Bisnis (Business Requirement Document – BRD)

BRD merupakan suatu dokumen yang menjelaskan secara detail dan merinci mengenai proyek baru yang akan dibangun. Dokumen ini menguraikan tujuan proyek, apa yang diharapkan dan apa yang diperlukan untuk menyelesaikan proyek, terdapat beberapa komponen BRD diantaranya.

Executive Summary

Executive summary merupakan komponen BRD yang memberikan gambaran secara singkat mengenai isi dokumen dan pentingnya proyek yang mencakup tujuan proyek, lingkup, kebutuhan bisnis utama, dan manfaat yang diharapkan.

Project Objectives

Bagian ini memberikan rincian terkait tujuan utama proyek dengan cakupan hasil yang diharapkan, pencapaian yang diinginkan, dan tujuan bisnis yang ingin dicapai melalui proyek tersebut.

Project Scope

Scope ini menjelaskan secara detail terkait deskripsi tentang apa yang akan disertakan dalam proyek dan apa yang tidak akan disertakan. Scope dari project ini dapat membantu menghindari ambiguitas dan memastikan bahwa semua pemangku kepentingan memiliki pemahaman yang jelas tentang batasan proyek.

Business Requirements

Business Requirements menggambarkan kebutuhan bisnis yang harus dipenuhi saat pengerjaan proyek. Kebutuhan bisnis tersebut dapat berdasarkan kebutuhan pengguna akhir atau pemangku kepentingan bisnis lainnya.

Key Stakeholders

Key Stakeholders merupakan daftar dari semua pemangku kepentingan yang terlibat dalam proyek mencakup peran dan tanggung jawab masing-masing pemangku kepentingan serta informasi kontak.

Project Constrains

Project Constrains menjelaskan batasan yang dapat memengaruhi kemampuan proyek untuk mencapai tujuannya. Ini bisa termasuk batasan anggaran, batasan waktu, atau keterbatasan sumber daya lainnya.

Cost-Benefit Analysis

Cost-Benefit Analysis membandingkan biaya pengembangan proyek dengan manfaat yang diharapkan atau yang dihasilkan dari proyek. Analisis ini membantu dalam pengambilan keputusan untuk memutuskan apakah proyek layak dilaksanakan atau tidak.

Kick Off Meeting Agenda

KIck Off Meeting Agenda merupakan suatu dokumen yang mencantumkan notulensi meeting pertama kali ketika proyek baru berhasil didapatkan vendor atau baru akan dibangun, pada dokumen ini kebutuhan awal proyek biasanya didiskusikan kembali

Dokumen Spesifikasi Kebutuhan Sistem (Software Requirement Specification – SRS)

SRS merupakan dokumen yang menjelaskan fungsi perangkat lunak  dan bagaimana kinerjanya sehingga dapat memenuhi kebutuhan semua stakeholder, berikut merupakan contoh template dan komponen yang ada dalam dokumen SRS.

Report Sprint

Report Print merupakan dokumen yang mencantumkan progress pengerjaan proyek berdasarkan sprint. Sprint adalah aktivitas pekerjaan yang harus diselesaikan oleh tim Scrum dalam periode waktu yang telah ditentukan, biasanya berdurasi selama satu bulan atau kurang.

Dokumen report sprint terdiri dari dokumen:

• Sprint Review
• End of Sprint
• Scope of Work

Manual Pengguna (User Manual)

User Manual adalah panduan yang membantu pengguna akhir memahami cara menggunakan produk atau layanan. Dokumen ini mencakup instruksi langkah demi langkah, ilustrasi, dan solusi untuk masalah umum. Manual pengguna ditulis dengan bahasa yang mudah dipahami oleh audiens non-teknis.

Minutes Of Meeting (MOM)

MOM merupakan dokumen yang berisi catatan rangkuman diskusi yang terjadi selama meeting berlangsung. Berikut merupakan salah satu contoh template MOM.

Functional Spesification Document (FSD)

Dokumen Spesifikasi Fungsional (FSD) adalah dokumen yang dirancang untuk memberikan gambaran tentang bagaimana fungsi sistem perangkat lunak, aplikasi seluler, atau aplikasi web. Dokumen tersebut memberikan garis besar langkah demi langkah yang mendetail tentang fungsionalitas dan aliran setiap item. Berikut merupakan contoh template dan komponen yang ada pada dokumen SRS.

Kesimpulan

Pada dasarnya, dokumen yang dibuat oleh Technical Writer merupakan dokumen-dokumen utama yang sering digunakan pada proses pembuatan perangkat lunak. Dokumen tersebut bukan hanya digunakan oleh tim internal (tim developer dan stake holder), tapi juga digunakan untuk client. Oleh karena itu, sangat penting bagi seorang Technical Writer untuk membuat dokumentasi yang jelas dan bisa diandalkan.

Tertarik menjadi seorang Technical Writer? Tunggu artikel lainnya dari kami.

Baca juga artikel lainnya di sini.

Tentang Penulis