6 Alat Dokumentasi Terbaik: Daftar Terkurasi untuk 2022

Mencari alat dokumentasi terbaik untuk membantu Anda membuat konten dokumentasi internal atau eksternal terbaik?

Baik Anda membuat dokumentasi publik untuk konsumen non-teknis atau konten teknis seperti dokumentasi API perangkat lunak Anda (atau apa pun di antaranya), ada beberapa alat dokumentasi hebat untuk membantu Anda mengelola konten dan mempublikasikannya untuk pengguna.

Dalam posting ini, kami telah menyusun daftar enam opsi teratas, termasuk solusi open-source dan SaaS untuk semua anggaran (termasuk gratis).

Untuk keenam alat tersebut, kami akan menyoroti manfaat, kerugian, harga, dan bagaimana Anda dapat memulai dokumentasi menggunakan alat tersebut.

Ayo langsung masuk!

Enam Alat Dokumentasi Terbaik

1. Basis Pengetahuan Heroik
2. GitBook
3. Dokumen360
4. Baca Dokumen
5. Notion + Engine.so
6. jus bantuan

1. Basis Pengetahuan Heroik

Heroic Knowledge Base adalah alat dokumentasi sumber terbuka yang didasarkan pada perangkat lunak WordPress populer, yang juga sumber terbuka.

Anda dapat menginstal Heroic Knowledge Base sebagai plugin di WordPress untuk segera mengubah situs WordPress Anda menjadi pusat dokumentasi.

Bagaimana Anda membuat situs terserah Anda – Anda dapat membuat situs WordPress baru yang khusus untuk dokumentasi atau Anda dapat menginstal Heroic Knowledge Base di situs WordPress yang ada untuk menambahkan fungsionalitas dokumentasi ke situs tersebut.

Untuk membuat konten, Anda dapat menggunakan editor blok WordPress yang fleksibel, bersama dengan sistem revisi bawaan WordPress untuk kontrol versi.

Basis Pengetahuan Heroik juga menambahkan blok khusus sendiri sehingga Anda dapat dengan mudah menambahkan info, peringatan, dan sorotan lainnya.

Anda juga mendapatkan alat untuk menjadikan sebagian atau semua dokumentasi Anda pribadi, tergantung pada apakah Anda membuat dokumentasi publik atau internal.

Basis Pengetahuan Heroik juga memberi Anda banyak fitur untuk menciptakan pengalaman hebat bagi pengunjung Anda dan mengoptimalkan dokumentasi Anda:

• Pencarian AJAX waktu nyata dengan saran langsung.
• Kategori dan tag untuk mengatur artikel.
• Analitik bawaan untuk melacak penelusuran, penayangan, efektivitas artikel, dan transfer ke saluran dukungan langsung.

Karena didasarkan pada WordPress, Anda juga dapat memperluas dokumentasi Anda menggunakan plugin lain. Misalnya, Anda dapat menggunakan plugin Multicollab gratis untuk menambahkan komentar dan kolaborasi bergaya Google Documents ke editor konten.

Manfaat

• Pengguna, artikel, kategori, dan sebagainya tidak terbatas . Pada dasarnya, tidak ada batasan sewenang-wenang seperti yang biasanya Anda temui pada alat dokumentasi SaaS.
• Fleksibel . Basis Pengetahuan Heroic menyertakan banyak fitur bawaan untuk membantu Anda mengonfigurasi dokumentasi Anda dan Anda juga dapat menginstal plugin WordPress lainnya sesuai kebutuhan, seperti menambahkan fitur kolaborasi.
• Kepemilikan data penuh . Semua data Anda tetap 100% di server Anda sendiri setiap saat.
• Sumber terbuka . Baik WordPress dan Basis Pengetahuan Heroic adalah open-source.

Kekurangan

• Jika Anda tidak ingin menggunakan WordPress karena alasan tertentu, penting untuk dicatat bahwa Heroic Knowledge Base hanya berfungsi dengan WordPress.

Harga

Basis Pengetahuan Heroik mulai dari $ 149 untuk digunakan di satu situs web dan satu tahun dukungan dan pembaruan. Anda akan mempertahankan akses ke perangkat lunak selamanya tanpa biaya tambahan, tetapi Anda harus memperbarui lisensi Anda untuk terus menerima dukungan dan pembaruan setelah tahun pertama.

