Panduan Utama Dokumentasi Produk: Semua yang Perlu Anda Ketahui untuk Membuat Dokumen Hebat

Dokumentasi produk…mungkin bukan bagian terseksi dalam menjalankan bisnis, tetapi ini adalah area utama yang tidak boleh Anda abaikan jika Anda ingin bisnis Anda sukses.

Membuat dokumentasi produk berkualitas tinggi dapat membantu Anda membuat pelanggan Anda lebih sukses, mengurangi beban dukungan Anda, dan secara umum membangun bisnis yang lebih baik.

Tapi apa yang masuk ke dalam membuat dokumentasi produk? Dan bagaimana Anda bisa mengatur dokumentasi Anda sendiri di situs web Anda?

Itu hanya beberapa pertanyaan yang akan kami jawab dalam panduan utama kami untuk dokumentasi produk. Inilah semua yang akan kami bahas:

• Mengapa Anda harus peduli dengan strategi dokumentasi produk Anda?
• Beberapa contoh nyata dari dokumentasi terbaik
• Perangkat lunak dokumentasi produk terbaik
• Delapan tips untuk membuat dokumentasi yang lebih baik

Apakah Anda siap untuk meningkatkan cara bisnis Anda menangani dokumentasi? Mari kita menggali!

Mengapa Anda Harus Peduli Tentang Strategi Dokumentasi Produk Anda

Mari kita mulai dengan melihat mengapa Anda tidak perlu berhemat pada strategi dokumentasi produk Anda.

Itu Membuat Pelanggan Anda Lebih Sukses

Manfaat terbesar dari membuat dokumentasi produk adalah membuat pelanggan Anda lebih sukses. Memiliki lebih banyak pelanggan yang berhasil berarti tingkat konversi yang lebih tinggi, tingkat churn yang lebih rendah, dan seterusnya.

Masuk akal – jika pelanggan tidak dapat menemukan cara untuk mendapatkan nilai dari produk Anda, mereka tidak akan tetap menjadi pelanggan untuk waktu yang lama.

Dokumentasi produk adalah salah satu cara yang berguna untuk mengedukasi pelanggan agar mereka bisa mendapatkan nilai sebanyak mungkin. Ketika mereka mendapatkan nilai lebih dari produk Anda, kemungkinan besar mereka akan terus membayar, merekomendasikan Anda kepada teman/rekan kerja mereka, dan seterusnya.

Ini Mengurangi Beban Dukungan Anda

Dokumentasi produk juga bisa menjadi cara yang bagus untuk mengurangi beban saluran dukungan manusia Anda.

Jika dokumentasi produk Anda berkualitas rendah atau tidak ada, itu berarti pelanggan Anda perlu menghubungi tim dukungan manusia Anda setiap kali ada masalah. Itu berarti lebih banyak waktu yang dihabiskan untuk menanggapi permintaan dukungan.

Anda harus meluangkan waktu untuk mengembangkan bisnis Anda untuk menangani tanggapan ini sendiri atau Anda harus menyewa orang pendukung yang berdedikasi ( yang membutuhkan biaya ).

Dengan dokumentasi berkualitas tinggi, pelanggan akan dapat memecahkan banyak masalah mereka sendiri, yang menghilangkan kebutuhan mereka untuk menjangkau dukungan. Anda juga dapat menyusun proses dukungan untuk mendorong orang memeriksa dokumentasi Anda sebelum mengajukan permintaan.

Ini Bisa Menjadi Alat Pemasaran dan Penjualan yang Baik

Sementara banyak orang berpikir tentang dokumentasi produk dalam konteks membantu orang yang telah memutuskan untuk melakukan pembelian, dokumentasi produk yang baik juga dapat membantu Anda menarik dan mengonversi lebih banyak pelanggan.

Dari perspektif pemasaran, dokumentasi produk adalah tambang emas kata kunci SEO ekor panjang yang dapat Anda peringkatkan untuk dokumentasi Anda. Anda mungkin terkejut dengan jumlah orang yang langsung melihat dokumentasi produk Anda dari Google. Jika Anda menyusun dokumentasi Anda dengan baik, Anda akan memiliki kesempatan untuk mengubah orang-orang ini menjadi pelanggan.

Dokumentasi Anda juga bisa menjadi alat penjualan yang berguna bagi orang-orang yang ragu untuk membeli produk Anda. Dokumentasi produk dapat menjawab pertanyaan pra-penjualan potensial yang mungkin mereka miliki, meyakinkan mereka bahwa produk Anda dapat melakukan apa yang mereka butuhkan, dan memberi mereka keyakinan bahwa mereka akan mendapatkan bantuan saat mereka membutuhkannya.

