Die 6 besten Dokumentationstools: Eine kuratierte Liste für 2022

Suchen Sie nach den besten Dokumentationstools, mit denen Sie erstklassige interne oder externe Dokumentationsinhalte erstellen können?

Unabhängig davon, ob Sie öffentliche Dokumentation für technisch nicht versierte Verbraucher oder technische Inhalte wie die API-Dokumentation Ihrer Software (oder irgendetwas dazwischen) erstellen, gibt es einige großartige Dokumentationstools, mit denen Sie Ihre Inhalte verwalten und für Benutzer veröffentlichen können.

In diesem Beitrag haben wir eine Liste der sechs Top-Optionen zusammengestellt, darunter Open-Source- und SaaS-Lösungen für alle Budgets (einschließlich kostenlos).

Für alle sechs Tools heben wir ihre Vorteile, Nachteile, Preise und die ersten Schritte mit Ihrer Dokumentation mit diesem Tool hervor.

Lass uns gleich einsteigen!

Die sechs besten Dokumentationstools

1. Heroische Wissensbasis
2. GitBook
3. Dokument360
4. Lesen Sie die Dokumente
5. Begriff + Engine.so
6. Hilfesaft

1. Heroische Wissensbasis

Heroic Knowledge Base ist ein Open-Source-Dokumentationstool, das auf der beliebten WordPress-Software basiert, die ebenfalls Open Source ist.

Sie können die Heroic Knowledge Base als Plugin auf WordPress installieren, um Ihre WordPress-Site sofort in einen Dokumentations-Hub zu verwandeln.

Wie Sie Ihre Website erstellen, liegt ganz bei Ihnen – Sie können eine brandneue WordPress-Website erstellen, die ausschließlich der Dokumentation dient, oder Sie können die Heroic Knowledge Base auf einer vorhandenen WordPress-Website installieren, um dieser Website Dokumentationsfunktionen hinzuzufügen.

Um Inhalte zu erstellen, können Sie den flexiblen WordPress-Blockeditor zusammen mit dem integrierten Revisionssystem von WordPress zur Versionskontrolle verwenden.

Die Heroic Knowledge Base fügt auch ihre eigenen dedizierten Blöcke hinzu, sodass Sie ganz einfach Callouts, Warnungen und andere Highlights hinzufügen können.

Sie erhalten auch Tools, mit denen Sie Ihre Dokumentation ganz oder teilweise privat machen können, je nachdem, ob Sie öffentliche oder interne Dokumentation erstellen.

Die Heroic Knowledge Base bietet Ihnen auch unzählige Funktionen, um Ihren Besuchern ein großartiges Erlebnis zu bieten und Ihre Dokumentation zu optimieren:

• AJAX-Suche in Echtzeit mit Live-Vorschlägen.
• Kategorien und Tags zum Organisieren von Artikeln.
• Integrierte Analysen zur Verfolgung von Suchanfragen, Ansichten, Artikeleffektivität und Übertragungen zu Live-Supportkanälen.

Da es auf WordPress basiert, können Sie Ihre Dokumentation auch mit anderen Plugins erweitern. Sie könnten beispielsweise das kostenlose Multicollab-Plug-in verwenden, um dem Inhaltseditor Kommentare und Zusammenarbeit im Stil von Google Docs hinzuzufügen.

Vorteile

• Unbegrenzte Benutzer, Artikel, Kategorien usw. Grundsätzlich gibt es keine willkürlichen Grenzen, wie Sie sie normalerweise bei SaaS-Dokumentationstools finden.
• Flexibel . Die Heroic Knowledge Base enthält unzählige integrierte Funktionen, mit denen Sie Ihre Dokumentation konfigurieren können, und Sie können bei Bedarf auch andere WordPress-Plugins installieren, z. B. das Hinzufügen von Funktionen für die Zusammenarbeit.
• Vollständiges Dateneigentum . Alle Ihre Daten bleiben jederzeit zu 100 % auf Ihren eigenen Servern.
• Open-Source . Sowohl WordPress als auch Heroic Knowledge Base sind Open Source.