Anda juga memerlukan situs web WordPress, yang mungkin memerlukan biaya jika Anda belum memiliki akses ke hosting situs web yang mampu menjalankan WordPress.

Bagaimana Memulainya?

Berikut cara menyiapkan hub dokumentasi menggunakan Basis Pengetahuan Heroik:

1. Buat situs WordPress untuk bertindak sebagai basis hub Anda (jika Anda belum melakukannya).
2. Beli dan instal plugin Heroic Knowledge Base.
3. Konfigurasikan perilaku hub dokumentasi Anda menggunakan pengaturan ( Heroic KB → Settings )
4. Tambahkan artikel menggunakan editor blok fleksibel.

Anda juga dapat menambahkan tweak lainnya, seperti membuat situs intranet, membatasi akses ke pengguna yang masuk, atau memerlukan kata sandi untuk melihat dokumentasi (yang dapat membantu untuk dokumentasi internal).

2. GitBook

Seperti namanya, GitBook adalah alat dokumentasi yang lebih ditujukan untuk tim perangkat lunak yang perlu membuat dokumentasi publik atau pribadi.

Misalnya, Anda dapat menyinkronkan GitBook dengan repositori GitHub atau GitLab yang berisi file penurunan harga untuk membuat dokumentasi Anda seperti itu. Namun, Anda tidak dipaksa untuk menggunakan Git hanya untuk menggunakan GitBook dan Anda juga dapat membuat konten menggunakan editor intuitif atau mengimpornya dari sumber lain seperti file penurunan harga, dokumen Word, dan banyak lagi.

Untuk mengatur dokumentasi Anda, Anda dapat menggunakan "spasi" (yaitu satu basis pengetahuan yang unik) dan "koleksi" (yaitu satu kategori dalam basis pengetahuan).

Beberapa fitur penting lainnya termasuk yang berikut:

• Kontrol versi.
• Pengeditan dan kolaborasi tim langsung.
• Sematan kaya di editor konten.
• Ekspor PDF mudah.

Manfaat

• Gunakan alur kerja teknis yang sudah dikenal . Untuk tim teknis, GitBook memungkinkan Anda menggunakan alat yang sudah Anda kenal (seperti Git). Itu juga menggunakan istilah teknis, seperti "cabang" dan "permintaan perubahan" untuk pengeditan.
• Fitur kolaborasi . Ini dapat membantu jika Anda memiliki banyak orang yang mengerjakan dokumen yang sama (bahkan mungkin pada waktu yang sama).
• Gratis untuk nirlaba. Jika Anda seorang nirlaba atau menjalankan proyek sumber terbuka, Anda dapat menggunakan GitBook secara gratis.

Kekurangan

• Teknis . Jika Anda tidak membuat dokumentasi perangkat lunak, GitBook mungkin terasa sedikit rumit. Orang yang ingin membuat dokumentasi non-teknis mungkin ingin mencari di tempat lain.

Harga

GitBook gratis untuk penggunaan individu, nirlaba, dan proyek sumber terbuka. Paket komersial mulai dari $8 per pengguna per bulan, dengan minimal 5 pengguna. Jadi paket termurah adalah $40 per bulan.

Bagaimana Memulai Dengan Basis Pengetahuan Heroik

Untuk memulai, Anda hanya perlu mendaftar akun GitBook dan mulai membangun. Anda dapat menyinkronkan dengan repositori di GitHub atau membangun dari awal menggunakan editor konten GitBook.

3. Dokumen360

Document360 adalah alat dokumentasi SaaS yang memungkinkan Anda membuat basis pengetahuan internal atau ke depan Anda sendiri.

Karena pendekatan SaaS-nya, sangat mudah untuk memulai. Anda cukup mendaftar untuk sebuah akun dan mulai membuat dokumentasi Anda melalui antarmuka yang mudah digunakan.

Anda dapat membuat konten menggunakan editor WYSIWYG sederhana dengan dukungan penurunan harga. Anda juga akan mendapatkan akses ke alat kolaborasi dan kontrol versi, yang berguna jika Anda bekerja dengan tim.

Di bagian depan, pengguna Anda akan mendapatkan antarmuka yang dirancang dengan baik untuk menelusuri konten, termasuk sentuhan bermanfaat seperti saran penelusuran langsung, daftar isi otomatis, dan banyak lagi.

Manfaat

