En İyi 6 Belgeleme Aracı: 2022 İçin Seçilmiş Bir Liste

Birinci sınıf dahili veya harici dokümantasyon içeriği oluşturmanıza yardımcı olacak en iyi dokümantasyon araçlarını mı arıyorsunuz?

İster teknik olmayan tüketiciler için genel belgeler, ister yazılımınızın API belgeleri (veya bunların arasındaki herhangi bir şey) gibi teknik içerik oluşturuyor olun, içeriğinizi yönetmenize ve kullanıcılar için yayınlamanıza yardımcı olacak bazı harika belge araçları vardır.

Bu gönderide, tüm bütçeler için açık kaynak ve SaaS çözümleri (ücretsiz olanlar dahil) dahil olmak üzere en iyi altı seçeneğin bir listesini hazırladık.

Altı aracın tümü için yararlarını, olumsuz yanlarını, fiyatlandırmasını ve bu aracı kullanarak belgelerinize nasıl başlayabileceğinizi vurgulayacağız.

Hemen atlayalım!

Altı En İyi Belgeleme Aracı

1. Kahramanca Bilgi Tabanı
2. GitKitap
3. Belge360
4. Dokümanları okuyun
5. Kavram + Motor.so
6. Yardım suyu

1. Kahramanca Bilgi Tabanı

Heroic Knowledge Base, aynı zamanda açık kaynaklı olan popüler WordPress yazılımına dayanan açık kaynaklı bir dokümantasyon aracıdır.

WordPress sitenizi hemen bir dokümantasyon merkezine dönüştürmek için Heroic Knowledge Base'i WordPress'e bir eklenti olarak yükleyebilirsiniz.

Sitenizi nasıl oluşturacağınız size kalmış - yalnızca belgeler için olan yepyeni bir WordPress sitesi oluşturabilir veya bu siteye belge işlevselliği eklemek için mevcut bir WordPress sitesine Heroic Knowledge Base yükleyebilirsiniz.

İçerik oluşturmak için, sürüm kontrolü için WordPress'in yerleşik revizyon sistemiyle birlikte esnek WordPress blok düzenleyicisini kullanabilirsiniz.

Heroic Knowledge Base ayrıca, belirtme çizgilerini, uyarıları ve diğer önemli noktaları kolayca ekleyebilmeniz için kendi özel bloklarını da ekler.

Ayrıca, genel veya dahili belgeler oluşturmanıza bağlı olarak, belgelerinizin bir kısmını veya tamamını özel yapmak için araçlar da alırsınız.

Heroic Knowledge Base ayrıca ziyaretçileriniz için harika bir deneyim yaratmanız ve belgelerinizi optimize etmeniz için tonlarca özellik sunar:

• Canlı önerilerle gerçek zamanlı AJAX araması.
• Makaleleri düzenlemek için kategoriler ve etiketler.
• Aramaları, görünümleri, makale etkinliğini ve canlı destek kanallarına aktarımları izlemek için yerleşik analitik.

WordPress tabanlı olduğundan, diğer eklentileri kullanarak da belgelerinizi genişletebilirsiniz. Örneğin, içerik düzenleyiciye Google Dokümanlar tarzı yorum ve ortak çalışma eklemek için ücretsiz Multicollab eklentisini kullanabilirsiniz.

Faydalar

• Sınırsız kullanıcı, makale, kategori vb . Temel olarak, SaaS belgelendirme araçlarında tipik olarak karşılaştığınız gibi rastgele sınırlar yoktur.
• Esnek . Heroic Knowledge Base, belgelerinizi yapılandırmanıza yardımcı olacak tonlarca yerleşik özellik içerir ve gerektiğinde işbirliği özellikleri eklemek gibi diğer WordPress eklentilerini de yükleyebilirsiniz.
• Tam veri sahipliği . Tüm verileriniz her zaman %100 kendi sunucularınızda kalır.
• Açık kaynak . Hem WordPress hem de Heroic Knowledge Base açık kaynaklıdır.

