Rezension zu Document360

Document360 ist ein webbasiertes Redaktionssystem zum kollaborativen Erstellen einer Onlinedokumentation. Dank eines einfachen Editors können auch Personen damit arbeiten, deren Hauptaufgabe nicht im Schreiben Technischer Dokumentation besteht. Diese Rezension zeigt, wo die Besonderheiten von Document360 liegen und für welche Szenarien sich das System besonders gut eignet.

Hinweise: Dieser Artikel wurde vom Hersteller der Software unterstützt. Der Hersteller nahm jedoch keinen Einfluss auf den Inhalt des Artikels. Getestet wurde Version 9.5.

Systemvoraussetzungen und Installation

Als Software-as-a-Service-Anwendung (SaaS) im Web erfordert Document360 keine Installation, stellt keine besonderen Anforderungen an die Hardware und läuft unter jedem Betriebssystem.

Eine „On-premise“-Installation im eigenen Haus ist nicht möglich, jedoch bietet der Hersteller optional die Möglichkeit eines „Private Hosting“ auf einem von anderen Kunden isolierten Server mit freier Wahl des Standorts in rund 50 Ländern.

Nach dem erstmaligen Anmelden führt ein gut gemachter Onboarding-Prozess durch die ersten Schritte und ein Assistent hilft beim Anlegen des Projekts. Das System ist so einfach bedienbar, dass eine spezielle Schulung nicht erforderlich ist.

Aufbau der Benutzeroberfläche

Die Benutzeroberfläche besteht im Wesentlichen aus einem Auswahlmenü links und einem Editor rechts. Topic-spezifische Einstellungen (Document360 spricht von „Artikeln“, nicht Topics) lassen sich auf der rechten Seite treffen. Damit ist der auf dem Bildschirm zur Verfügung stehende Platz bestmöglich genutzt. Das Ganze läuft in einem Webbrowser.

Inhalte bearbeiten

Beim Anlegen eines Topics bietet Document360 die Wahl, ob das Topic in einem einfachen Markdown-Editor bearbeitet werden soll oder in einem HTML-basierten WYSIWYG-Editor.

Markdown-Editor:

WYSIWYG HTML-Editor:

Welcher Editor verwendet wird, ist Topic-spezifisch. Auf diese Weise können einzelne Beteiligte die von ihnen betreuten Inhalte in Markdown pflegen, während andere Personen vielleicht lieber im WYSIWYG-Editor arbeiten.

Der Bearbeitungsmodus lässt sich auch wechseln, allerdings nur einmalig von Markdown nach WYSIWYG und dann nicht wieder zurück.

Zur Verfügung stehen die klassischen Markdown- und HTML-Elemente sowie einige spezielle Dinge wie Hinweise, Warnhinweise und Tipps. Es gibt jedoch generell keine Möglichkeit, mit vordefinierten Absatz-, Zeichen- und Tabellenformaten zu arbeiten. Sollen beispielsweise Bedienelemente im Text immer fett und blau dargestellt werden, müsste dies im WYSIWYG-Editor jedes Mal manuell einzeln formatiert werden. Dies ist wenig praktikabel. Besser ist es, z. B. im genannten Beispiel nur das Standard-Element <strong> zu verwenden und dieses dann projektweit über ein eigenes CSS zu formatierten. Dies ist immerhin möglich.

Bilder, Videos und externe Dateien werden auf ein virtuelles Laufwerk hochgeladen und stehen damit allen Beteiligten projektweit zur Verfügung.

Wird ein Bild verkleinert in ein Topic eingebunden, wird daraus automatisch ein Thumbnail. Nutzer können dann zur Laufzeit bei Bedarf auf das Bild klicken und erhalten eine vergrößerte Ansicht in einer Lightbox. Expandierbare Textabschnitte, in vielen Tools auch als „Dropdowns“ oder „Toggles“ bezeichnet, sowie andere Progressive-Disclosure-Controls wie Registerkarten werden mit Bordmitteln von Document360 nicht unterstützt.

Dokumente generieren

Ein „Generieren“ einer mit Document360 erstellten Onlinedokumentation ist nicht erforderlich. Alle Inhalte gehen sofort „live“, sobald Sie im jeweiligen Topic dessen Workfow-Status auf „Published“ setzen. Ein Export statischer HTML-Seiten zur Offline-Nutzung für Nutzer ohne Internetzugang ist nicht vorgesehen.