• Pengaturan yang mudah . Untuk membuat dokumentasi, Anda hanya perlu mendaftar akun dan mulai menulis.
• Dihosting untuk Anda . Document360 menangani hosting dan memelihara dokumentasi Anda untuk Anda, jadi Anda tidak perlu repot dengan pembaruan atau apa pun.
• Fitur produktivitas . Anda mendapatkan akses ke beberapa fitur bagus seperti pengingat ulasan otomatis, pemberitahuan untuk acara berbasis pengetahuan, dan banyak lagi.

Kekurangan

• Mahal. Paket berbayar termurah sudah $ 119 per bulan dan itu hanya mencakup fitur terbatas.
• Keterbatasan . Jika Anda membutuhkan lebih banyak akun tim atau basis pengetahuan, Anda harus membayar ekstra. Misalnya, paket Startup hanya mencakup lima akun tim. Jika Anda menginginkan lebih dari itu, Anda akan membayar $19 per bulan per akun.

Harga

Document360 adalah alat SaaS sehingga Anda akan membayar biaya bulanan atau tahunan selama Anda ingin menggunakannya. Paket mulai dari $119 per proyek per bulan, ditambah $39 per versi basis pengetahuan tambahan dan $19 untuk setiap akun tim di luar lima akun yang disertakan.

Ada juga paket gratis yang memungkinkan Anda membuat hingga 50 artikel dengan penyimpanan 1 GB dan akses fitur terbatas.

Bagaimana Memulai Dengan Document360

Document360 adalah alat dokumentasi SaaS, yang berarti Anda hanya perlu mendaftar akun untuk memulai.

Ada uji coba gratis selama 14 hari sehingga Anda dapat menjelajahi semua fitur secara gratis.

4. Baca Dokumen

Read the Docs adalah alat dokumentasi yang dibuat khusus untuk perangkat lunak atau dokumentasi teknis.

Ini memungkinkan Anda mengelola konten dan pembuatan versi menggunakan Git dan kemudian menyebarkannya dengan mudah ke antarmuka frontend yang ramah pengguna. Pendekatan ini berarti hanya benar-benar dapat diakses oleh pengembang…tetapi itu masuk akal mengingat pendekatan ini berfokus pada pembuatan dokumentasi teknis.

Bergantung pada versi yang Anda gunakan, Anda juga bisa mendapatkan akses ke beberapa atau semua fitur berikut:

• Analytics untuk melihat apa yang dicari dan dibaca pengunjung.
• Hasil pencarian langsung dan saran.
• Beberapa build bersamaan. Misalnya, satu build untuk produksi dan satu lagi untuk beta atau satu untuk versi 1.0 dan satu lagi untuk versi 2.0.
• Ekspor mudah ke PDF, HTML, atau epub.
• Sistem masuk tunggal melalui Google Workspace atau penyedia VCS (GitHub, GitLab, atau Bitbucket).

Manfaat

• Gunakan alat pengembangan . Dengan menggunakan alat seperti Git untuk mengelola dokumentasi, Read the Docs mencoba membangun dirinya sendiri ke dalam alur kerja pengembang perangkat lunak yang ada.
• Versi yang kuat . Git memudahkan pengelolaan pembuatan versi dan Anda juga dapat memublikasikan beberapa versi dokumen Anda secara bersamaan, yang sangat bagus jika orang menggunakan versi perangkat lunak Anda yang berbeda.

Kekurangan

• Pengaturan yang lebih kompleks . Read the Docs sedikit lebih rumit untuk disiapkan daripada alat dokumentasi lainnya karena Anda harus bekerja melalui Git. Namun, mengingat fokusnya pada dokumentasi teknis, tipe orang yang menggunakan Read the Docs seharusnya tidak mengalami masalah.
• Hanya untuk dokumentasi teknis . Jika Anda tidak membuat perangkat lunak/dokumentasi teknis, Anda dapat memilih alat dokumentasi yang berbeda karena Read the Docs bukan untuk Anda.

Harga

Jika Anda memiliki proyek sumber terbuka, Read the Docs memungkinkan Anda membuat dan menghosting dokumentasi Anda secara gratis. Faktanya, Read the Docs mengatakan bahwa ia menampung dokumentasi gratis untuk lebih dari 240.000 proyek sumber terbuka.