Nachteile

• Wenn Sie WordPress aus irgendeinem Grund nicht verwenden möchten, ist es wichtig zu beachten, dass die Heroic Knowledge Base nur mit WordPress funktioniert.

Preisgestaltung

Die Heroic Knowledge Base beginnt bei 149 US-Dollar für die Verwendung auf einer einzelnen Website und ein Jahr Support und Updates. Sie haben unbegrenzten Zugriff auf die Software ohne zusätzliche Kosten, aber Sie müssen Ihre Lizenz erneuern, um nach dem ersten Jahr weiterhin Support und Updates zu erhalten.

Sie benötigen auch eine WordPress-Website, die etwas Geld kosten kann, wenn Sie nicht bereits Zugriff auf ein Website-Hosting haben, auf dem WordPress ausgeführt werden kann.

Wie man anfängt

So richten Sie mit Heroic Knowledge Base einen Dokumentations-Hub ein:

1. Erstellen Sie eine WordPress-Site als Basis Ihres Hubs (falls Sie dies noch nicht getan haben).
2. Kaufen und installieren Sie das Heroic Knowledge Base-Plugin.
3. Konfigurieren Sie Ihr Dokumentations-Hub-Verhalten mithilfe der Einstellungen ( Heroic KB → Einstellungen )
4. Fügen Sie Artikel mit dem flexiblen Blockeditor hinzu.

Sie können auch andere Optimierungen hinzufügen, z. B. das Erstellen einer Intranet-Site, das Beschränken des Zugriffs auf angemeldete Benutzer oder das Anfordern eines Kennworts zum Anzeigen der Dokumentation (was für die interne Dokumentation hilfreich sein kann).

2. GitBook

Wie der Name schon sagt, ist GitBook ein Dokumentationstool, das eher auf Softwareteams ausgerichtet ist, die öffentliche oder private Dokumentationen erstellen müssen.

Beispielsweise können Sie GitBook mit einem GitHub- oder GitLab-Repository synchronisieren, das Markdown-Dateien enthält, um Ihre Dokumentation auf diese Weise zu erstellen. Sie sind jedoch nicht gezwungen, Git zu verwenden, nur um GitBook zu verwenden, und Sie können Inhalte auch mit einem intuitiven Editor erstellen oder aus anderen Quellen wie Markdown-Dateien, Word-Dokumenten und mehr importieren.

Um Ihre Dokumentation zu organisieren, können Sie „Bereiche“ (dh eine einzige Wissensdatenbank) und „Sammlungen“ (dh eine Kategorie innerhalb einer Wissensdatenbank) verwenden.

Einige andere bemerkenswerte Merkmale umfassen die folgenden:

• Versionskontrolle.
• Live-Teambearbeitung und -zusammenarbeit.
• Reichhaltige Einbettungen im Inhaltseditor.
• Einfacher PDF-Export.

Vorteile

• Verwenden Sie vertraute technische Workflows . Für technische Teams können Sie mit GitBook Tools verwenden, mit denen Sie bereits vertraut sind (z. B. Git). Es verwendet auch Fachbegriffe wie „Zweige“ und „Änderungsanforderungen“ für Bearbeitungen.
• Funktionen für die Zusammenarbeit . Dies kann hilfreich sein, wenn mehrere Personen an demselben Dokument arbeiten (vielleicht sogar gleichzeitig).
• Kostenlos für gemeinnützige Organisationen. Wenn Sie eine gemeinnützige Organisation sind oder ein Open-Source-Projekt betreiben, können Sie GitBook kostenlos verwenden.

Nachteile

• Technisch . Wenn Sie keine Softwaredokumentation erstellen, fühlt sich GitBook möglicherweise etwas komplex an. Personen, die nicht-technische Dokumentationen erstellen möchten, werden sich wahrscheinlich woanders umsehen wollen.