Eine mit Document360 erstellte Onlinedokumentation liegt technisch gesehen immer auf dem Server des Anbieters von Document360. Allerdings können Sie die URL so konfigurieren, dass dies für Nutzer nicht erkennbar ist und die Dokumentation beispielsweise unter docs.ihredomain.com aufrufbar ist.

Eine typische mit Document360 erstellte Onlinedokumentation besteht aus zwei Seitentypen:

• einer Homepage mit einer Suchfunktion und einer Übersicht über die Hauptkapitel
• den einzelnen Topics einschließlich Navigation

Die Homepage einer mit Document360 erstellten Onlinedokumentation sieht z. B. wie folgt aus:

Ein Topic einer mit Document360 erstellten Onlinedokumentation sieht z. B. wie folgt aus:

Navigationselemente

Innerhalb eines Topics stehen Nutzern folgende Navigationselemente zur Verfügung:

• Gesamtinhaltsverzeichnis mit Filterfunktion (linke Seite)
  (optional kann jedes Hauptkapitel im Inhaltsverzeichnis mit einem Symbol gekennzeichnet werden – im vorstehenden Bild nicht sichtbar)
• Inhaltsverzeichnis des aktuell angezeigten Topics (rechte Seite)
• Brotkrümel-Navigation
• Suchfunktion
• Schaltfläche zum Scrollen zurück zum Topicanfang (erscheint bei langen Topics automatisch rechts unten – im vorstehenden Bild nicht sichtbar)
• Schaltflächen zum Weiterblättern zu dem in der Struktur nachfolgenden nächsten Topic sowie zum Zurückblättern zu dem in der Struktur vorangehenden Topic (erscheinen am Topicende – im vorstehenden Bild nicht sichtbar)

Erweiterte Suche

Die Suchfunktion ist bemerkenswert leistungsstark und bietet neben Fehlertoleranz sogar so etwas wie eine einfache Facettensuche. Damit ist es z. B. möglich, die Suche auf einzelne Versionen, bestimmte Sprachen, Kapitel oder den Topics zugeordnete Tags zu beschränken.

Weitere Funktionen

Erwähnenswert sind auch noch folgende in einer Onlinedokumentation optional aktivierbare Funktionen:

• Anzeige der geschätzten Lesezeit
• Möglichkeit, in einen Dark-Mode zu wechseln
• Möglichkeit, das aktuelle Topic als PDF-Datei herunterzuladen
• Feedback-Funktion

• Glossar
• Anzeige einer Liste von Topics, die kürzlich geändert wurden (Zeitraum vom Nutzer auswählbar)

Aufruf und Integration

Eine mit Document360 erstellte Onlinedokumentation an eine Webanwendung anzubinden, funktioniert äußerst komfortabel. Hierzu müssen Sie lediglich ein vorgefertigtes JavaScript in Ihre Webanwendung einbinden. Automatisch erscheint dann in der Webanwendung ein Symbol, über das Nutzer die Dokumentation in einem eingebetteten Overlay-Fenster einblenden können.

Zu Demonstrationszwecken funktioniert das auch auf einer Website. Auf dieser Website sähe eine eingeblendete Onlinedokumentation z. B. wie folgt aus:

Mit einem zweiten Klick können Nutzer den Anzeigebereich der Hilfe vergrößern oder die Hilfe auf einer neuen, zusätzlichen Registerkarte öffnen.

Abhängig von der URL der aufrufenden Seite oder abhängig vom Verzeichnis, in dem eine aufrufende URL liegt, lässt sich einstellen, welches Hilfethema per Voreinstellung angezeigt wird. Damit haben die Redakteure der Dokumentation freie Hand über die kontextsensitive Anbindung und sind hierbei nicht von der Software-Entwicklung abhängig.

Alternativ ist jedes Topic aber auch über eine permanente URL aufrufbar.

PDF-Ausgabe

Im Gegensatz zur Onlinedokumentation beschränkt sich der ebenfalls mögliche PDF-Export auf das absolut Notwendige: ein sehr einfach gehaltenes Cover lediglich mit Titel und optional einem Logo, Inhaltsverzeichnis, Seiten mit Logo in der Kopfzeile und Seitenzahl in der Fußzeile. Anpassungsmöglichkeiten gibt es kaum. Es reicht für einen einfachen Ausdruck aus, Schönheitspreise lassen sich damit nicht gewinnen.

