Beste Hilfe-Autorensysteme (HAT)

Help Authoring Tools (HAT) sind Programme, die technische Redakteure bei der Gestaltung, Veröffentlichung und Pflege von Software-Hilfedokumentationen unterstützen. Der resultierende Text wird in Erklärungsleitfäden, FAQs, Handbüchern und Hilfedateien verwendet. Sie zielen darauf ab, die Zeit und den Aufwand zu reduzieren, die bei der Erstellung von Unterstützungsmaterialien für Mitarbeiter und Endbenutzer erforderlich sind. Viele Help Authoring Tools (HAT) bieten auch die Funktionalitäten von Wissensdatenbank-Software, die es technischen Redakteuren ermöglicht, eine zentrale Wissensdatenbank zu pflegen und zu aktualisieren, die alle von ihnen erstellten Software-Hilfetexte zu ihrem Produkt enthält. Diese Wissensdatenbank, die oft eine benutzerzugängliche Webseite oder ein Dokument ist, kann aktualisiert werden, sobald technische Redakteure neuen Text oder Bilder hinzufügen. Trotz der Verwendung durch spezialisierte technische Redakteure werden HATs oft als Entwicklungstools betrachtet, da sie Entwicklungsteams ermöglichen, Hilfedokumentationen für ihre bestehenden Softwareprodukte und alle neuen Funktionen, die hinzugefügt werden könnten, zu erstellen und zu pflegen.

Technische Redakteure verwenden Help Authoring Tools, um Software-Hilfedokumente und Online-Hilferessourcen von Anfang bis Ende zu erstellen. Mit diesen Programmen können sie Dokumente schreiben, bearbeiten und exportieren, um sie mit Redakteuren, Administratoren und anderen Kollegen zu teilen. Abhängig vom verwendeten Dokumentationstool können Ersteller sogar Bilder entwerfen oder einfach eine Bildschirmaufnahmefunktion verwenden, um ihren Software-Hilfetext zu ergänzen und die Benutzererfahrung zu bereichern. Wenn die Dokumentation in einem benutzerbereiten Zustand ist, ermöglicht das Help Authoring Tool den Autoren, die Dokumentation digital zu veröffentlichen. In einigen Fällen ermöglichen HATs auch Teams, andere Aspekte der Selbsthilfeerfahrungen ihrer Kunden zu verwalten. Beispielsweise können einige Tools Produktteams ermöglichen, Widgets an verschiedenen Punkten der Benutzerreise zu erstellen und einzubetten, um den Benutzer bei Bedarf zu einer Software-Hilfe-Wissensdatenbank zu führen.

Die meisten HATs ermöglichen es technischen Redakteuren, ihre Software-Hilfedokumentation in einer einzigen Datenbank zu zentralisieren, die dann in verschiedenen Formaten wie HTML, CHM-Hilfedateien, XML, PDFs und mehr exportiert werden kann. Help Authoring Software ermöglicht es technischen Redakteuren auch, ihre bereits vorhandene Softwareprogrammdokumentation zu verwenden und zu aktualisieren, indem sie verschiedene Dateitypen für den Import unterstützt. Dies bietet auch Flexibilität für Autoren, die es vorziehen, ein separates Schreibwerkzeug außerhalb des HAT zu verwenden, da sie den Quelltext einfach importieren können, wenn er fertig ist, und das HAT verwenden können, um das fertige Produkt zu gestalten, zu veröffentlichen und zu pflegen.

Letztendlich helfen HATs Unternehmen dabei, eine einzige Quelle der Wahrheit für die Software-Hilfebedürfnisse ihrer Benutzer zu produzieren, zu ergänzen und zu verwalten. Durch die Straffung des Schreibprozesses und die Bereitstellung nützlicher Funktionen wie Inhaltszusammenarbeit und Dateiimport helfen HATs Teams, technische Dokumentationen, Inhalte für FAQs, Hilfshandbücher und mehr zu erstellen.

Wofür steht HAT?

HAT steht für Help Authoring Tool. Allerdings können HATs über die Dokumentationserstellung hinausgehen, um Teams zu ermöglichen, verschiedene Aspekte der Selbsthilfeerfahrungen ihrer Kunden mit Softwareprogrammen zu verwalten.

Die folgenden sind einige Kernfunktionen innerhalb von Help Authoring Tools (HAT), die Benutzern helfen können, Software-Hilfedokumentationen zu erstellen und zu pflegen:

Textbearbeitung: In ihrer grundlegendsten Form bieten HATs Textbearbeitungsfunktionen zur Erstellung von Software-Hilfedokumentationen. Diese Editoren enthalten oft mehrere Funktionen, um den Help Authoring-Prozess effizienter zu gestalten, wie Vorlagen, automatisierte Stil- und Grammatikvorschläge und mehr. In vielen Fällen fungiert die Benutzeroberfläche eines HATs als vollwertiger Textverarbeitungsprogramm.

Codebearbeitung: Viele HATs enthalten eine Codeansicht, die es Frontend-Webentwicklern ermöglicht, Hilfedokumentationswebseiten zu bearbeiten. Diese Art der Bearbeitung umfasst in der Regel HTML-, CSS- und JS-Codebearbeitungsfunktionen, sodass technische Redakteure Softwaredokumentationen erstellen können, die in einem webbasierten Format anstelle eines Textdokuments vorliegen. Einige Lösungen enthalten auch Funktionen für HTML-Hilfe und Vorschläge, die es Teams erleichtern, Webseiten zu erstellen.