Preisgestaltung

GitBook ist kostenlos für den individuellen Gebrauch, gemeinnützige Organisationen und Open-Source-Projekte. Kommerzielle Pläne beginnen bei 8 $ pro Benutzer und Monat mit mindestens 5 Benutzern. Der günstigste Plan wäre also 40 $ pro Monat.

Erste Schritte mit der heroischen Wissensdatenbank

Um loszulegen, müssen Sie sich nur für ein GitBook-Konto registrieren und mit dem Aufbau beginnen. Sie können entweder mit einem Repository auf GitHub synchronisieren oder mit den Inhaltseditoren von GitBook von Grund auf neu erstellen.

3. Dokument360

Document360 ist ein SaaS-Dokumentationstool, mit dem Sie Ihre eigene interne oder zukunftsgerichtete Wissensdatenbank erstellen können.

Aufgrund seines SaaS-Ansatzes ist der Einstieg sehr einfach. Sie registrieren sich einfach für ein Konto und beginnen mit der Erstellung Ihrer Dokumentation über die benutzerfreundliche Oberfläche.

Sie können Inhalte mit einem einfachen WYSIWYG-Editor mit Markdown-Unterstützung erstellen. Sie erhalten auch Zugriff auf Tools für die Zusammenarbeit und die Versionskontrolle, was hilfreich ist, wenn Sie mit einem Team arbeiten.

Auf dem Frontend erhalten Ihre Benutzer eine gut gestaltete Oberfläche zum Durchsuchen von Inhalten, einschließlich nützlicher Details wie Live-Suchvorschläge, automatische Inhaltsverzeichnisse und mehr.

Vorteile

• Einfache Einrichtung . Um eine Dokumentation zu erstellen, müssen Sie sich nur für ein Konto registrieren und mit dem Schreiben beginnen.
• Für Sie gehostet . Document360 übernimmt das Hosting und die Pflege Ihrer Dokumentation für Sie, sodass Sie sich nie mit Updates oder Ähnlichem herumschlagen müssen.
• Produktivitätsfunktionen . Sie erhalten Zugriff auf einige nette Funktionen wie automatische Überprüfungserinnerungen, Benachrichtigungen für Wissensdatenbankereignisse und mehr.

Nachteile

• Teuer. Der günstigste bezahlte Plan kostet bereits 119 US-Dollar pro Monat und enthält nur eingeschränkte Funktionen.
• Einschränkungen . Wenn Sie mehr Teamkonten oder Wissensdatenbanken benötigen, müssen Sie extra bezahlen. Beispielsweise umfasst der Startup -Plan nur fünf Teamkonten. Wenn Sie mehr wollen, zahlen Sie 19 $ pro Monat und Konto.

Preisgestaltung

Document360 ist ein SaaS-Tool, sodass Sie eine monatliche oder jährliche Gebühr zahlen, solange Sie es nutzen möchten. Die Pläne beginnen bei 119 USD pro Projekt und Monat, plus 39 USD pro zusätzlicher Wissensdatenbankversion und 19 USD für jedes Teamkonto über die fünf enthaltenen Konten hinaus.

Es gibt auch einen kostenlosen Plan, mit dem Sie bis zu 50 Artikel mit 1 GB Speicherplatz und eingeschränktem Funktionszugriff erstellen können.

Erste Schritte mit Document360

Document360 ist ein SaaS-Dokumentationstool, was bedeutet, dass Sie sich lediglich für ein Konto registrieren müssen, um loszulegen.

Es gibt eine 14-tägige kostenlose Testversion, damit Sie alle Funktionen kostenlos erkunden können.

4. Lesen Sie die Dokumentation

Read the Docs ist ein Dokumentationstool, das speziell für Software oder technische Dokumentation entwickelt wurde.