Dezavantajlar

• Herhangi bir nedenle WordPress kullanmak istemiyorsanız, Heroic Knowledge Base'in yalnızca WordPress ile çalıştığını unutmamak önemlidir.

fiyatlandırma

Heroic Knowledge Base, tek bir web sitesinde kullanım ve bir yıllık destek ve güncellemeler için 149 dolardan başlar. Yazılıma erişiminizi hiçbir ekstra ücret ödemeden sonsuza kadar sürdüreceksiniz, ancak ilk yıldan sonra destek ve güncellemeleri almaya devam etmek için lisansınızı yenilemeniz gerekecek.

Ayrıca, WordPress çalıştırabilen web sitesi barındırma hizmetine erişiminiz yoksa, biraz maliyetli olabilecek bir WordPress web sitesine de ihtiyacınız olacak.

Nasıl Başlanır?

Heroic Knowledge Base'i kullanarak bir dokümantasyon merkezini nasıl kuracağınız aşağıda açıklanmıştır:

1. Merkezinizin temeli olarak işlev görecek bir WordPress sitesi oluşturun (henüz yapmadıysanız).
2. Heroic Knowledge Base eklentisini satın alın ve yükleyin.
3. Ayarları kullanarak dokümantasyon merkezi davranışınızı yapılandırın ( Heroic KB → Ayarlar )
4. Esnek blok düzenleyiciyi kullanarak makaleler ekleyin.

Ayrıca bir intranet sitesi oluşturma, oturum açmış kullanıcıların erişimini kısıtlama veya belgeleri görüntülemek için parola isteme (dahili belgeler için yararlı olabilir) gibi başka ince ayarlar da ekleyebilirsiniz.

2. GitKitap

Adından da anlaşılacağı gibi GitBook, daha çok genel veya özel belgeler oluşturmaya ihtiyaç duyan yazılım ekiplerine yönelik bir belgeleme aracıdır.

Örneğin, belgelerinizi bu şekilde oluşturmak için GitBook'u işaretleme dosyaları içeren bir GitHub veya GitLab deposuyla senkronize edebilirsiniz. Ancak, Git'i yalnızca GitBook'u kullanmak için kullanmak zorunda değilsiniz ve ayrıca sezgisel bir düzenleyici kullanarak içerik oluşturabilir veya işaretleme dosyaları, Word belgeleri ve daha fazlası gibi diğer kaynaklardan içe aktarabilirsiniz.

Belgelerinizi düzenlemek için "alanlar" (yani benzersiz bir bilgi tabanı) ve "koleksiyonlar" (yani bir bilgi tabanındaki bir kategori) kullanabilirsiniz.

Diğer bazı dikkate değer özellikler aşağıdakileri içerir:

• Sürüm kontrolü.
• Canlı ekip düzenleme ve işbirliği.
• İçerik düzenleyicide zengin yerleştirmeler.
• Kolay PDF dışa aktarma.

Faydalar

• Bilinen teknik iş akışlarını kullanın . Teknik ekipler için GitBook, zaten aşina olduğunuz araçları (Git gibi) kullanmanızı sağlar. Ayrıca düzenlemeler için "dallar" ve "değişiklik talepleri" gibi teknik terimler kullanır.
• İşbirliği özellikleri . Aynı belge üzerinde birden fazla kişi çalışıyorsa (belki de aynı anda) bu yardımcı olabilir.
• Kar amacı gütmeyen kuruluşlar için ücretsiz. Kâr amacı gütmeyen bir kuruluşsanız veya açık kaynaklı bir proje yürütüyorsanız GitBook'u ücretsiz olarak kullanabilirsiniz.

Dezavantajlar

• Teknik Yazılım belgeleri oluşturmuyorsanız GitBook biraz karmaşık gelebilir. Teknik olmayan belgeler oluşturmak isteyen kişiler muhtemelen başka yerlere bakmak isteyeceklerdir.

