• Dokumentation
  • Tools
  • Software-Vergleich
  • Softwaredokumentation
  • KI

Dokumentationstool finden: Warum das Schreiben wichtiger ist als die Suche

@nandorbVerifiziert11 Min. Lesezeit

Eine Person schreibt mit einem Kugelschreiber Notizen in ein Ringbuch, daneben steht ein aufgeklappter Laptop auf einem Holztisch.
Source: Unsplash.

In meiner Laufbahn habe ich mit Confluence und mit Notion gearbeitet, und ich fand beide richtig gute Editoren. Trotzdem ist bei mir viel zu viel Zeit fürs Schreiben und Überarbeiten draufgegangen.

Als KI-Tools dann richtig gut im Zusammenfassen wurden, ist mir etwas klar geworden. Das Hauptproblem ist immer noch nicht gelöst: Niemand schreibt gern Dokumentation. Und eine KI-Zusammenfassung ist nur so gut wie die Dokumentation, die dahinter steht.

Also habe ich mich gefragt, warum wir eigentlich glauben, dass Dokumentation immer veraltet ist. Liegt es daran, dass wir die Antworten nicht finden? Oder daran, dass die Antwort nirgends aufgeschrieben ist?

Diese Frage zieht sich durch den ganzen Artikel. Wenn die Antwort nirgends steht, hilft dir weder eine bessere Suche noch eine schlauere KI. Deshalb schaue ich mir Dokumentation Tools heute zuerst danach an, wie leicht ein Team darin schreibt und wie schnell eine Seite nach einer Änderung wieder stimmt. Erst danach kommen Suche, Design und alles andere.

Finden oder aufschreiben: Dokumentationsanforderungen klären

Eine Suche findet nur, was dasteht

Fast jedes Werkzeug wirbt heute mit Suche und KI-Antworten. Das ist praktisch, solange die Seiten dahinter stimmen. Fehlt eine Seite oder ist sie veraltet, liefert auch die beste Suche nur eine alte oder gar keine Antwort. Bei der Auswahl hilft mir deshalb eine einfache Reihenfolge: zuerst schreiben, dann aktuell halten, dann finden.

Wer das umdreht, kauft oft ein Werkzeug, das gut aussieht und nach drei Monaten trotzdem leer oder veraltet ist. Am Editor liegt das selten. Meistens hat sich niemand die Zeit genommen, darin zu schreiben.

Wer schreibt bei euch, und wie oft ändert sich etwas?

Wenn das Schreiben das wichtigste Kriterium ist, musst du zuerst wissen, wer schreibt. Das können Entwickler sein, die sowieso in Git arbeiten, eine technische Redaktion oder Leute aus Support und Betrieb, die die Dokumentationsaufgaben neben ihrer normalen Arbeit erledigen. Für jede dieser Gruppen fühlt sich ein anderes Werkzeug leicht an.

Die zweite Frage ist, wie oft sich der Inhalt ändert. Ein Handbuch, das einmal im Jahr neu erscheint, verträgt einen aufwendigen Prozess. Eine Anleitung, die nach jedem Release angepasst werden muss, verträgt ihn nicht. Je öfter sich etwas ändert, desto wichtiger wird, wie wenig Aufwand ein Update macht. In vielen Firmen gibt es mehrere Dokumentationsbereiche mit ganz unterschiedlichen Antworten, und dann ist ein Werkzeug pro Bereich meistens besser als ein Kompromiss für alle.

Wiki, DMS oder Redaktionssystem?

Diese drei Begriffe werden oft durcheinandergeworfen, obwohl sie beim Schreiben ganz verschieden sind. Ein Dokumentenmanagementsystem, kurz DMS, verwaltet fertige Dokumente wie Verträge oder Rechnungen, mit Ablagefristen und Revisionssicherheit. Darin wird kaum geschrieben, es wird abgelegt. Ein Wiki ist ein Ort, an dem Inhalte entstehen und sich laufend ändern. Ein Redaktionssystem baut Handbücher aus wiederverwendbaren Bausteinen, oft in mehreren Sprachen.