Sie können Ihre Inhalte und Versionierung mit Git verwalten und dann einfach auf einer benutzerfreundlichen Frontend-Oberfläche bereitstellen. Dieser Ansatz bedeutet, dass es nur für Entwickler wirklich zugänglich ist … aber das macht Sinn, da es sich auf die Erstellung technischer Dokumentation konzentriert.

Je nach verwendeter Version können Sie auch auf einige oder alle der folgenden Funktionen zugreifen:

• Analytics, um zu sehen, wonach Besucher suchen und was sie lesen.
• Live-Suchergebnisse und Vorschläge.
• Mehrere gleichzeitige Builds. Zum Beispiel einen Build für die Produktion und einen für die Beta oder einen für Version 1.0 und einen für Version 2.0.
• Einfacher Export in PDF, HTML oder epub.
• Einmalige Anmeldung über Google Workspace oder VCS-Anbieter (GitHub, GitLab oder Bitbucket).

Vorteile

• Verwenden Sie Entwicklungstools . Durch die Verwendung von Tools wie Git zur Verwaltung der Dokumentation versucht Read the Docs, sich in die bestehenden Arbeitsabläufe von Softwareentwicklern einzubauen.
• Starke Versionierung . Git vereinfacht die Verwaltung der Versionsverwaltung und Sie können auch mehrere Versionen Ihrer Dokumente gleichzeitig veröffentlichen, was großartig ist, wenn Benutzer möglicherweise unterschiedliche Versionen Ihrer Software verwenden.

Nachteile

• Komplexere Einrichtung . Read the Docs ist etwas komplexer einzurichten als andere Dokumentationstools, da Sie über Git arbeiten müssen. Da es sich jedoch auf technische Dokumentation konzentriert, sollten die Personen, die Read the Docs verwenden, keine Probleme haben.
• Nur für technische Dokumentation . Wenn Sie keine Software/technische Dokumentation erstellen, sollten Sie ein anderes Dokumentationstool auswählen, da Read the Docs nichts für Sie ist.

Preisgestaltung

Wenn Sie ein Open-Source-Projekt haben, können Sie mit Read the Docs Ihre Dokumentation kostenlos erstellen und hosten. Tatsächlich sagt Read the Docs, dass es kostenlose Dokumentation für über 240.000 Open-Source-Projekte hostet.

Für kommerzielle Unternehmen gibt es auch einen kostenpflichtigen Read the Docs for Business-Service, der bei 50 US-Dollar pro Monat beginnt. Alle Pläne beinhalten unbegrenzte Projekte und Benutzer – die Hauptbeschränkungen sind die Funktionen, die Sie erhalten, und die Anzahl der gleichzeitigen Builds, die Sie haben können.

Erste Schritte mit Read the Docs

Read the Docs bietet Ihnen zwei Möglichkeiten, Ihre eigentliche Dokumentation zu schreiben:

1. MkDocs
2. Sphinx

Sobald Sie diese Tools verwenden, um ein Git-Repository mit Ihren Dokumentationsinhalten zu erstellen, importiert Read the Docs automatisch das Repository, um Ihre Dokumentation zu erstellen.

5. Begriff + Engine.so

Notion ist hier ein bisschen ein Curveball, da es nicht speziell für die Dokumentation entwickelt wurde. Mit der richtigen Einrichtung kann es jedoch ein großartiges Werkzeug sein, um alle Arten von Dokumentationen zu handhaben.

Wenn Sie mit Notion nicht vertraut sind, ist es im Grunde ein All-in-One-Tool, um jede Art von Wissen, Daten, Projektmanagement und vieles mehr zu verwalten.

Sie können es für unzählige verschiedene Dinge verwenden, einschließlich der Erstellung aller Arten von Dokumentationen. Der Nachteil ist jedoch, dass Notion an sich nicht wirklich darauf ausgerichtet ist, diese Informationen auf einer Website zu veröffentlichen, auf der andere Personen damit interagieren können.