fiyatlandırma

GitBook, bireysel kullanım, kar amacı gütmeyen kuruluşlar ve açık kaynaklı projeler için ücretsizdir. Ticari planlar, en az 5 kullanıcıyla, kullanıcı başına aylık 8 ABD dolarından başlar. Yani en ucuz plan ayda 40 dolar olacaktır.

Kahramanca Bilgi Bankasına Nasıl Başlanır?

Başlamak için bir GitBook hesabına kaydolmanız ve oluşturmaya başlamanız yeterlidir. GitHub'daki bir havuzla senkronize edebilir veya GitBook'un içerik düzenleyicilerini kullanarak sıfırdan oluşturabilirsiniz.

3. Belge360

Document360, kendi dahili veya ileriye dönük bilgi tabanınızı oluşturmanıza olanak tanıyan bir SaaS belgeleme aracıdır.

SaaS yaklaşımı nedeniyle, başlamak çok kolaydır. Sadece bir hesaba kaydolun ve kullanıcı dostu arayüz aracılığıyla belgelerinizi oluşturmaya başlayın.

Markdown destekli basit bir WYSIWYG düzenleyici kullanarak içerik oluşturabilirsiniz. Ayrıca, bir ekiple çalışıyorsanız yararlı olan işbirliği araçlarına ve sürüm denetimine de erişebilirsiniz.

Ön uçta, kullanıcılarınız, canlı arama önerileri, otomatik içindekiler tablosu ve daha fazlası gibi faydalı dokunuşlar dahil, içeriğe göz atmak için iyi tasarlanmış bir arayüze sahip olacak.

Faydalar

• Kolay kurulum . Belge oluşturmak için bir hesaba kaydolmanız ve yazmaya başlamanız yeterlidir.
• Sizin için barındırıldı . Document360, belgelerinizi sizin için barındırma ve bakımını üstlenir, böylece hiçbir zaman güncellemelerle veya herhangi bir şeyle uğraşmanıza gerek kalmaz.
• Verimlilik özellikleri . Otomatik inceleme hatırlatıcıları, bilgi tabanı etkinlikleri için bildirimler ve daha fazlası gibi bazı güzel özelliklere erişebilirsiniz.

Dezavantajlar

• Masraflı. En ucuz ücretli plan zaten ayda 119 dolar ve bu sadece sınırlı özellikler içeriyor.
• Sınırlamalar Daha fazla ekip hesabına veya bilgi tabanına ihtiyacınız varsa, fazladan ödeme yapmanız gerekir. Örneğin, Başlangıç ​​planı yalnızca beş ekip hesabı içerir. Bundan fazlasını istiyorsanız, hesap başına aylık 19 ABD doları ödersiniz.

fiyatlandırma

Document360 bir SaaS aracıdır, bu nedenle kullanmak istediğiniz sürece aylık veya yıllık ücret ödersiniz. Planlar, proje başına aylık 119 ABD Doları, ek bilgi tabanı sürümü başına 39 ABD Doları ve dahil edilen beş hesabın ötesinde her bir ekip hesabı için 19 ABD Doları'ndan başlar.

Ayrıca 1 GB depolama alanı ve sınırlı özellik erişimi ile 50 adede kadar makale oluşturmanıza izin veren ücretsiz bir plan da vardır.

Document360'a Nasıl Başlanır?

Document360 bir SaaS dokümantasyon aracıdır, yani başlamak için tek yapmanız gereken bir hesaba kaydolmak.

Tüm özellikleri ücretsiz olarak keşfedebilmeniz için 14 günlük ücretsiz deneme süresi vardır.

4. Belgeleri Okuyun

Read the Docs, yazılım veya teknik belgeler için özel olarak oluşturulmuş bir belgeleme aracıdır.