Misalnya, Stripe dikenal memiliki beberapa dokumentasi produk terbaik. Jika Anda membuka Twitter, Anda dapat melihat banyak orang merekomendasikan Stripe karena kualitas dokumentasi Stripe:

Itu Membuat Karyawan Anda Lebih Efektif

Dokumentasi produk tidak hanya untuk pelanggan, tetapi juga dapat menjadi sumber penting bagi anggota tim Anda untuk mempelajari produk dan referensi Anda saat dibutuhkan. Hal ini terutama berlaku untuk karyawan baru, yang mungkin tidak memiliki dasar pengetahuan yang luas tentang produk Anda.

Empat Contoh Dokumentasi Produk Kehidupan Nyata yang Hebat

Untuk memberi Anda lebih banyak inspirasi, mari kita lihat beberapa contoh dokumentasi produk dunia nyata dari perusahaan yang sukses.

1. Garis

Kami menyebutkan Stripe sebelumnya sebagai salah satu contoh terbaik dari dokumentasi kualitas sebagai alat pemasaran/penjualan, jadi Anda tahu bahwa dokumentasi Stripe harus menjadi nomor satu dalam daftar kami.

2. Adien

Adyen adalah platform pembayaran untuk pembayaran eCommerce, seluler, dan point-of-sale. Seperti Stripe, itu berarti pengembang perlu mengintegrasikannya ke dalam platform mereka sendiri, yang memerlukan dokumentasi yang sangat baik. Adyen tidak mengecewakan – lihat dokumentasi lengkap Adyen di sini.

3. Twilio

Jika Anda tidak terbiasa dengan Twilio, ini adalah alat yang membantu bisnis membangun komunikasi ke dalam platform mereka, melalui pesan teks, email, panggilan telepon, dan banyak lagi. Seperti halnya Stripe dan Adyen, ini berarti bisnis perlu mengintegrasikan Twilio ke dalam layanan mereka yang sudah ada, yang memerlukan dokumentasi terbaik. Anda dapat menelusuri dokumen Twilio untuk melihat contoh yang bagus.

4. Lemas

Slack adalah alat lain yang memiliki dokumentasi yang ditulis dengan sangat baik dan berguna. Anda dapat menelusuri dokumentasi Slack lengkap di sini.

Untuk melihat beberapa contoh lainnya, lihat posting lengkap kami tentang contoh dokumentasi pengguna terbaik.

Perangkat Lunak Dokumentasi Produk Terbaik

Sekarang, mari kita beralih ke bagaimana Anda dapat mulai menawarkan dokumentasi produk yang lebih baik di situs Anda.

Kita akan berbicara tentang menulis dokumentasi Anda di bagian selanjutnya. Namun, sebelum Anda dapat menulis dokumentasi, Anda memerlukan tempat untuk menyimpan artikel tersebut dan membuatnya dapat diakses oleh pengguna Anda.

Meskipun Anda dapat menambahkan artikel ini langsung ke situs Anda, akan lebih baik jika Anda menggunakan perangkat lunak dokumentasi produk khusus. Selain mengatur konten Anda dan membuatnya dapat diakses oleh pengunjung, perangkat lunak dokumentasi produk yang baik akan menyertakan fitur berguna lainnya seperti…

• Fungsi pencarian Ajax untuk membantu pengunjung menelusuri dokumentasi.
• Analisis penelusuran sehingga Anda dapat melihat topik yang dicari orang.
• Data kegunaan sehingga Anda dapat melacak seberapa membantu setiap artikel individual dan meningkatkan bila diperlukan.

Berikut adalah dua solusi terbaik…

Basis Pengetahuan Heroik (Heroik KB)

Heroic Knowledge Base adalah plugin untuk perangkat lunak WordPress open-source gratis yang memungkinkan Anda dengan mudah membuat hub dokumentasi produk yang dihosting sendiri.

Jika Anda sudah menggunakan WordPress untuk situs web bisnis Anda, Anda dapat menambahkan Basis Pengetahuan Heroik ke situs Anda untuk membuat hub dokumentasi Anda sendiri. Atau, jika tidak, Anda dapat membuat instalasi WordPress khusus untuk dokumentasi Anda. Dalam kasus terakhir, Anda mungkin juga tertarik dengan tema dokumentasi WordPress KnowAll .