Untuk bisnis komersial, ada juga layanan Read the Docs for Business berbayar, yang dimulai dari $50 per bulan. Semua paket menyertakan proyek dan pengguna tanpa batas – batasan utamanya adalah fitur yang Anda dapatkan dan jumlah build bersamaan yang dapat Anda miliki.

Bagaimana Memulai Dengan Baca Dokumen

Read the Docs memberi Anda dua cara untuk menulis dokumentasi Anda yang sebenarnya:

1. MkDocs
2. sphinx

Setelah Anda menggunakan alat tersebut untuk membuat repositori Git dengan konten dokumentasi Anda, Read the Docs akan secara otomatis mengimpor repositori untuk membangun dokumentasi Anda.

5. Gagasan + Mesin.so

Gagasan sedikit melengkung di sini karena tidak dibuat secara khusus untuk dokumentasi. Namun, dengan pengaturan yang tepat, ini bisa menjadi alat yang hebat untuk menangani semua jenis dokumentasi yang berbeda.

Jika Anda tidak terbiasa dengan Notion, pada dasarnya ini adalah alat lengkap untuk menangani semua jenis pengetahuan, data, manajemen proyek, dan banyak lagi.

Anda dapat menggunakannya untuk banyak hal, termasuk membuat semua jenis dokumentasi. Kelemahannya, bagaimanapun, adalah bahwa Notion dengan sendirinya tidak benar-benar fokus pada penerbitan informasi itu ke situs web di mana orang lain dapat berinteraksi dengannya.

Di situlah Engine.so masuk. Dengan Engine.so ( layanan pihak ketiga ), Anda dapat mempublikasikan konten Notion Anda ke situs web Anda sendiri untuk dengan mudah membuat hub dokumentasi Anda sendiri. Anda dapat melihat contoh tampilannya di dokumentasi Engine.so.

Manfaat

• Cara unik dalam menyajikan informasi . Menggunakan Notion memberi Anda banyak fleksibilitas yang mungkin tidak Anda dapatkan dengan alat dokumentasi yang ditargetkan secara lebih sempit. Misalnya, Anda dapat menggunakan banyak blok Notion dengan cara yang menarik.
• Mudah digunakan . Berbeda dengan alat berbasis Git, pendekatan ini mudah bagi pengguna teknis dan non-teknis.
• Terjangkau . Meskipun tidak ada paket gratis, pendekatan ini harus terjangkau untuk sebagian besar kasus penggunaan.

Kekurangan

• Tidak dibuat khusus untuk dokumentasi . Meskipun Notion berfungsi dengan baik untuk dokumentasi, itu bukan satu-satunya fokusnya seperti halnya dengan alat dokumentasi lain dalam daftar ini. Jika Anda berencana untuk memiliki ratusan artikel, Anda mungkin lebih memilih alat yang dibuat khusus.
• Kontrol versi terbatas. Pendekatan ini tidak menawarkan kontrol versi yang kuat. Jika Anda membayar untuk Notion, Anda bisa mendapatkan riwayat versi selama 30 hari, tetapi tidak sekuat Git atau sistem WordPress yang Anda dapatkan dengan Heroic Knowledge Base.

Harga

Notion memiliki paket gratis yang seharusnya berfungsi dengan baik untuk kasus penggunaan dasar. Namun, ada kemungkinan Anda ingin membayar tergantung pada kebutuhan spesifik Anda.

Namun, untuk mengubah konten Notion Anda menjadi hub dokumentasi publik, Anda harus membayar untuk Engine.so. Engine.so berharga $19 per bulan untuk hingga 300 halaman atau $49 per bulan untuk hingga 1.000 halaman. Anda dapat mengujinya dengan uji coba gratis selama 14 hari.

Bagaimana Memulai Dengan Gagasan

Berikut cara membuat dokumentasi menggunakan pengaturan ini:

1. Mendaftar untuk akun Notion.
2. Buat dokumentasi Anda menggunakan Notion. Anda dapat menemukan templat Notion siap pakai untuk konten dokumentasi, seperti templat ini dari Beestat.
3. Daftar untuk akun Engine.so.
4. Publikasikan dokumentasi Notion Anda ke situs web/pusat dokumentasi kustom Anda sendiri menggunakan Engine.so.

6. jus bantuan

Mirip dengan Document360, Helpjuice adalah basis pengetahuan dan alat dokumentasi SaaS populer lainnya.

Ini membantu Anda dengan mudah membuat semua jenis dokumentasi menggunakan editor teks sederhana, termasuk opsi untuk mengimpor dari dokumen Word untuk menghemat waktu.