Git'i kullanarak içeriğinizi ve sürüm oluşturmanızı yönetmenize ve ardından kullanıcı dostu bir ön uç arayüzüne kolayca dağıtmanıza olanak tanır. Bu yaklaşım, yalnızca geliştiriciler tarafından gerçekten erişilebilir olduğu anlamına gelir… ancak teknik belgeler oluşturmaya odaklandığı için bu mantıklıdır.

Kullanmakta olduğunuz sürüme bağlı olarak, aşağıdaki özelliklerin bazılarına veya tümüne de erişebilirsiniz:

• Ziyaretçilerin ne aradığını ve ne okuduğunu görmek için analizler.
• Canlı arama sonuçları ve öneriler.
• Birden çok eşzamanlı yapı. Örneğin, biri üretim için, diğeri beta için veya biri sürüm 1.0 için ve diğeri sürüm 2.0 için.
• PDF, HTML veya epub'a kolay dışa aktarma.
• Google Workspace veya VCS sağlayıcısı (GitHub, GitLab veya Bitbucket) aracılığıyla tek oturum açma.

Faydalar

• Geliştirme araçlarını kullanın . Belgeleri yönetmek için Git gibi araçları kullanarak, Belgeleri Oku, kendisini yazılım geliştiricilerin mevcut iş akışlarına yerleştirmeye çalışır.
• Güçlü sürüm oluşturma . Git, sürüm oluşturmayı yönetmeyi kolaylaştırır ve aynı anda dokümanlarınızın birden çok sürümünü yayınlayabilirsiniz; bu, insanlar yazılımınızın farklı sürümlerini kullanıyorsa harikadır.

Dezavantajlar

• Daha karmaşık kurulum . Read the Docs, Git üzerinden çalışmanız gerektiğinden, kurulumu diğer dokümantasyon araçlarına göre biraz daha karmaşıktır. Ancak, teknik dokümantasyona odaklanıldığı için, Read the Docs kullanan kişilerin herhangi bir sorun yaşamaması gerekir.
• Sadece teknik dokümantasyon için . Yazılım/teknik belgeler oluşturmuyorsanız, Belgeleri Oku size göre olmadığından farklı bir belgeleme aracı seçmek isteyeceksiniz.

fiyatlandırma

Açık kaynaklı bir projeniz varsa, Belgeleri Oku, belgelerinizi ücretsiz olarak oluşturmanıza ve barındırmanıza olanak tanır. Aslında, Belgeleri Oku, 240.000'den fazla açık kaynaklı proje için ücretsiz belgeler barındırdığını söylüyor.

Ticari işletmeler için, aylık 50 ABD Dolarından başlayan ücretli İş İçin Belgeleri Oku hizmeti de vardır. Tüm planlar sınırsız proje ve kullanıcı içerir - ana sınırlamalar, elde ettiğiniz özellikler ve sahip olabileceğiniz eşzamanlı derlemelerin sayısıdır.

Belgeleri Okumaya Nasıl Başlanır?

Belgeleri Oku, gerçek belgelerinizi yazmanız için size iki yol sunar:

1. MkDocs
2. Sfenks

Belge içeriğinizle birlikte bir Git deposu oluşturmak için bu araçları kullandığınızda, Belgeleri Oku, belgelerinizi oluşturmak için depoyu otomatik olarak içe aktarır.

5. Kavram + Motor.so

Notion, özellikle dokümantasyon için oluşturulmadığından burada biraz eğri büğrü. Ancak, doğru kurulumla, tüm farklı belge türlerini işlemek için harika bir araç olabilir.

Notion'a aşina değilseniz, temel olarak her türlü bilgi, veri, proje yönetimi ve çok daha fazlasını işlemek için hepsi bir arada bir araçtır.

Her tür belgeyi oluşturmak da dahil olmak üzere tonlarca farklı şey için kullanabilirsiniz. Dezavantajı ise, Notion'ın kendi başına , bu bilgileri diğer insanların onunla etkileşime girebileceği bir web sitesinde yayınlamaya gerçekten odaklanmamasıdır.