Tipp: Wer ein schönes, individuell gestaltetes Cover möchte, könnte die Seite nachträglich in einem PDF-Editor durch eine extern generierte Seite ersetzen.

API-Dokumentation

Interessante Möglichkeiten bietet Document360 auch im Bereich API-Dokumentation.

Nach dem Hochladen oder Verlinken einer OpenAPI Definition als JSON- oder YAML-File, erzeugt Document360 automatisch Topics für alle API-Endpunkte. Über eine eingebaute „Try it“ Funktion können Nutzer die einzelnen Befehle unmittelbar aus der Dokumentation heraus testen. Automatisch generierte Code-Beispiele in mehreren Programmiersprachen erleichtern Benutzern die Verwendung der API in eigenen Programmen.

Das Ergebnis sieht dann z. B. so aus, wie in der Dokumentation zu Document360s eigener API:

Kombination mit redaktionell gepflegten Inhalten

Bei Bedarf können Sie einem automatisch erzeugten Topic einer API-Dokumentation in Document360 manuell weitere Informationen hinzufügen. Selbstverständlich können Sie manuell auch komplett neue Topics ergänzen.

Das Besondere in beiden Fällen: Ändert sich später die Datei mit der OpenAPI Definition, aktualisiert Document360 automatisch alle betroffenen Topics. Ein intelligenter Automatismus sorgt dabei dafür, dass alle zuvor manuell ergänzten Informationen erhalten bleiben und durch das Update nicht überschrieben werden.

Single Source Publishing

Single Source Publishing unterstützt Document360 nur eingeschränkt.

Mehrfachnutzung

Für mehrfach in einem Projekt benötigte Inhalte lassen sich Snippets anlegen, die an zentraler Stelle gepflegt und beliebig oft verwendet werden können. Ein Snippet kann beliebige Inhalte enthalten, beispielsweise auch mehrere Absätze, Tabellen, Bilder und so weiter.

Variablen

Variablen können kleinere, mehrfach zu verwendende Inhalte enthalten, beispielsweise einen Produktnamen oder technische Daten. Anders als in vielen anderen Redaktionssystemen lässt sich hierbei auch die Formatierung mit speichern.

Allerdings sind die „Variablen“ bei genauem Hinsehen eher Konstanten, denn außer der Stelle, wo die Variablen definiert sind, lässt sich der Wert der Variable nirgends überschreiben. „Variablen“ sind also eher so etwas wie kleine, statische Snippets.

Keine Varianten, keine bedingten Inhalte

Document360 unterstützt keine Dokumentationsvarianten. Es ist also beispielsweise nicht möglich, aus derselben Quelle unterschiedliche Dokumentationsvarianten zu erstellen, wie beispielsweise eine Dokumentationsvariante für eine „Standard-Version“ und eine Dokumentationsvariante einer „Enterprise-Version“ eines Produkts mit zusätzlichen oder teilweise abweichenden Inhalten. Demzufolge sind in Document360 keine bedingten Inhalte („Conditional Text“) vorgesehen.

Zwei kleine Ausnahmen gibt es allerdings:

• In einer Onlinedokumentation lässt sich die Anzeige bestimmter Topics an Benutzerrechte knüpfen, sodass bestimmte Zielgruppen nur Informationen bestimmter Kategorien (Kapitel) sehen können.
• Im PDF-Export lassen sich bestimmte ganze Kapitel oder einzelne Topics komplett ausschließen.

Übersetzung

Document360 unterstützt auch mehrsprachige Projekte.

In einer mehrsprachigen Dokumentation können Nutzer die gewünschte Sprache selbst einstellen. (Die Voreinstellung richtet sich nach der Sprache des zur Anzeige genutzten Browsers oder den Parametern beim Aufruf der Dokumentation.)

Um eine Dokumentation zu übersetzen, bietet Document360 folgende Möglichkeiten:

• maschinelle Übersetzung auf Knopfdruck
• manuelle Übersetzung in der Oberfläche von Document360
• Übersetzung über die Integration mit dem externen Service https://crowdin.com

Ein direkter Export als Übersetzungspaket für andere Translation-Memory-Systeme ist nicht vorgesehen.

Teamarbeit

