Docsbook-Anwendungsfälle: die Aufgaben, für die Teams Dokumentation erstellen lassen

Sechs Situationen, mit denen Teams zu uns kommen, und wie Docsbook jeweils damit umgeht. Jede endet mit dem Leitfaden, der die Arbeit erledigt, sodass du von der Situation statt von einer Funktionsliste ausgehen kannst.

„Ich möchte, dass ChatGPT uns empfiehlt, wenn ein Kunde fragt“#

Die Situation. Sie haben ein Produkt, Kunden und ein Werbebudget. Jemand fragt einen KI-Assistenten, welches Tool die von Ihnen angebotene Funktion erfüllt, und Ihr Unternehmen wird in der Antwort nicht genannt.

Was das verhindert. Ein Assistent empfiehlt, was er kostengünstig lesen und überprüfen kann: was das Produkt tut, was es kostet, wo seine Grenzen liegen und wer dahintersteht. Wenn das nirgendwo geschrieben steht, wo der Assistent es abrufen kann, zitiert er einen Wettbewerber, der diese Informationen veröffentlicht hat.

Was Docsbook tut. Docsbook veröffentlicht Ihre Seiten als serverseitig gerendertes HTML, sodass ein Crawler den Text sieht, ohne JavaScript auszuführen, und fügt die Elemente hinzu, nach denen Assistenten suchen: sitemap.xml, kanonische URLs, JSON-LD, ein sichtbares Datum der letzten Änderung und llms.txt im Stammverzeichnis der Website. Jede Seite erhält ihre eigene URL und ihren eigenen Titel, sodass eine Seite zu einer einzelnen, spezifischen Frage bei dieser Frage konkurriert.

Beginnen Sie mit: GEO — Optimierung für generative Suchmaschinen, anschließend mit llms.txt.

„Unsere Dokumentation wird gelesen, und ich kann nicht sagen, ob sie etwas verkauft“#

Die Situation. Die Analyse zeigt, dass die Dokumentation gelesen wird. Niemand kann sagen, ob das Lesen jemanden zur Anmeldung bewegt hat oder welche Seiten den Besuch verschwenden.

Was es verhindert. Seitenaufrufe beschreiben keinen Pfad. Ohne Ereignisse und ein definiertes Ziel meldet eine Dokumentationswebsite Beliebtheit statt Fortschritt.

Was Docsbook tut. Docsbook erfasst auf jeder Seite Seitenaufrufe, Suchanfragen, Lesezeit, Feedback-Abstimmungen und getrackte Ereignisse und stellt sie anschließend als Pfade dar: welche Seiten niemand erreicht, welche Suchanfragen keine Ergebnisse liefern, wie weit ein Leser kommt, bevor er die Seite verlässt, und aus welchen Ländern und mit welchen Sprachen die Besucher kommen. Markieren Sie eine Seite als Trichterschritt und zählen Sie, wie viele Leser ihn abschließen.

Beginnen Sie mit: Übersicht zur Nachverfolgung, dann Ereignisse.

„Unsere Dokumentation ist drei Monate hinter dem Produkt“#

Die Situation. Das Produkt wurde geändert. Die Dokumentation beschreibt weiterhin das alte Verhalten, und alle wissen es.

Was im Weg steht. Dokumentation, die außerhalb des Repositorys liegt, erfordert einen zusätzlichen Akt des Erinnerns. Ein Schritt zum Erstellen und Bereitstellen zwischen dem Schreiben und Veröffentlichen verwandelt eine fünfminütige Korrektur in eine Aufgabe, mit der niemand beginnt.

Was Docsbook tut. Docsbook stellt das Markdown bereit, das sich in Ihrem Repository befindet. Beim Aufrufen der Website wird GitHub erneut geprüft und die Änderungen werden neu indiziert. Dadurch ist ein Push gleichbedeutend mit der Veröffentlichung — es gibt keinen Build-Schritt, keine CI-Pipeline und kein Deployment, auf das gewartet werden muss. Bearbeitungen können auch über den Webeditor oder über einen Agenten via MCP vorgenommen werden, und alle drei werden als Commits im selben Repository gespeichert.

Beginnen Sie mit: Ein GitHub-Repository verbinden und anschließend Ihre Dokumentation verwalten.

