IT Technical Writer

Memahami budaya kerja, etika profesional, peran Technical Writer, tata kelola dokumen, klasifikasi informasi, serta aturan kerahasiaan dan keamanan informasi.

Mempelajari teknik wawancara, observasi, pencatatan hasil diskusi, penyusunan pertanyaan, dan pengumpulan informasi dari pemilik proses atau tim teknis.

Menyusun panduan penggunaan aplikasi atau fitur dengan urutan langkah yang logis, prasyarat, penjelasan fungsi, hasil yang diharapkan, dan contoh penggunaan.

Memahami konsep API, endpoint, HTTP method, status code, request, response, header, parameter, authentication secara konseptual, dan format JSON.

Memahami kriteria kualitas dokumen, meliputi akurasi, kelengkapan, keterbacaan, konsistensi, keterlacakan sumber, dan kesesuaian dengan kebutuhan pembaca.

Menentukan objek dokumentasi, ruang lingkup, target pembaca, jenis dokumen, sumber informasi, jadwal, dan kriteria penerimaan bersama mentor.

Memahami prinsip penulisan teknis, karakteristik pembaca, tujuan dokumen, penggunaan bahasa yang jelas, ringkas, akurat, dan mudah dipahami.

Membaca dan memahami requirement, user story, spesifikasi fitur, acceptance criteria, serta artefak proyek untuk mengidentifikasi informasi yang dibutuhkan dalam dokumentasi.

Mendokumentasikan prasyarat instalasi, konfigurasi aplikasi, environment, parameter yang diperlukan, serta prosedur setup berdasarkan informasi yang dikonfirmasi tim teknis.

Mempelajari cara membaca spesifikasi API menggunakan Swagger/OpenAPI atau Postman sesuai akses dan tools yang digunakan perusahaan.

Memeriksa tata bahasa, ejaan, istilah teknis, penomoran, tautan, screenshot, tabel, contoh kode, dan konsistensi format berdasarkan style guide.

Mengumpulkan informasi melalui wawancara, observasi, requirement, spesifikasi, dan artefak proyek, serta mengonfirmasi informasi teknis kepada pemilik materi.

Mempelajari struktur dokumen, heading, penomoran, tabel, daftar, caption, template, style guide, konsistensi istilah, dan pembuatan glosarium.

Memahami alur penggunaan sistem, proses bisnis, komponen aplikasi, dan integrasi antarsistem, kemudian menggambarkannya menggunakan diagram sederhana.

Menyusun Standard Operating Procedure (SOP) teknis dengan tujuan, ruang lingkup, peran, prasyarat, langkah kerja, kontrol, dan prosedur eskalasi yang relevan.

Mendokumentasikan endpoint, fungsi, parameter, request/response, contoh penggunaan, authentication requirements, error response, dan batasan yang telah dikonfirmasi pemilik API.

Melakukan peer review, mencatat komentar reviewer, mengelola feedback, menyusun daftar revisi, dan menindaklanjuti masukan mentor atau pemilik materi.

Menyusun paket dokumentasi sesuai ruang lingkup, seperti user guide, feature guide, SOP, configuration guide, troubleshooting guide, API documentation, atau diagram sistem.

Memahami tahapan SDLC, konsep Agile/Scrum, serta peran Developer, QA, Business Analyst, System Analyst, DevOps, dan Project Manager dalam pengembangan sistem.

Menyusun notulen rapat, ringkasan kebutuhan, daftar pertanyaan terbuka, keputusan, dan tindak lanjut berdasarkan diskusi atau meeting notes yang tersedia.

Menyusun panduan penanganan masalah berdasarkan gejala, kemungkinan penyebab yang telah dikonfirmasi, langkah pemeriksaan, solusi yang disetujui, dan kondisi eskalasi.

Menggunakan Markdown untuk menyusun dokumentasi teknis, termasuk heading, link, tabel, code block, daftar, dan struktur halaman dokumentasi.

Memahami pengelolaan versi, metadata, standar penamaan file, klasifikasi dokumen, status draft/review/approved, serta prosedur approval dan publikasi.

Melakukan review teknis bersama pemilik materi, memeriksa akurasi dan kelengkapan, menerapkan feedback, memperbaiki temuan, serta memastikan kesesuaian dokumen dengan versi sistem yang berlaku.

Memperbaiki dokumen sederhana berdasarkan template, melakukan proofreading awal, memperbaiki struktur dan keterbacaan, serta menyusun glosarium istilah proyek.

Menyusun draft dokumentasi fitur berdasarkan requirement dan sumber teknis yang disetujui, mengidentifikasi informasi yang belum jelas, serta melakukan validasi dengan mentor atau pemilik materi.

Menyusun FAQ dan dokumentasi pesan kesalahan, menggunakan screenshot, caption, tabel, serta contoh yang aman dan sesuai dengan versi aplikasi yang berlaku.

Menggunakan repository Git untuk menyimpan dokumen, membuat branch dan commit, melakukan pull request, mencatat perubahan, serta mengikuti proses review dokumentasi.

Menyusun release notes dan mendokumentasikan perubahan fitur berdasarkan informasi rilis yang telah dikonfirmasi, serta menyelaraskan dokumen dengan versi aplikasi yang berlaku.

Menyelesaikan penamaan dan struktur file, versioning, metadata, histori perubahan, daftar dokumen, status persetujuan, serta serah terima file sumber kepada mentor atau tim terkait.

Memeriksa kelengkapan, konsistensi istilah, urutan langkah, akurasi screenshot, dan keterbacaan, kemudian memperbaiki dokumen berdasarkan review mentor.

Membuat dokumentasi API atau integrasi sederhana berdasarkan spesifikasi yang disetujui, memvalidasi contoh dengan tools yang diizinkan, dan mengonfirmasi akurasi teknis kepada pemilik API.

Melakukan audit terhadap sampel dokumen menggunakan checklist QA, mengidentifikasi gap atau ketidakkonsistenan, menyusun rekomendasi, dan memperbaiki dokumen berdasarkan hasil review.

Mempresentasikan hasil dokumentasi, menjelaskan proses pengumpulan dan validasi informasi, menunjukkan hasil revisi, menyampaikan rekomendasi perbaikan, serta menerima evaluasi akhir mentor.