Anda juga mendapatkan akses ke banyak fitur untuk membuat dokumentasi yang efektif:

• Hasil/saran pencarian instan.
• Analytics untuk melacak pencarian, tampilan halaman, dan banyak lagi.
• Opsi untuk menerbitkan beberapa versi dokumentasi Anda.
• Tingkat akses pengguna untuk mengontrol siapa yang dapat melihat artikel yang berbeda.
• Fitur kolaborasi termasuk komentar dalam editor.

Manfaat

• Pengaturan yang mudah . Untuk membuat dokumentasi, Anda hanya perlu mendaftar untuk sebuah akun.
• Dihosting untuk Anda . Helpjuice menangani hosting dan memelihara dokumentasi Anda untuk Anda, jadi Anda tidak perlu dipusingkan dengan pembaruan atau apa pun.
• Tidak ada paket yang dikunci fitur . Meskipun Helpjuice tidak memiliki paket gratis, semua paket berbayarnya memberi Anda akses ke semua fitur.

Kekurangan

• Mahal . Paket termurah mulai dari $ 120 per bulan dan dapat berkisar hingga $ 500 per bulan.
• Batas pengguna . Jika Anda memiliki tim yang besar, Helpjuice bisa menjadi mahal. Misalnya, jika Anda memiliki lebih dari 60 pengguna, Anda memerlukan paket $500 per bulan.

Harga

Paket berbayar Helpjuice mulai dari $120 per bulan untuk semua fitur dan hingga empat pengguna. Paket naik dari sana berdasarkan jumlah pengguna yang Anda butuhkan, mencapai $500 per bulan untuk pengguna tak terbatas.

Yang unik adalah Anda mendapatkan akses ke semua fitur di semua paket, sedangkan sesuatu seperti Document360 mengunci fitur tertentu di balik paket tingkat tinggi.

Anda juga dapat menguji semuanya dengan uji coba gratis 14 hari.

Bagaimana Memulai Dengan Helpjuice

Untuk memulai, yang perlu Anda lakukan hanyalah mendaftar ke akun Helpjuice dan mulai menambahkan konten Anda.

Manakah Alat Dokumentasi Terbaik Untuk Kebutuhan Anda?

Pada akhirnya, memilih alat dokumentasi terbaik sangat bergantung pada kebutuhan spesifik, anggaran, dan tingkat pengetahuan Anda.

Berikut adalah beberapa pertanyaan umum yang ingin Anda tanyakan pada diri sendiri untuk mempersempit pencarian Anda:

• Apakah Anda menginginkan solusi yang dihosting sendiri atau Anda setuju menggunakan alat SaaS?
• Demikian pula, apakah Anda menginginkan solusi sumber terbuka atau apakah Anda setuju menggunakan alat sumber tertutup?
• Apakah Anda membuat dokumentasi yang sangat teknis (misalnya dokumentasi API) atau lebih banyak dokumentasi yang menghadap konsumen?
• Apakah Anda menyukai ide menggunakan Git untuk kontrol versi/manajemen konten atau Anda lebih suka memiliki sistem manajemen pengetahuan khusus?
• Apa anggaran Anda? Apakah Anda setuju dengan membayar biaya bulanan berkelanjutan atau Anda menginginkan sesuatu yang gratis atau pembayaran satu kali?

Dengan menjawab pertanyaan-pertanyaan itu, Anda harus memiliki ide yang bagus tentang alat dokumentasi terbaik untuk kebutuhan Anda.

Jika Anda tidak yakin harus mulai dari mana, menurut kami Basis Pengetahuan Heroik dapat memenuhi kebutuhan sebagian besar bisnis. Ini menawarkan pendekatan sumber terbuka yang hemat biaya yang memberi Anda kepemilikan penuh atas data Anda dengan harga yang lebih rendah daripada kebanyakan alat lainnya.

Tetapi pada saat yang sama, Anda masih mendapatkan akses ke banyak fitur untuk membuat dokumentasi terbaik, seperti saran pencarian langsung dan analitik terperinci. Anda juga mendapatkan akses ke seluruh ekosistem WordPress jika Anda menginginkan lebih banyak fleksibilitas.

Untuk mempelajari lebih lanjut dan memulai, kunjungi halaman produk Basis Pengetahuan Heroik.