Engine.so burada devreye giriyor. Engine.so ( bir üçüncü taraf hizmeti ) ile, kendi belge merkezinizi kolayca oluşturmak için Notion içeriğinizi kendi web sitenizde yayınlayabilirsiniz. Bunun neye benzediğinin bir örneğini Engine.so belgelerinde görebilirsiniz.

Faydalar

• Bilgi sunmanın benzersiz yolları . Notion'u kullanmak size, daha dar hedefli dokümantasyon araçlarıyla elde edemeyeceğiniz bir çok esneklik sağlar. Örneğin, birçok Notion bloğunu ilginç şekillerde kullanabilirsiniz.
• Kullanımı kolay . Git tabanlı araçların aksine, bu yaklaşım hem teknik hem de teknik olmayan kullanıcılar için kolaydır.
• uygun fiyatlı . Ücretsiz bir plan olmasa da, bu yaklaşım çoğu kullanım durumu için uygun maliyetli olmalıdır.

Dezavantajlar

• Belgeler için özel olarak oluşturulmamıştır . Notion dokümantasyon için harika çalışsa da, bu listedeki diğer dokümantasyon araçlarında olduğu gibi tek odak noktası bu değildir. Yüzlerce makaleye sahip olmayı planlıyorsanız, daha çok amaca yönelik bir araç tercih edebilirsiniz.
• Sınırlı sürüm kontrolü. Bu yaklaşım, güçlü sürüm kontrolü sunmaz. Notion için ödeme yaparsanız, 30 günlük sürüm geçmişi elde edebilirsiniz, ancak Git veya Heroic Knowledge Base ile aldığınız WordPress sistemi kadar güçlü değildir.

fiyatlandırma

Notion, temel kullanım durumları için iyi çalışması gereken ücretsiz bir plana sahiptir. Ancak, özel ihtiyaçlarınıza bağlı olarak ödemek isteyebileceğiniz bir şans var.

Ancak Notion içeriğinizi herkese açık bir dokümantasyon merkezine dönüştürmek için Engine.so için ödeme yapmanız gerekir. Engine.so, 300 sayfaya kadar aylık 19 ABD Doları veya 1.000 sayfaya kadar aylık 49 ABD Doları tutarındadır. 14 günlük ücretsiz deneme ile test edebilirsiniz.

Notion'a Nasıl Başlanır?

Bu kurulumu kullanarak belgeleri nasıl oluşturacağınız aşağıda açıklanmıştır:

1. Bir Notion hesabı için kaydolun.
2. Notion kullanarak belgelerinizi oluşturun. Beestat'taki bu şablonlar gibi, dokümantasyon içeriği için önceden hazırlanmış Notion şablonları bulabilirsiniz.
3. Bir Engine.so hesabı için kaydolun.
4. Engine.so'yu kullanarak Notion belgelerinizi kendi özel web sitenizde/dokümantasyon merkezinizde yayınlayın.

6. Yardım suyu

Document360'a benzer şekilde Helpjuice, başka bir popüler SaaS bilgi tabanı ve dokümantasyon aracıdır.

Zaman kazanmak için Word belgelerinden içe aktarma seçenekleri de dahil olmak üzere basit bir metin düzenleyici kullanarak her tür belgeyi kolayca oluşturmanıza yardımcı olur.

Etkili belgeler oluşturmak için bir dizi özelliğe de erişebilirsiniz:

• Anında arama sonuçları/öneriler.
• Aramaları, sayfa görüntülemelerini ve çok daha fazlasını izlemek için Analytics.
• Belgelerinizin birden çok sürümünü yayınlama seçeneği.
• Farklı makaleleri kimlerin görebileceğini kontrol etmek için kullanıcı erişim seviyeleri.
• Editör içi yorumlar dahil işbirliği özellikleri.