Basis Pengetahuan Heroic memungkinkan Anda menambahkan semua dokumentasi Anda menggunakan editor konten WordPress, yang memudahkan untuk memasukkan konten multimedia jika diperlukan. Anda juga akan mendapatkan akses ke sistem pembuatan versi konten bawaan WordPress, yang memungkinkan Anda dengan mudah melacak perubahan dan membandingkan versi sebelumnya dari dokumentasi Anda.

Basis Pengetahuan Heroik juga menambahkan sejumlah fitur berguna termasuk:

• Pencarian Ajax instan.
• Analisis pencarian.
• Peringkat bantuan artikel.
• lampiran file artikel.

Pangkalan Pengetahuan Heroik hanya berharga $129.

Bantuan Adobe Robo

Jika Anda hanya memublikasikan dokumentasi Anda di web, hanya solusi seperti Basis Pengetahuan Heroik yang Anda butuhkan. Namun, untuk kebutuhan dokumentasi tingkat perusahaan yang lebih banyak, Anda mungkin memiliki situasi di mana Anda perlu mempublikasikan dokumentasi Anda di berbagai platform termasuk web, kertas fisik, aplikasi seluler, PDF, dan sebagainya.

Dalam hal ini, Anda mungkin lebih suka alat pembuat dokumentasi multi-platform seperti Adobe RoboHelp. Mulai dari $29,99 per bulan untuk penggunaan individu, ini lebih mahal daripada Basis Pengetahuan Heroik. Namun, jika Anda membutuhkan pembuatan multi-platform, harga tambahan itu mungkin sepadan dengan uangnya.

Cara Mengoptimalkan Struktur dan Konten Dokumentasi Produk Anda

Sekarang setelah Anda memiliki perangkat lunak yang diperlukan untuk mengelola dokumentasi Anda, mari kita bicara tentang bagaimana Anda dapat menulis artikel berkualitas tinggi. Berikut adalah delapan tip kunci untuk menyusun dokumentasi Anda dan menulis artikel bantuan yang lebih baik…

1. Pahami Audiens Anda

Untuk menulis dokumentasi produk yang hebat, Anda perlu memahami audiens yang Anda tulis (yaitu pelanggan Anda).

Untuk siapa Anda menulis akan memengaruhi informasi apa yang Anda sertakan dan bagaimana Anda menyusun semuanya. Misalnya, jika Anda menulis untuk pengembang, dokumentasi Anda harus sangat berbeda dari menulis untuk pengguna biasa.

Anda tidak ingin menganggap audiens Anda ahli dan mengabaikan detail utama, tetapi Anda mungkin mengasumsikan beberapa pengetahuan dasar tergantung pada siapa mereka.

2. Pahami Berbagai Jenis Dokumentasi Produk

Ada berbagai jenis dokumentasi produk dan masing-masing memerlukan pendekatan yang berbeda. Beberapa jenis yang umum adalah:

• Tinjauan – artikel ini memberikan gambaran umum tentang cara kerja area produk Anda, seperti panduan “Memulai”.
• Tutorial langkah demi langkah – artikel ini menunjukkan kepada orang-orang cara melakukan tugas tertentu.
• Referensi – artikel ini menjelaskan konsep spesifik dalam produk Anda.
• Pemecahan masalah – artikel ini menjelaskan cara men-debug/memecahkan masalah umum yang mungkin dihadapi pelanggan.

Jenis dokumentasi yang sedang Anda kerjakan harus memengaruhi cara Anda menulis dan bagaimana Anda menyusun dokumentasi Anda, jadi penting untuk mengetahui apa tujuannya sebelum Anda menggali lebih dalam.

3. Konsisten Dalam Gaya dan Konvensi Penamaan Anda

Untuk membuat dokumentasi produk Anda lebih mudah digunakan oleh pelanggan Anda, penting bagi Anda untuk mempertahankan gaya dan konvensi penamaan yang sama di seluruh dokumentasi Anda. Ini akan memudahkan pelanggan untuk mengikuti dokumentasi Anda dan menghindari kemungkinan kebingungan.

Untuk membantu Anda melakukan ini, mungkin berguna untuk membuat panduan gaya untuk pemformatan dan terminologi dasar.

4. Gunakan Bahasa Polos dan Tetap Ringkas

Semua hal sama, singkat, bahasa sederhana selalu lebih baik daripada kata salad. Tujuan Anda adalah mengomunikasikan semua informasi yang diperlukan dalam kata-kata sesedikit mungkin.

Anda juga harus menghindari penggunaan jargon atau istilah yang rumit bila memungkinkan. Tidak semua pelanggan Anda akan memiliki basis pengetahuan yang sama dan beberapa bahkan mungkin bukan penutur asli bahasa dokumentasi Anda, jadi menjaga hal-hal sesederhana mungkin memastikan bahwa setiap orang bisa mendapatkan nilai dari dokumentasi Anda.

