Perbarui Dokumentasi Otomatis dari Pertanyaan Dukungan

Saat pertanyaan dukungan yang sama muncul tiga kali, Zero menyusun pembaruan dokumentasi dan mengajukan PR agar orang berikutnya menemukan jawabannya sebelum bertanya.

Zero terhubung ke:

Apa yang Zero berikan

Perbarui Dokumentasi Otomatis dari Pertanyaan Dukungan — sample output from Zero — screenshot 1

Apa masalahnya

Setiap kanal dukungan punya lima atau enam pertanyaan yang tak pernah mati, bukan karena produknya membingungkan, tetapi karena dokumentasi tidak menyebutkannya. Melacak utas itu secara manual, menyusun pembaruan, dan mendorong PR adalah jenis pekerjaan yang selalu terabaikan. Docs Auto-Update memantau kanal dukungan Anda, menghitung pertanyaan berulang, dan begitu sebuah pertanyaan ditanyakan tiga kali atau lebih oleh orang berbeda, Zero menyusun pembaruan dokumentasi dan mengajukan PR. Peninjau menghabiskan dua menit untuk menyetujui. Orang berikutnya yang punya pertanyaan sama menemukan jawabannya alih-alih bertanya.

Bagaimana Zero memperbaikinya

Langkah 1: Hubungkan alat Anda

Slack

Wajib

Slack. Zero membaca kanal dukungan Anda untuk mendeteksi pertanyaan berulang. Akses baca ke kanal yang Anda sebut diperlukan.

Hubungkan

GitHub

Wajib

GitHub. Zero menyusun pembaruan dokumentasi sebagai PR terhadap repo website Anda. Akses tulis repo diperlukan agar Zero dapat membuat branch dan membuka PR.

Hubungkan

Notion

Opsional

Notion. Opsional. Berguna jika dokumentasi internal Anda ada di Notion dan Anda ingin Zero memperbaruinya juga.

Hubungkan

Langkah 2: Tanya Zero

@Zero setiap minggu, pindai #support dan #community untuk pertanyaan yang ditanyakan oleh 3+ orang berbeda selama 14 hari terakhir. Untuk setiapnya, susun pembaruan dokumentasi dan buka PR terhadap repo website dengan perubahan itu.

coba

Zero memantau kanal dukungan Anda untuk pertanyaan berulang

Zero membaca utas dukungan yang masuk, mengelompokkan pertanyaan serupa secara semantik, dan menghitung penanya unik. Pertanyaan dari 3+ pengguna berbeda dalam jendela bergulir ditandai sebagai celah dokumentasi.

Zero menyusun pembaruan dokumentasi berdasarkan jawaban yang terselesaikan

Untuk setiap pertanyaan yang ditandai, Zero membaca penyelesaian utas, mengidentifikasi lokasi dokumentasi yang tepat (bagian yang ada atau panduan baru), dan menyusun pembaruan dalam format markdown situs Anda dengan contoh konkret.

Zero mengajukan PR untuk ditinjau

Setiap draf mendarat sebagai PR di repo website Anda, dengan utas pertanyaan pemicu ditautkan dalam deskripsi. Peninjau dari tim dokumentasi menyetujui; Anda tidak menulis dari nol.

Langkah 3: Lanjutkan lebih jauh

Arahkan ke peninjau yang tepat

Tugaskan PR ke pemilik komponen alih-alih peninjau generik.

@Zero saat menyusun dokumentasi untuk pertanyaan penagihan, tag @billing-team pada PR alih-alih @docs-team.

coba

Publikasikan otomatis pembaruan berisiko rendah

Biarkan perbaikan typo dan klarifikasi kecil terkirim tanpa tinjauan manusia.

@Zero untuk PR dokumentasi di bawah 50 baris yang hanya menyentuh bagian yang ada, aktifkan auto-merge begitu CI lolos.

coba

Perluas cakupan

Tambahkan kanal sumber baru untuk sinyal.

@Zero pindai juga inbox Gmail dukungan untuk pertanyaan berulang, bukan hanya Slack.

coba

Tips untuk hasil yang lebih baik

●Atur ambang 'berulang' pada 3 penanya unik dalam 14 hari, bukan 1. Pada angka 1 Anda hanya menulis ulang dokumentasi setiap hari; pada angka 3 Anda menangkap celah nyata.

●Selalu sertakan utas sumber dalam deskripsi PR. Peninjau dapat melihat pertanyaan asli dan menilai apakah draf benar-benar menjawabnya.

●Padukan dengan KB Capture agar utas yang terselesaikan mengalir ke basis pengetahuan internal Anda secara paralel.