Wenn du also ein Dokumentation Tool suchst, in dem dein Team schreibt, landest du fast nie beim DMS.

Wenn es um Wissen in der ganzen Firma geht

Manchmal geht es um mehr, nämlich um Wissensaustausch im ganzen Unternehmen, um Onboarding, Richtlinien und Abläufe aus allen Abteilungen. Dafür gibt es bei uns einen eigenen Wissensmanagement Software Vergleich. Hier bleibe ich bei den Werkzeugen, mit denen Teams ihre Dokumentation schreiben und pflegen.

Die fünf Typen von Dokumentationstools im Vergleich

Bevor ich mir einzelne Dokumentationswerkzeuge anschaue, ordne ich sie einem Typ zu. Fünf Gruppen decken das meiste ab, und bei jeder frage ich dasselbe: Wie leicht fällt das Schreiben, und wie leicht fällt das Aktualisieren?

Word und Google Docs

Hier fängt fast jede Dokumentation an, weil jeder darin schreiben kann, ohne etwas Neues zu lernen. Für wenige Dokumente wie ein Pflichtenheft oder ein kurzes Handbuch reicht das völlig.

Schwierig wird es beim Aktualisieren. Sobald die Dateien mehr werden, tauchen Kopien mit Namen wie „final_v3“ auf, und keiner weiß mehr, welche Datei gilt. Die Antwort ist dann zwar irgendwo aufgeschrieben, aber an fünf Orten in fünf Fassungen. Wenn du bei diesem Typ bleibst, hilft eine Datei pro Thema und ein fester Ablageort.

Wikis und Wissensdatenbanken

Confluence, Notion, SharePoint oder ein selbst gehostetes Wiki wie BookStack bringen Seiten, Verlinkung, Rechte, Echtzeit-Kollaboration und eine Versionshistorie mit. Für interne Abläufe ist das der verbreitetste Typ, weil auch Leute ohne technischen Hintergrund darin schreiben. Wer vor allem Prozessdokumentation und SOPs festhalten will, ist hier meistens richtig.

Beim Schreiben der ersten Fassung sind Wikis stark. Beim Aktualisieren hilft dir das Werkzeug selbst wenig, denn die Seite stimmt nur so lange, wie jemand daran denkt, sie anzufassen. Ohne klare Regeln wächst außerdem die Struktur wild, und neue Seiten landen neben alten, statt sie zu ersetzen.

Docs-as-Code für Software Dokumentation Tools

Bei Software Dokumentation Tools hängt die Wahl fast immer davon ab, wer schreibt. Schreiben fast nur Entwickler, ist Docs-as-Code schwer zu schlagen. Die Doku liegt als Markdown in Code-Repositories auf GitHub oder GitLab, direkt neben dem Code. Docusaurus, MkDocs oder Sphinx bauen daraus eine Website, und Read the Docs kann das Hosting übernehmen. Die Auto-Generierung der API-Dokumentation aus einer OpenAPI-Spezifikation erledigen Swagger UI oder Redocly, und GitHub Copilot hilft bei Kommentaren im Code.

Der große Vorteil für die Pflege: Eine Änderung am Code und die passende Änderung an der Doku können im selben Pull Request landen. Sobald aber Produktmanagement oder Support mitschreiben sollen, wird Git zur Hürde, und dann schreiben sie lieber gar nicht. Viele Teams landen deshalb bei zwei Orten, mit Referenz und Entwicklerdoku im Repository und Runbooks und Onboarding im Wiki. Das klappt gut, solange keine Anleitung an beiden Orten parallel gepflegt wird.

Plattformen für Produkt- und Kundendoku

GitBook, Document360 oder ReadMe verbinden einen visuellen Editor mit einem öffentlichen Dokumentationsportal. Gedacht sind diese Plattformen für Softwareanbieter, die Hilfeartikel und API-Dokumentation für Kunden schreiben. Viele lassen sich mit dem Helpdesk verbinden. Dann verweist der Kundensupport aus einem Ticket direkt auf einen Artikel, und die Self-Service-Wissensdatenbank beantwortet manche Frage, bevor jemand sie stellt.