Eine Stärke eines Online-Redaktionssystems ist das kollaborative Erstellen und Pflegen einer Dokumentation im Team – so auch bei Document360.

Mehrere Personen können gleichzeitig an einer Dokumentation arbeiten und unterschiedliche Topics editieren. Hat eine Person ein Topics zum Bearbeiten geöffnet, ist das Topic während dieser Zeit für andere Personen gesperrt, sodass keine Konflikte entstehen.

Notizen, Kommentare, Diskussionen im Team

Parallel zu jedem Topic können die an der Erstellung oder an Reviews beteiligten Personen eine für spätere externe Nutzer (Kunden) nicht sichtbare Diskussion führen.

Analog lassen sich auch direkt innerhalb eines Topics Notizen einfügen, die nur für den internen Gebrauch bestimmt sind, und die für externe Nutzer unsichtbar bleiben.

Benutzerrechte

Eine integrierte Benutzerverwaltung regelt die Zugriffs- und Bearbeitungsrechte jedes einzelnen Benutzers – sowohl bezogen auf bestimmte Funktionen als auch hinsichtlich einzelner Kapitel (Kategorien).

Workflows

In einem einfachen Workflow lässt sich festlegen, welche Status ein Topic bis zur Freigabe und damit bis zur Anzeige durchlaufen muss – z. B. Draft, In Review, Published.

Team-Mitgliedern lassen sich Aufgaben zuweisen, wie z. B. das Review bestimmter Topics. Aufgaben lassen sich mit Fälligkeiten (Terminen) versehen.

Benachrichtigungen

Abhängig von bestimmten Ereignissen im Projekt benachrichtigt Document360 automatisch die betroffenen Team-Mitglieder per E-Mail oder über andere Kanäle, wie z. B. Slack.

Versionierung

Zu jedem Topic protokolliert Document360 in seiner Datenbank, wer wann welche Änderungen an dem Topic vorgenommen hat.

Bei Bedarf lassen sich jederzeit zwei beliebige Versionsstände vergleichen und ein früherer Stand wiederherstellen. Allerdings lässt sich immer nur das komplette Topic zurücksetzen, nicht lediglich ausgewählte Abschnitte.

Soll eine neue Produktversion dokumentiert werden, parallel dazu jedoch die Dokumentation für die vorherige Version verfügbar bleiben, muss dafür im System ein neuer Workspace angelegt werden. Dies kann zusätzliche Lizenzkosten verursachen. Beispiel: Version 1 eines Produkts wurde durch Version 2 ersetzt, es gibt jedoch noch Kunden, die weiterhin Version 1 nutzen und Zugriff auf die Dokumentation zu Version 1 benötigen.

Der letzte Stand der Dokumentation kann in den neuen Workspace kopiert werden und führt dort ab sofort sein Eigenleben. Eine Funktion, Änderungen zwischen mehreren Workspaces abzugleichen (Merging), gibt es nicht.

Feedback-Funktion und Analytics

Optional ist Document360 so konfigurierbar, dass unterhalb jedes Topics eine Frage erscheint, ob das Topic hilfreich war („Thumbs up/down“).

Nach Anklicken von Ja oder Nein können Nutzer in einem zweiten Schritt abhängig von ihrer Antwort noch weiteres Feedback geben, z. B. über Auswahlfelder und freie Texteingabe.

Im Backend von Document360 lässt sich das Feedback später komfortabel anzeigen und auswerten. Zusätzlich geben automatisch erstellte Statistiken u. a. darüber Auskunft, nach welchen Stichwörtern Nutzer besonders häufig suchen und welche Seiten Benutzer am häufigsten besuchen. Basierend auf diesen Daten lässt sich die Dokumentation dann mit der Zeit schrittweise optimieren und gezielt am aktuellen Bedarf ausrichten.

Datenübernahme bestehender Inhalte

Die Migration bestehender Inhalte erfolgt ausnahmslos über einen Import im Word-Format *.docx, vom Einfügen einzelner Topics über die Zwischenablage als Markdown oder HTML einmal abgesehen.

Sofern Altdaten noch nicht im Word-Format vorliegen, müssen diese Daten im ersten Schritt nach *.docx konvertiert werden. Document360 kann diese Word-Dateien dann auf Wunsch an den in den Dateien enthaltenen Überschriften in einzelne Topics aufsplitten.