Hier kommt Engine.so ins Spiel. Mit Engine.so ( einem Drittanbieterdienst) können Sie Ihre Notion- Inhalte auf Ihrer eigenen Website veröffentlichen, um ganz einfach Ihren eigenen Dokumentations-Hub zu erstellen. Ein Beispiel dafür, wie dies aussieht, finden Sie in der Engine.so-Dokumentation.

Vorteile

• Einzigartige Möglichkeiten, Informationen zu präsentieren . Die Verwendung von Notion gibt Ihnen viel Flexibilität, die Sie mit enger zielgerichteten Dokumentationstools möglicherweise nicht erhalten. Beispielsweise können Sie die vielen Notion-Blöcke auf interessante Weise verwenden.
• Einfach zu bedienen . Im Gegensatz zu Git-basierten Tools ist dieser Ansatz sowohl für technische als auch für nicht-technische Benutzer einfach.
• Erschwinglich . Obwohl es keinen kostenlosen Plan gibt, sollte dieser Ansatz für die meisten Anwendungsfälle erschwinglich sein.

Nachteile

• Nicht speziell für die Dokumentation entwickelt . Notion eignet sich zwar hervorragend für die Dokumentation, aber das ist nicht der einzige Fokus, wie es bei den anderen Dokumentationstools auf dieser Liste der Fall ist. Wenn Sie planen, Hunderte von Artikeln zu haben, bevorzugen Sie möglicherweise ein spezieller entwickeltes Tool.
• Eingeschränkte Versionskontrolle. Dieser Ansatz bietet keine starke Versionskontrolle. Wenn Sie für Notion bezahlen, können Sie einen 30-tägigen Versionsverlauf abrufen, aber er ist nicht so stark wie Git oder das WordPress-System, das Sie mit der Heroic Knowledge Base erhalten.

Preisgestaltung

Notion hat einen kostenlosen Plan, der für grundlegende Anwendungsfälle gut funktionieren sollte. Es besteht jedoch die Möglichkeit, dass Sie je nach Ihren spezifischen Bedürfnissen zahlen möchten.

Um Ihre Notion-Inhalte in einen öffentlichen Dokumentations-Hub zu verwandeln, müssen Sie jedoch für Engine.so bezahlen. Engine.so kostet 19 US-Dollar pro Monat für bis zu 300 Seiten oder 49 US-Dollar pro Monat für bis zu 1.000 Seiten. Sie können es mit einer 14-tägigen kostenlosen Testversion testen.

Erste Schritte mit Notion

So erstellen Sie mit diesem Setup eine Dokumentation:

1. Registrieren Sie sich für ein Notion-Konto.
2. Erstellen Sie Ihre Dokumentation mit Notion. Sie können vorgefertigte Notion-Vorlagen für Dokumentationsinhalte finden, wie z. B. diese Vorlagen von Beestat.
3. Registrieren Sie sich für ein Engine.so-Konto.
4. Veröffentlichen Sie Ihre Notion-Dokumentation mit Engine.so auf Ihrer eigenen benutzerdefinierten Website/Ihrem eigenen Dokumentations-Hub.

6. Hilfssaft

Ähnlich wie Document360 ist Helpjuice ein weiteres beliebtes SaaS-Wissensdatenbank- und Dokumentationstool.

Es hilft Ihnen, jede Art von Dokumentation mit einem einfachen Texteditor zu erstellen, einschließlich Optionen zum Importieren aus Word-Dokumenten, um Zeit zu sparen.

Sie erhalten auch Zugriff auf eine Reihe von Funktionen, um eine effektive Dokumentation zu erstellen:

• Sofortige Suchergebnisse/Vorschläge.
• Analytics zum Verfolgen von Suchanfragen, Seitenaufrufen und vielem mehr.
• Option zur Veröffentlichung mehrerer Versionen Ihrer Dokumentation.
• Benutzerzugriffsebenen, um zu steuern, wer verschiedene Artikel sehen kann.
• Funktionen für die Zusammenarbeit, einschließlich In-Editor-Kommentare.

Vorteile