Für gemischte Teams ist das oft ein guter Kompromiss, weil Entwickler über Git und alle anderen im Editor arbeiten können. Damit die Self-Service-Seite funktioniert, muss die Antwort aber erst einmal geschrieben sein. Das Portal macht sie nur sichtbar.

Redaktionssysteme für technische Dokumentation

MadCap Flare, Adobe FrameMaker oder Paligo arbeiten mit Modulen, Wiederverwendung und Varianten. Wer dieselbe Warnung in vierzig Handbüchern und zwölf Sprachen braucht, schreibt sie hier einmal und pflegt sie an einer Stelle. Für Maschinen und Geräte gelten dazu Vorgaben wie die Maschinenverordnung und der Standard IEC/IEEE 82079-1. Welche technische Dokumentation Tools zu welcher Größe passen, steht ausführlich in unserem Vergleich der Tools für technische Dokumentation.

IT-Dokumentation: Was ein IT Dokumentation Tool erfasst

Wer ein IT Dokumentation Tool sucht, meint meistens kein Schreibwerkzeug. Docusnap inventarisiert IT-Systeme und Netzwerke automatisch, und i-doit bildet die Infrastruktur als CMDB ab. Diese Daten werden erfasst statt geschrieben und ersetzen die alte Excel-Liste mit IP-Adressen. Notfallhandbücher, Runbooks für das Störungsmanagement, Notizen zum Changemanagement und die Systemdokumentation eigener Softwareanwendungen musst du trotzdem selbst schreiben. Dafür reicht oft ein Wiki, das auf das Inventar verlinkt.

Meine Entscheidungstabelle

Die Tabelle ist keine Rangliste. Ich ordne darin typische Ausgangslagen einem Typ zu, damit du vor der ersten Demo auf zwei oder drei Kandidaten kommst. In der letzten Spalte steht, worauf du beim Schreiben und Pflegen achten solltest.

Deine Ausgangslage

Passender Typ

Beispiele

Darauf solltest du achten

Wenige Dateien, kleines Team, seltene Änderungen

Textverarbeitung mit Vorlagen

Word, Google Docs

eine Datei pro Thema und ein fester Ablageort

Internes Wissen und SOPs, viele Autoren ohne technischen Hintergrund

Wiki oder Wissensdatenbank

Confluence, Notion, SharePoint, BookStack

für jede Seite eine verantwortliche Person festlegen

Entwicklerdoku und API-Referenz, Autoren arbeiten in Git

Docs-as-Code

Docusaurus, MkDocs, Sphinx mit Read the Docs

Doku im selben Pull Request wie den Code ändern

Hilfeartikel für Kunden, gemischtes Team

Plattform für Produktdoku

GitBook, Document360, ReadMe

Versionen, Rechte und Export prüfen

Viele Varianten und Sprachen, rechtliche Vorgaben

Redaktionssystem oder Help-Authoring-Tool

MadCap Flare, Paligo, Adobe FrameMaker

Einführung als eigenes Projekt planen

Server, Netzwerke und Assets

Inventar und CMDB

Docusnap, i-doit

Textdoku für Abläufe zusätzlich klären

Seiten veralten, weil das Aktualisieren zu lange dauert

KI-Schreibwerkzeug, das bestehende Seiten aktualisiert

Cortee

keine Suche über andere Apps

Auswahl und Dokumentationsprozess: ein Tool, in dem dein Team auch schreibt

Der Schreibtest mit echten Inhalten

Wenn das Schreiben das Kriterium ist, solltest du es auch testen. Mit zwei oder drei Kandidaten mache ich deshalb einen kurzen Test, am besten in der Testphase oder einer Gratis-Stufe. Ich nehme echte Dokumente statt Beispielseiten. Dann bitte ich jemanden, der nicht am Projekt beteiligt ist, zwei Dinge zu tun: eine neue Seite schreiben und eine bestehende nach einer Änderung aktualisieren.

Wie lange das dauert und wo die Person hängen bleibt, sagt mir mehr als jede Funktionsliste. Die Suche teste ich erst danach, mit genau den Seiten, die in diesem Test entstanden sind.

