Menulis Dokumentasi Teknis Lebih Cepat dengan AI

AI bisa memangkas waktu menulis dokumentasi teknis dari berjam-jam menjadi beberapa menit untuk draf pertama, asalkan kamu memberinya bahan yang benar dan memeriksa hasilnya sebelum dipakai.

Kenapa ini penting? Dokumentasi biasanya jadi pekerjaan yang ditunda. Akibatnya, cara memulihkan server hanya ada di kepala satu orang, dan saat orang itu cuti, tim lain menebak-nebak. AI tidak menggantikan pemahaman engineer, tapi menghilangkan bagian paling membosankan: merapikan catatan mentah menjadi dokumen yang bisa dibaca.

Dokumen apa yang paling cocok dibantu AI?

Tidak semua dokumen sama mudahnya. Berikut gambaran kasar dari pengalaman umum tim teknis:

Polanya jelas: AI unggul saat tugasnya merangkum dan merapikan bahan yang sudah ada. Ia lemah saat diminta menjelaskan alasan di balik keputusan, karena alasan itu tidak tertulis di mana pun.

Alur kerja yang terbukti praktis

1. Kumpulkan bahan mentah dulu

Sebelum membuka chat AI, siapkan bahan: potongan kode, file konfigurasi, keluaran history dari terminal, catatan rapat, atau tiket lama. Semakin konkret bahannya, semakin sedikit AI mengarang. Jangan minta "buatkan dokumentasi server Nginx" tanpa konteks, karena hasilnya akan berupa dokumen umum yang tidak sesuai dengan servermu.

2. Bersihkan data sensitif

Hapus kata sandi, token API, alamat IP internal, dan data pelanggan sebelum menempelkan bahan. Ganti dengan penanda seperti <TOKEN_API> atau <IP_DB>. Cara lengkapnya ada di cara menyamarkan data pribadi sebelum dikirim ke AI.

3. Beri kerangka yang tegas

Tentukan bagian yang kamu inginkan. Contoh prompt untuk runbook:

Kamu menyusun runbook untuk tim operasional. Dari catatan perintah di bawah,
buat dokumen dengan bagian: Tujuan, Prasyarat, Langkah (bernomor, satu perintah
per langkah), Cara memastikan berhasil, Cara membatalkan (rollback).
Jangan menambah perintah yang tidak ada di catatan. Tandai dengan [PERLU CEK]
bila ada langkah yang kurang jelas.
---
(tempel catatan perintah di sini)

Kalimat "jangan menambah perintah yang tidak ada" dan penanda [PERLU CEK] sangat membantu. AI cenderung mengisi celah dengan tebakan yang terdengar meyakinkan, dan penanda itu memaksa tebakan tersebut terlihat.

4. Uji setiap perintah

Ini bagian yang tidak bisa dilewati. Jalankan langkah di dokumen pada server uji atau VM sekali pakai. Flag yang salah, nama paket yang berbeda antar distro, atau path yang keliru sering lolos dari pandangan sekilas. Prinsip memeriksanya mirip dengan memeriksa fakta jawaban AI: anggap semua benar hanya setelah dibuktikan.

5. Minta AI meninjau dari sudut pembaca

Setelah draf benar, minta AI berperan sebagai anggota tim baru: "Bagian mana dari dokumen ini yang membingungkan bagi orang yang belum pernah memegang server ini?" Pertanyaan ini sering menemukan istilah yang belum dijelaskan atau langkah yang dianggap sudah diketahui.

Kesalahan yang membuat dokumentasi AI menyesatkan

Beberapa kesalahan yang sering terjadi:

• Versi tercampur. AI menulis opsi yang berlaku untuk versi lain dari perangkat lunak yang kamu pakai. Sebutkan versi secara eksplisit di prompt.
• Gaya terlalu panjang. Draf AI sering bertele-tele. Minta versi yang lebih ringkas, atau hapus paragraf pembuka yang tidak menambah informasi.
• Dokumen tidak ikut diperbarui. Simpan dokumentasi di repositori yang sama dengan kode, sehingga setiap perubahan konfigurasi bisa langsung diikuti perubahan dokumen dalam satu commit.
• Menyalin keluaran log mentah. Log bagus sebagai bahan, tapi pilih bagian yang relevan. Untuk menganalisis log itu sendiri, lihat memakai AI membaca log server.

Memakai AI untuk merawat dokumen lama

Dokumentasi jarang salah saat pertama ditulis. Ia menjadi salah pelan-pelan, karena server diubah tapi dokumennya tidak. AI bisa membantu di sini juga. Tempelkan dokumen lama bersama konfigurasi terbaru, lalu minta: "Sebutkan bagian dokumen yang tidak lagi sesuai dengan konfigurasi ini. Jangan menulis ulang, cukup tunjukkan perbedaannya." Hasilnya berupa daftar pendek yang bisa kamu periksa satu per satu, jauh lebih cepat daripada membaca ulang seluruh dokumen.

Menjaga gaya tetap seragam di seluruh tim

Kalau beberapa orang memakai AI untuk menulis dokumen, hasilnya bisa berbeda-beda gaya. Solusinya sederhana: buat satu file panduan gaya pendek (bahasa yang dipakai, format judul, cara menulis perintah, istilah baku), lalu tempelkan di awal setiap prompt. Banyak aplikasi AI juga punya fitur instruksi proyek yang menyimpan panduan ini sehingga tidak perlu ditempel ulang.

Templat yang sama juga bisa dipakai untuk dokumen nonteknis, misalnya SOP operasional. Pembahasannya ada di membuat SOP perusahaan dengan AI.

Berapa waktu yang benar-benar dihemat?

Tidak ada angka pasti, karena bergantung pada kerapian bahan dan seberapa teliti proses pengujiannya. Yang konsisten terasa: waktu menulis draf berkurang drastis, sementara waktu menguji tetap sama. Jadi jangan menghitung hematnya dari kecepatan AI mengetik, tapi dari berapa banyak dokumen yang akhirnya benar-benar selesai dan dipakai tim.