5. Atur Dokumentasi Dalam Artikel “Berukuran Masalah” yang Logis

Untuk memudahkan orang menelusuri dokumentasi Anda dan menemukan artikel untuk masalah spesifik mereka, Anda perlu memecah dokumentasi Anda menjadi segmen logis. Secara umum, setiap artikel harus difokuskan pada pemecahan satu masalah tertentu.

Tentu saja, mungkin ada beberapa sub-masalah dalam masalah utama itu, tetapi idenya adalah Anda tidak ingin menggabungkan dua masalah yang sama sekali terpisah ke dalam artikel yang sama karena akan mempersulit orang untuk mencari topik tersebut dan mereka mungkin bingung ketika mereka mendarat di artikel.

Pelanggan Anda tidak akan membaca dokumentasi Anda secara linier seperti mereka sedang membaca buku. Sebaliknya, mereka akan melompat-lompat berdasarkan masalah yang mereka hadapi saat ini. Memecah artikel Anda menjadi segmen-segmen logis membantu Anda menjelaskan perilaku ini.

6. Memasukkan Elemen Multimedia

Meskipun teks tertulis harus menjadi inti dari dokumentasi produk Anda, itu seharusnya bukan satu-satunya. Ini juga dapat membantu untuk memasukkan konten gambar dan video yang masuk akal.

Jika menyertakan tangkapan layar, Anda juga dapat menambahkan anotasi ke gambar untuk memperjelas detail utama.

7. Gunakan Judul dan Tambahkan Daftar Isi

Dalam setiap artikel dokumentasi produk, pastikan untuk menggunakan heading untuk membagi artikel Anda menjadi segmen-segmen logis, bukan hanya menulis satu dinding teks yang panjang.

Untuk membantu orang menavigasi artikel, Anda juga dapat menambahkan daftar isi yang memungkinkan pembaca dengan cepat melompat ke bagian tertentu.

Beberapa perangkat lunak dokumentasi produk dapat membantu Anda menambahkan daftar isi secara otomatis. Misalnya, plugin Heroic Knowledge Base hadir dengan fitur bawaan untuk secara otomatis membuat daftar isi berdasarkan judul setiap artikel.

8. Selalu Tingkatkan dan Perbarui Dokumentasi Anda

Terakhir, penting untuk diingat bahwa membuat dokumentasi produk bukanlah peristiwa satu kali; itu adalah proses yang berkelanjutan.

Pada tingkat dasar, produk Anda mungkin akan mengalami perubahan, jadi penting untuk memperbarui dokumentasi Anda untuk memperhitungkan perubahan tersebut dan fitur baru yang telah Anda tambahkan.

Namun di luar itu, jika Anda memilih perangkat lunak dokumentasi produk seperti Heroic Knowledge Base, Anda akan mendapatkan akses ke analitik untuk membantu Anda memahami bagaimana orang menggunakan dokumentasi Anda. Anda dapat menggunakan analitik ini untuk:

1. Lacak apa yang dicari orang, yang bisa menjadi tanda bahwa Anda perlu membuat dokumentasi seputar topik tersebut jika Anda belum melakukannya.
2. Lihat artikel mana yang tidak membantu pengguna sebanyak yang Anda inginkan, yang mungkin merupakan tanda bahwa Anda perlu melakukan perbaikan pada artikel tersebut untuk meningkatkan kegunaannya.

Mulai Buat Dokumentasi Produk yang Luar Biasa Sekarang!

Membuat dokumentasi produk berkualitas tinggi adalah investasi dalam kesuksesan jangka panjang bisnis Anda. Ini membantu Anda…

• Membuat pelanggan Anda lebih sukses.
• Kurangi beban tim pendukung Anda.
• Menarik dan mengkonversi lebih banyak pelanggan di tempat pertama.
• Tingkatkan pengetahuan karyawan Anda tentang produk Anda.

Dalam posting ini, kami membagikan beberapa contoh bagus dokumentasi produk dari perusahaan yang sukses bersama dengan beberapa tip tentang cara menulis dan menyusun dokumentasi Anda.

Jika Anda siap untuk membuat hub dokumentasi produk Anda sendiri, Anda dapat menggunakan plugin Heroic Knowledge Base untuk membangun solusi Anda sendiri yang dihosting sendiri yang diberdayakan oleh WordPress. Klik untuk mempelajari lebih lanjut tentang Basis Pengetahuan Heroik.