„Unsere Kunden lesen kein Englisch“#

Die Situation. Sie verkaufen in Märkten, in denen die Sprache Ihrer Dokumentation nicht der Sprache entspricht, in der Ihre Kunden suchen. Übersetzungen von Hand veralten, sobald sich das Englische ändert.

Was dem im Weg steht. Eine Übersetzung ist nur dann veröffentlichungswürdig, wenn sie mit dem Original Schritt hält und als eigene Seite indexiert wird. Eine in einen Ordner kopierte Version erfüllt beides nicht.

Was Docsbook tut. Docsbook übersetzt Ihre Seiten in 15 Sprachen — Englisch, Spanisch, Französisch, Deutsch, Portugiesisch, Italienisch, Russisch, Chinesisch, Japanisch, Koreanisch, Arabisch, Hindi, Türkisch, Polnisch und Niederländisch. Jede Sprache wird auf einer eigenen Route mit den richtigen hreflang-Tags bereitgestellt, sodass Suchmaschinen sie separat indexieren und Leser auf der Sprache ihres Browsers landen. Übersetzungen werden von KI erstellt und belasten daher das Projektguthaben.

Beginnen Sie mit: Übersetzung aktivieren, dann KI-Übersetzungen.

„Der Support beantwortet jede Woche dieselben fünf Fragen“#

Die Situation. Die Antworten stehen in der Dokumentation. Leserinnen und Leser eröffnen trotzdem ein Ticket, weil sie die Seite nicht gefunden haben.

Was dem im Weg steht. Eine Suche, die mit wörtlichen Schlüsselwörtern arbeitet, berücksichtigt nicht, wie Menschen tatsächlich fragen. Wer eine Frage anders formuliert als Ihre Überschrift, erhält keine Ergebnisse und fragt stattdessen einen Menschen.

Was Docsbook tut. Der KI-Assistent von Docsbook beantwortet Fragen anhand Ihrer indexierten Seiten und nennt die Seite, aus der die Antwort stammt. So erhält ein Leser, der sonst ein Ticket eröffnet hätte, die Antwort direkt dort, wo er sich befindet. Fragen, die der Assistent nicht beantworten konnte, werden aufgezeichnet: Unbeantwortete Fragen und Suchen ohne Treffer werden für Sie aufgelistet. So erfahren Sie, welche Seite Sie als Nächstes schreiben sollten. Antworten des Assistenten werden von einer KI erstellt und belasten das Projektguthaben.

Beginnen Sie mit: KI-Chat, dann mit Seitenfeedback.

„Wir haben eine README und niemand hat Zeit, eine Dokumentationsseite zu erstellen“#

Die Situation. Die Dokumentation des Projekts besteht aus einer langen README.md sowie einem docs/-Ordner, den niemand gerendert hat. Das Einrichten eines Static-Site-Generators würde eine Woche Arbeit erfordern, die Sie nicht bekommen werden.

Was es verhindert. Ein Generator benötigt eine Konfiguration, ein Theme, eine Build-Pipeline und eine Hosting-Entscheidung, bevor er eine einzige Seite rendert – und anschließend muss jemand alle vier Komponenten warten.

Was Docsbook tut. Docsbook liest das Repository so, wie es ist. Die Ordnerstruktur wird zum Navigationsbaum, Überschriften werden zur Gliederung, relative .md-Links werden zu echten URLs aufgelöst, und die Website ist unter docsbook.io/{owner}/{repo} mit Volltextsuche und einer öffentlichen URL live. Es gibt keine Konfigurationsdatei zu schreiben. Ihr Markdown verlässt niemals Ihr GitHub-Repository, sodass es später nichts kostet, ein anderes Tool auf dasselbe Repository zu verweisen.

Beginnen Sie mit: Schnellstart, dann Erstellen Sie Ihre erste Website.

Nächste Schritte#

• Übersicht — was Docsbook mit Ihrem Repository macht, von Anfang bis Ende
• Konzepte — die oben verwendeten Begriffe, jeweils einmal definiert
• Preise — was abgerechnet wird und wofür ein Projektguthaben verwendet wird
• FAQ — Kündigung, Datenschutz, Synchronisierung und Datenbesitz