Masa Lalu
Saya adalah manajer produk untuk produk SaaS, Apidog. Produk ini telah online selama lebih dari dua tahun dan menawarkan banyak fitur terkait pengembangan, pengujian, dan dokumentasi API. Ini juga berarti produk ini membutuhkan serangkaian dokumen bantuan yang komprehensif.
Sebelumnya, kami menggunakan alat Docusaurus untuk memelihara Dokumen Bantuan kami. Ini adalah alat dokumen berbasis Markdown dengan fitur kustomisasi yang kaya.
Namun, menggunakan alat ini sangat menantang bagi kami.
Pertama, ini adalah alat berbasis kode, yang mungkin ramah pengembang, tetapi bagi seorang manajer produk, memodifikasi apa pun berarti menarik kode dan membuat permintaan penggabungan. Saya menghabiskan banyak waktu untuk mencoba memahami logika Git. Hal ini juga menyebabkan kami sering mengabaikan optimasi kecil dalam dokumentasi karena terlalu rumit.
Kedua, itu sepenuhnya didasarkan pada Markdown, yang memiliki dukungan yang sangat terbatas untuk gaya di luar teks biasa. Untuk waktu yang lama, dokumentasi bantuan kami tidak memiliki beranda yang layak.
Ketiga, Docusaurus memiliki dukungan yang buruk untuk banyak bahasa. Alat kami sendiri menawarkan beberapa bahasa (Inggris, Jepang, dengan lebih banyak lagi yang akan datang) dan menyediakan dokumentasi bantuan dalam bahasa Inggris dan Jepang. Namun, di Docusaurus, ini hanya dapat diterapkan sebagai dua proyek yang sepenuhnya terpisah. Selain itu, karena bantuan bahasa Jepang dikelola oleh tim operasi Jepang kami, sering kali ada pembaruan dalam dokumentasi bahasa Inggris yang tidak disinkronkan ke bahasa Jepang.
Pada pertengahan 2024, kami tiba-tiba menyadari bahwa Apidog sendiri adalah alat dokumentasi (walaupun terutama alat dokumentasi API). Apakah ide yang baik untuk menggunakan Apidog secara langsung untuk memelihara dokumentasi bantuannya?
Eksperimen
Faktanya, Apidog adalah alat dokumentasi API yang cukup kuat. Ini mendukung desain API visual, pencampuran Markdown dan dokumen API, navigasi khusus, dan domain khusus. Banyak perusahaan menggunakannya untuk memelihara dokumentasi API mereka.
Tetapi menggunakan Apidog sepenuhnya untuk memelihara dokumentasi bantuan adalah eksperimen baru.
Saya pikir saya harus mencobanya. Jika saya dapat membuat contoh yang indah, mungkin perusahaan yang menggunakan Apidog untuk dokumentasi API juga dapat menggunakannya untuk dokumentasi bantuan mereka.
Saya memulai eksperimen ini sekitar September 2024.
Apidog secara langsung mendukung Markdown, jadi langkah pertama sederhana: migrasikan dokumentasi yang awalnya dipelihara di Docusaurus.
Salah satu fitur hebatnya adalah Apidog mendukung sintaks yang jauh lebih kuat daripada Markdown asli. Misalnya, ini mencakup efek seperti Kartu, Latar Belakang Gambar, Langkah, Sorotan, dan banyak lagi.
Saya menghabiskan banyak waktu untuk mengubah dokumen bantuan Markdown yang ada, membuat gayanya lebih indah dan modern.
Saya juga dengan cepat membuat beranda dokumen, memperbaiki penyesalan sebelumnya.
Namun, selama proses ini, saya juga menemukan beberapa kekurangan dalam kemampuan dokumentasi Apidog.
Misalnya, itu tidak mendukung slug dokumen dan menggunakan angka sebagai akhiran URL sebagai gantinya, yang jelas tidak baik untuk SEO.
Selain itu, itu hanya mendukung pencarian di dalam judul dokumen, bukan konten, yang jelas tidak memadai untuk dokumentasi bantuan.
Untungnya, saya adalah manajer produk untuk produk ini. Bagi saya, ini adalah dua permintaan prioritas tinggi dalam backlog.
Ini terjadi pada Oktober 2024.
Fitur Baru
Pada tanggal 25 Oktober, kami merilis versi 2.6.26. Versi ini mendukung Slug khusus dan pembuatan Slug otomatis berdasarkan nama dokumen.
Pada tanggal 15 November, versi 2.6.31 mendukung Algolia DocSearch, memungkinkan pencarian dokumen teks lengkap.
Selama periode ini, kami menambahkan modul Dukungan ke Dokumen Bantuan asli, dengan setiap halaman mewakili pertanyaan yang sering diajukan dari pengguna.
Pada saat yang sama, kami menggunakan fitur versi API untuk membangun Dokumen Bantuan Jepang. Kami mendukung penerbitan beberapa versi dokumen, dan pembaca dapat memilih versi mana yang akan dibaca di halaman. Anda dapat menganggap setiap versi sebagai revisi atau sebagai bahasa yang berbeda.
Jadi sekarang, saya dapat langsung beralih antara bahasa Inggris/Jepang pada dokumentasi bantuan.
Sekarang, saya memiliki serangkaian dokumen bantuan yang indah dan kuat yang dipelihara menggunakan produk kami sendiri. Saya melengkapinya dengan domain dan navigasi khusus, dan itu terlihat sempurna.
Bagian terbaiknya adalah tidak perlu lagi melakukan pull dan MR setiap kali, dan setiap manajer produk dapat langsung memelihara dokumentasi bantuan untuk fitur yang baru diluncurkan. Efisiensi dan efektivitas telah meningkat secara signifikan dibandingkan sebelumnya.
Tim dukungan teknis kami juga dapat langsung memelihara pertanyaan yang sering diajukan dari email atau Discord ke bagian Dukungan, hanya dengan menggunakan Apidog.
Semua gambar dapat langsung diunggah ke ruang Apidog tanpa memerlukan alat khusus untuk mengunggahnya ke CDN.
Pada awal Desember, versi baru Dokumen Bantuan Apidog kami ditayangkan. Anda dapat membacanya di https://docs.apidog.com.
Sekarang saya dapat dengan bangga mengatakan bahwa Apidog adalah alat yang sangat baik untuk memelihara dokumentasi bantuan dan dokumentasi API. Sebagian besar fitur di atas gratis.
Menggunakan Apidog untuk memelihara dokumentasi bantuan kami adalah keputusan terbaik yang saya buat di paruh kedua tahun 2024.