Teamgröße, Integrationen und Datenschutz

Die Teamgröße verschiebt die Gewichte. Bei fünf Leuten zählt vor allem, dass jemand das Werkzeug an einem Nachmittag einrichten kann. Ab etwa hundert Leuten werden Rechte pro Bereich, Single Sign-on und die Workflow-Integration mit Chat, Ticketsystem und Repository wichtiger. Auch hier frage ich mich, ob die Integration das Schreiben leichter macht oder nur das Finden.

Beim Datenschutz will ich immer drei Dinge wissen: wo die Daten liegen, ob es einen Auftragsverarbeitungsvertrag nach DSGVO gibt und wie die Datenverschlüsselung aussieht. Ich achte außerdem auf einen Export als Markdown oder HTML, weil er einen späteren Wechsel viel leichter macht.

Einführung und versteckte Kosten

Danach starte ich mit einem Team und einem klaren Bereich, zum Beispiel dem Onboarding oder den Runbooks im Betrieb. Eine kurze Mitarbeiterschulung reicht meistens. Wichtiger ist die Gewohnheit: Wer im Chat eine Frage beantwortet, schreibt die Antwort auf die passende Seite und verlinkt sie, statt sie beim nächsten Mal neu zu tippen.

Die versteckten Kosten liegen selten in der Lizenz. Meistens stecken sie in der Migration alter Inhalte, in Zusatzpaketen für KI oder Single Sign-on und im Betrieb selbst gehosteter Systeme. Der größte Posten ist aber die Zeit, die das Team jeden Monat ins Schreiben und Pflegen steckt. Fehlt diese Zeit, bleiben Änderungen liegen, und so entstehen Dokumentationsschulden. Damit sind wir wieder bei der Frage vom Anfang.

Was KI-Dokumentationstools beim Schreiben übernehmen

KI-gestützte Dokumentationstools und AI Writing Assistants formulieren um, fassen zusammen und schreiben Entwürfe. Viele Anbieter werben mit großen Zeitersparnissen. Das sind Herstellerangaben, die ich immer im eigenen Test prüfen würde.

Was künstliche Intelligenz nicht weiß, ist, was sich bei euch geändert hat. Fehlt ihr eine Info, füllt sie die Lücke gern mit einer plausiblen Vermutung. Für die Qualitätskontrolle nutze ich deshalb eine einfache Regel: Die Fakten kommen von Menschen, die KI formuliert, und jede Aussage lässt sich auf eine Quelle zurückführen. Automatisierung hilft beim Formulieren und Einarbeiten, aber das Wissen muss vorher jemand aufschreiben. Mit dem EU-AI-Act kommen für KI-Systeme außerdem Transparenzpflichten dazu.

Warum wir Cortee bauen

Cortee applying an AI edit to the Sales Team Onboarding page, with the changed step highlighted so the reviewer can view what has changed.
Source: Cortee.

Diese Frage ist auch der Grund, warum wir unser Tool Cortee bauen. Wenn die Antwort nirgends dokumentiert ist, kann sie auch die beste Suche nicht finden. Deshalb konzentriert sich Cortee auf das Schreiben und Dokumentieren, und eine Suche über andere Apps gehört nicht dazu. KI hilft dabei, aber der Mensch kommt zuerst. Du lieferst die Fakten, denn ohne sie fängt jedes Modell an zu halluzinieren.

Du schreibst eine kurze Notiz, was sich geändert hat, und Cortee aktualisiert die betroffene Seite. Die Änderung ist sofort live. Passt etwas nicht, machst du sie mit einem Schritt rückgängig. Die Daten liegen in der EU. Wie das im Alltag aussieht, zeigt die Seite Dokumentation live und korrekt halten.

Egal, für welches Werkzeug du dich entscheidest, stell jedem Kandidaten dieselbe Frage: Wie lange dauert es, eine bestehende Seite nach einer Änderung zu aktualisieren? Wenn die Antwort im Test „ein paar Minuten“ lautet, ist die Antwort beim nächsten Mal aufgeschrieben, und dann findet sie auch die Suche.