• Einfache Einrichtung . Um eine Dokumentation zu erstellen, müssen Sie sich lediglich für ein Konto registrieren.
• Für Sie gehostet . Helpjuice übernimmt das Hosting und die Pflege Ihrer Dokumentation für Sie, sodass Sie sich nie mit Updates oder Ähnlichem herumschlagen müssen.
• Keine funktionsgesperrten Pläne . Während Helpjuice keinen kostenlosen Plan hat, haben Sie mit allen kostenpflichtigen Plänen Zugriff auf alle Funktionen.

Nachteile

• Teuer . Der günstigste Plan beginnt bei 120 $ pro Monat und kann bis zu 500 $ pro Monat reichen.
• Benutzergrenzen . Wenn Sie ein großes Team haben, kann Helpjuice teuer werden. Wenn Sie beispielsweise mehr als 60 Benutzer haben, benötigen Sie den 500-Dollar-Plan pro Monat.

Preisgestaltung

Die kostenpflichtigen Pläne von Helpjuice beginnen bei 120 US-Dollar pro Monat für alle Funktionen und bis zu vier Benutzer. Die Pläne steigen von dort an, basierend auf der Anzahl der Benutzer, die Sie benötigen, und belaufen sich auf 500 $ pro Monat für unbegrenzte Benutzer.

Das Einzigartige ist, dass Sie Zugriff auf alle Funktionen in allen Plänen erhalten, während so etwas wie Document360 bestimmte Funktionen hinter höherrangigen Plänen sperrt.

Sie können auch alles mit einer 14-tägigen kostenlosen Testversion testen.

So fangen Sie mit Helpjuice an

Um zu beginnen, müssen Sie sich lediglich für ein Helpjuice-Konto registrieren und mit dem Hinzufügen Ihrer Inhalte beginnen.

Welches ist das beste Dokumentationstool für Ihre Anforderungen?

Letztendlich hängt die Wahl des besten Dokumentationstools wirklich von Ihren spezifischen Bedürfnissen, Ihrem Budget und Ihrem Wissensstand ab.

Hier sind einige häufig gestellte Fragen, die Sie sich stellen sollten, um Ihre Suche einzugrenzen:

• Möchten Sie eine selbst gehostete Lösung oder können Sie ein SaaS-Tool verwenden?
• Möchten Sie eine Open-Source-Lösung oder können Sie ein Closed-Source-Tool verwenden?
• Erstellen Sie sehr technische Dokumentation (z. B. API-Dokumentation) oder eher verbraucherorientierte Dokumentation?
• Gefällt Ihnen die Idee, Git für Versionskontrolle/Content-Management zu verwenden, oder hätten Sie lieber ein dediziertes Wissensmanagementsystem?
• Was ist Ihr Budget? Sind Sie damit einverstanden, eine laufende monatliche Gebühr zu zahlen, oder möchten Sie etwas, das kostenlos ist oder eine einmalige Zahlung erfordert?

Durch die Beantwortung dieser Fragen sollten Sie eine gute Vorstellung davon haben, welches das beste Dokumentationstool für Ihre Anforderungen ist.

Wenn Sie sich nicht sicher sind, wo Sie anfangen sollen, glauben wir, dass die Heroic Knowledge Base die Anforderungen der meisten Unternehmen erfüllen kann. Es bietet einen kostengünstigen Open-Source-Ansatz, der Ihnen die volle Kontrolle über Ihre Daten zu einem Preis gibt, der niedriger ist als bei den meisten anderen Tools.

Gleichzeitig erhalten Sie jedoch weiterhin Zugriff auf unzählige Funktionen, um erstklassige Dokumentationen zu erstellen, z. B. Live-Suchvorschläge und detaillierte Analysen. Sie erhalten auch Zugriff auf das gesamte WordPress-Ökosystem, wenn Sie noch mehr Flexibilität wünschen.

Um mehr zu erfahren und loszulegen, besuchen Sie die Produktseite der Heroic Knowledge Base.