Faydalar

• Kolay kurulum . Dokümantasyon oluşturmak için bir hesaba kaydolmanız yeterlidir.
• Sizin için barındırıldı . Helpjuice, belgelerinizi sizin için barındırır ve bakımını yapar, böylece asla güncellemelerle veya herhangi bir şeyle uğraşmanıza gerek kalmaz.
• Özellik kilitli plan yok . Helpjuice'in ücretsiz bir planı olmasa da, tüm ücretli planları size tüm özelliklere erişim sağlar.

Dezavantajlar

• pahalı . En ucuz plan ayda 120 dolardan başlar ve ayda 500 dolara kadar çıkabilir.
• Kullanıcı limitleri . Büyük bir ekibiniz varsa, Helpjuice pahalı olabilir. Örneğin, 60'tan fazla kullanıcınız varsa, aylık 500 ABD doları planına ihtiyacınız vardır.

fiyatlandırma

Helpjuice'in ücretli planları, tüm özellikler ve dört kullanıcıya kadar aylık 120 dolardan başlıyor. İhtiyacınız olan kullanıcı sayısına bağlı olarak planlar oradan yukarı çıkıyor ve sınırsız kullanıcılar için ayda 500 dolardan başlıyor.

Benzersiz olan şey, tüm planlardaki tüm özelliklere erişebilmenizdir, ancak Document360 gibi bir şey belirli özellikleri daha yüksek seviyeli planların arkasına kilitler.

Ayrıca 14 günlük ücretsiz deneme ile her şeyi test edebilirsiniz.

Helpjuice'a Nasıl Başlanır?

Başlamak için tek yapmanız gereken bir Helpjuice hesabına kaydolmak ve içeriğinizi eklemeye başlamak.

İhtiyaçlarınız İçin En İyi Belgeleme Aracı Hangisi?

Sonuç olarak, en iyi dokümantasyon aracını seçmek gerçekten özel ihtiyaçlarınıza, bütçenize ve bilgi seviyenize bağlıdır.

Aramanızı daraltmak için kendinize sormak isteyeceğiniz bazı yaygın sorular şunlardır:

• Kendi kendine barındırılan bir çözüm mü istiyorsunuz yoksa bir SaaS aracı kullanmakta sorun var mı?
• Benzer şekilde, açık kaynaklı bir çözüm mü istiyorsunuz yoksa kapalı kaynaklı bir araç kullanmakta sorun var mı?
• Çok teknik belgeler (örneğin API belgeleri) mi yoksa daha fazla tüketiciye yönelik belgeler mi oluşturuyorsunuz?
• Git'i sürüm kontrolü/içerik yönetimi için kullanma fikrini beğendiniz mi yoksa özel bir bilgi yönetim sistemi mi tercih edersiniz?
• Bütçeniz nedir? Devam eden bir aylık ücret ödemeniz uygun mu, yoksa ücretsiz mi yoksa bir kerelik ödeme mi istiyorsunuz?

Bu soruları yanıtlayarak, ihtiyaçlarınız için en iyi belgeleme aracının hangisi olduğu konusunda iyi bir fikre sahip olmalısınız.

Nereden başlayacağınızdan emin değilseniz, Heroic Knowledge Base'in çoğu işletmenin ihtiyaçlarını karşılayabileceğini düşünüyoruz. Diğer araçların çoğundan daha düşük bir fiyata verilerinizin tam sahipliğini sağlayan uygun maliyetli, açık kaynaklı bir yaklaşım sunar.

Ancak aynı zamanda, canlı arama önerileri ve ayrıntılı analizler gibi birinci sınıf belgeler oluşturmak için tonlarca özelliğe erişebilirsiniz. Daha fazla esneklik istiyorsanız, tüm WordPress ekosistemine de erişebilirsiniz.

Daha fazla bilgi edinmek ve başlamak için Heroic Knowledge Base ürün sayfasına gidin.