WYSIWYG-Bearbeitung: Viele HATs bieten WYSIWYG-Editoren (What You See Is What You Get), sodass technische Redakteure ohne Erfahrung in der Frontend-Entwicklung Softwaredokumentationswebseiten über eine intuitive visuelle Benutzeroberfläche erstellen und verwalten können. Diese Art von Editoren kann auch hilfreich sein, um schnell nützliche Bilder zur Hilfedokumentation eines Produkts hinzuzufügen.

Dateiimport: HATs ermöglichen es technischen Redakteuren, Quelltext oder Quellcode aus verschiedenen Dateiformaten zu importieren, wie Microsoft Word-Dokumente, CHM-Dateien, HTML-Dateien und mehr. Der Text und die Bilder aus diesen Quelldateien können dann innerhalb des HATs bearbeitet und verwaltet werden, um das gewünschte Ergebnis für die Veröffentlichung zu erzielen.

Inhaltsverwaltung: Während HATs ausdrücklich zur Erstellung und Verwaltung von Software-Hilfedokumentationen verwendet werden, teilen sie in der Regel ähnliche Funktionen mit Content-Management-Systemen (CMS). Wie CMS-Tools ermöglichen HATs Benutzern, Inhaltsprojekte von der Erstellung bis zur Veröffentlichung zu verwalten, zu speichern und zu verfolgen. Der Hauptunterschied besteht darin, dass jedes Inhaltsprojekt speziell mit Software-Erklärungsleitfäden, FAQs, Handbüchern und Hilfedateien zusammenhängt.

Vorlagen und Bibliotheken: Die meisten HATs bieten Vorlagen, die grundlegende Formatierungen und visuelle Layouts für technische Redakteure bereitstellen, auf denen sie arbeiten können. Diese Vorlagen bieten empfohlene Layouts für verschiedene Software-Hilfeformate. Zusammen mit diesen Vorlagen bieten viele HATs Medienbibliotheken, aus denen Autoren Bilder, Motion Graphics und mehr entnehmen können.

Inhaltszusammenarbeit: Help Authoring Software ermöglicht es mehreren technischen Redakteuren, gleichzeitig an denselben Leitfäden und Dokumenten zu arbeiten. Dies optimiert die Kommunikation über Projekte und ermöglicht eine effiziente Produktivität in einer Remote-Umgebung. Die Inhaltszusammenarbeitsfähigkeiten von HATs umfassen Versionskontrollsysteme, was bedeutet, dass Teams historische Änderungen verfolgen und bei Bedarf zu älteren Versionen ihrer Dokumentation zurückkehren können.

Die häufigsten Vorteile von Help Authoring Tools (HAT) umfassen:

Skalierbarkeit: Softwareanbieter müssen ihre Produkte mit einer Vielzahl von Dokumentationen ergänzen, um ihre Benutzer zu leiten. Von einfachen Benutzerhandbüchern bis hin zu komplexen technischen Dokumentationen für APIs muss das Benutzerwissensmanagement ständig berücksichtigt und unterstützt werden, wenn ein Unternehmen seine Produktlinien und Funktionen erweitert. HATs machen diesen Prozess skalierbar und handhabbar, indem sie sowohl bestehende Dokumentationen importieren als auch standardisierte Werkzeuge zur Ergänzung dieser Dokumentationen bereitstellen.

Effizienz: Die meisten HATs zentralisieren die gesamte technische Dokumentation eines Unternehmens, Online-Hilfeinhalte usw. in einer einzigen Quelle. Durch die Speicherung aller Software-Hilfe-Quelldateien in einer zentralen Datenbank erleichtern HATs eine effizientere Wiederverwendung von Inhalten. Technische Redakteure können ihre bestehende Dokumentation einmal verwalten, bearbeiten und ergänzen und dann das HAT verwenden, um zu entscheiden, wo, wann und wie diese Dokumentation präsentiert wird. In einigen Fällen können Teams sogar bedingte Veröffentlichungsstandards festlegen, sodass unterschiedliche Hilfedokumentationen unterschiedlichen Benutzern angezeigt werden. Dies verhindert, dass Teams Zeit mit sich wiederholenden Aufgaben verschwenden, sodass sie sich auf neue Dokumentationen konzentrieren können, anstatt bestehende Inhalte manuell zu verwalten.

Besserer Kundensupport: HATs verbessern in erster Linie die Fähigkeit eines Unternehmens, seinen Kunden hilfreiche Dokumentationen bereitzustellen. Durch die Erstellung benutzerfreundlicher Dokumentationen mit klaren Elementen wie einem Inhaltsverzeichnis, visuellen Hilfsmitteln und mehr, befähigen Unternehmen ihre Benutzer zur Selbsthilfe, anstatt sich auf Kundensupportkanäle zu verlassen. Das Vorhandensein umfassender Selbsthilfesysteme spart Unternehmen Zeit und reduziert die Kosten, die mit der Unterstützung ihrer Kunden verbunden sind.