Anpassbarkeit

Im Rahmen der vorgegebenen Grundstruktur können Sie das Erscheinungsbild einer mit Document360 bereitgestellten Onlinedokumentation recht flexibel an Ihr hauseigenes Design anpassen. Die meisten Einstellungen erfolgen über Dialoge in der Benutzeroberfläche und erfordern somit keine speziellen Vorkenntnisse. Weitere Konfigurationen, wie beispielsweise das Erstellen individueller Seiten-Header und -Footer, sind möglich durch das Einfügen von eigenem HTML- und CSS-Code.

Für die individuelle Formatierung der Inhalte, oder um besondere Funktionen in eine Onlinedokumentation einzubauen, können Sie bei Bedarf projektweit eigenen CSS- und JavaScript-Code ergänzen. Wenn Sie mit dem WYSIWYG-Editor arbeiten und in die HTML-Code-Ansicht wechseln, können Sie auch innerhalb eines bestimmten Topics individuellen Code einfügen.

Für die PDF-Ausgabe sind die Einstellmöglichkeiten sehr begrenzt.

API

Über eine RESTful API können Sie bei Bedarf aus anderen Programmen auf Ihre mit Document360 gepflegte Dokumentation zugreifen.

Insbesondere können Sie:

• den Inhalt eines Artikels abrufen
• Artikel hinzufügen, bearbeiten, veröffentlichen und löschen
• Kategorien verwalten
• Inhalte exportieren und importieren
• die Referenzdokumentation Ihrer eigenen API aktualisieren und veröffentlichen

Fazit

Document360 ist eine mit minimaler Einarbeitungszeit und wenig Anpassungsaufwand unmittelbar produktiv nutzbare Lösung zum kollaborativen Erstellen einer modernen Onlinedokumentation – einschließlich Hosting, Feedback- und Analytics-Funktion.

Hervorzuheben sind außerdem:

• Widget zum kontextabhängigen Einbetten der Dokumentation in eine Web-Applikation
• Unterstützung für API-Dokumentation und Kombinationsmöglichkeit zwischen automatisch generierten und redaktionell in Document360 gepflegten Inhalten
• Möglichkeit, für Nutzer Login-abhängig den Zugriff auf bestimmte Informationen einzuschränken
• leistungsfähige Suchfunktion mit Fehlertoleranz und Filtern

Nicht unterstützt werden hingegen:

• vordefinierte Absatz- und Zeichenformate
• Dokumentation für mehrere Produktvarianten aus einer Quelle
• Output statischer HTML-Seiten zur Offline-Nutzung

Damit eignet sich Document360 insbesondere für:

• die Dokumentation von Webanwendungen
• Projekte, die von mehreren Autoren kollaborativ erstellt und gepflegt werden
• Projekte, die unter Mitwirkung von Personen entstehen, die nicht viel Zeit für eine Einarbeitung in ein komplexes Redaktionssystem haben
• Projekte ohne Produktvarianten oder Projekte, bei denen alle Produktvarianten mit einer gemeinsamen Dokumentation beschrieben werden können
• Projekte, bei denen eine maschinelle Übersetzung ausreicht, die im Haus durch die Autoren selbst übersetzt werden oder die überhaupt nicht übersetzt werden müssen
• Projekte, in denen keine PDF-Dokumente erstellt werden müssen oder Projekte, in denen PDF-Dokumente eine untergeordnete Rolle spielen
• Projekte, in denen eine automatisch generierte API-Dokumentation mit redaktionell gepflegten Inhalten kombiniert werden soll
• Projekte, in denen nicht alle Nutzer Zugriff auf alle Informationen erhalten sollen (z. B. interne Nutzer vs. externe Nutzer)

Preise und Lizenzierung

Je nach benötigtem Funktionsumfang bewegen sich die Grundpreise zwischen rund 149 $ pro Monat und 599 $ pro Monat für ca. 3 bis 10 Autoren.

Darüber hinaus gibt es von Document360 sogar auch eine kostenlose Variante. Hier ist der Funktionsumfang jedoch sehr stark eingeschränkt.

Als SaaS-Lösung ist Document360 sofort produktiv nutzbar, erfordert keine langwierige Implementierung und verursacht keine internen Betriebs- und Wartungskosten.

Hersteller und Lizenzierung: document360.com