Help Authoring Tools und Redaktionssysteme für die Technische Dokumentation
Marktüberblick über empfehlenswerte Redaktionssysteme zum Erstellen von Online-Hilfen, Onlinedokumentation und gedruckter oder druckbarer Technischer Dokumentation (PDF).
Informationen zu den angegebenen Preisklassen ● ● ● ● ● ● finden Sie unter Preisklassen.
Klassische Help Authoring Tools
MadCap Flare
Eindeutig kein Werkzeug für Gelegenheitsnutzer, sondern für hauptberufliche technische Redakteure. Hervorragende Single-Source-Publishing-Funktionen. Kann PDF-Dateien erstellen, ohne dass ein externes Textverarbeitungsprogramm erforderlich ist, kann aber auch vollwertige Microsoft Word-Dateien erzeugen. Weitere erweiterte Funktionen sind der DITA-Import (einschließlich Relation Tables), die Möglichkeit, unterschiedliche Strukturen für Online-Hilfen und gedruckte Benutzerhandbücher aus derselben Quelle zu erzeugen, sowie der professionelle Übersetzungsworkflow. Concept Markers erleichtern das Hinzufügen strukturierter themenbezogener Links. Innerhalb browserbasierter Hilfen lassen sich anspruchsvolle Suchfunktionen implementieren. „MadCap Contributor“ bietet eine vereinfachte Benutzeroberfläche für gelegentliche Autoren, wie z. B. Fachexperten oder Korrekturlesende. Das optionale Zusatzprodukt „MadCap Pulse“ bietet Funktionen für die Zusammenarbeit im Team (z. B. Kommentare), und es kann die Aktivität der Leser tracken. Das optionale Zusatzprodukt „MadCap Central“ bietet eine Cloud-basierte Plattform für Inhalts- und Projektmanagement, Hosting, Publishing, Aufgaben- und Benutzerverwaltung sowie Teamzusammenarbeit. Mit „MadCap Capture“ gehört ein vollwertiges Screen Capture Tool ebenfalls zum Lieferumfang.
Preisklasse: ● hoch
https://www.madcapsoftware.com
Flare Plug-ins und Tools
https://www.improvementsoft.com
RoboHelp
Lange Zeit war RoboHelp eindeutig der Marktführer unter den Werkzeugen zur Erstellung von Online-Hilfen. Heute haben einige seiner Konkurrenten aufgeschlossen oder RoboHelp den Rang abgelaufen. Ein interessantes Alleinstellungsmerkmal sind jedoch die dynamischen Filter von RoboHelp, die es ermöglichen, bedingten Text zur Laufzeit anzuwenden. Nachteilig sind fehlende erweiterte Linkfunktionen und die Tatsache, dass das Programm standardmäßig nicht nur Ihr Benutzerverhalten, sondern sogar die von Ihnen erstellten Dateien (den Inhalt) analysiert und Informationen darüber an Adobe sendet. Sie können dies zwar abschalten, müssen es aber manuell tun.
Preisklasse: ● mittel
https://www.adobe.com/products/robohelp.html
Help & Manual 
Sehr effizient und einfach zu bedienen. Die Ausgabe ist in hohem Maße anpassbar, insbesondere auf der HTML-Seite. Zusätzlich zu diversen Hilfeformaten und eBooks kann Help & Manual auch qualitativ hochwertige PDF-Handbücher erstellen, ohne dass dazu ein externes Textverarbeitungsprogramm, wie z.B. Microsoft Word, oder ein externer PDF-Generator, wie z.B. Adobe Acrobat, erforderlich ist. Help & Manual bietet ausgezeichnete Unterstützung für Single-Source-Publishing, einschließlich benutzerdefinierter Builds, Snippets, bedingter Text mit IF THEN ELSE Anweisungen und Variablen. Weitere Profifunktionen sind der XML-basierte Übersetzungsworkflow, die Unterstützung von Team-Authoring und die Möglichkeit zur Integration mit Versionskontrollsystemen. Sie können komplexe Builds entweder über die Befehlszeile ausführen oder Publishing-Tasks einrichten, die verschiedene Dokumente in einem Durchgang erzeugen. Auf diese Weise können Sie zum Beispiel die Online-Hilfe für eine Standard-Version Ihres Produkts, die Online-Hilfe für eine Professional-Version Ihres Produkts und gedruckte Benutzerhandbücher (PDF) für beide Versionen generieren – alles auf Knopfdruck und aus derselben Quelldatei. Ein Screenshot-Tool wird ebenfalls mitgeliefert.
Preisklasse: ● mittel
Beschreibung des Herstellers:
Help+Manual ist ein Single-Source-Help-Authoring- und Content-Management-System für die Bearbeitung durch einen oder mehrere Autoren. Die Arbeit mit Help+Manual ist so einfach wie das Schreiben von Text mit einer Textverarbeitung. Help+Manual skaliert von kleinen bis zu wirklich großen Projekten mit tausenden von Seiten und erstellt Windows-Hilfedateien, Webhelp sowie gedruckte Handbücher und Handbücher im PDF-Format. Versuchen Sie es selbst und laden Sie sich eine Testversion von Help+Manual herunter! Das Schreiben von Hilfen und Handbüchern war noch nie so einfach.
Help & Manual Plug-ins und Tools
https://www.helpandmanual.com/products_hm_pluspack.html
https://www.helpandmanual.com/products_hm_translation_assistant.html
Doc-To-Help
Einzigartig ist, dass Sie verschiedene Editoren für die Bearbeitung Ihrer Inhalte verwenden können: Doc-To-Help's eingebauter WYSIWYG-Editor, Microsoft Word, oder jeder HTML-Editor. Sie können sogar verschiedene Editoren innerhalb ein und desselben Projekts einsetzen. Dies ist besonders interessant, wenn Sie Texte aus verschiedenen Quellen und von verschiedenen Autoren kombinieren. Mit einer umfassenden und einheitlichen Unterstützung für bedingten Text, Variablen und Textschnipsel in allen Editoren bietet das Programm gute Möglichkeiten für Single-Source-Publishing. Weitere Besonderheiten sind die teilweise automatisierte Dokumentation von Quellcode und Programmbibliotheken, eine Doc-To-Help-Komponente, die es Entwicklern ermöglicht, auf einfache Weise ein dynamisches Hilfefenster in die Anwendungsoberfläche einzubetten, und die eingebaute Unterstützung für Team-Authoring. Das Erstellen gedruckter Benutzerhandbücher (oder PDF) erfordert Microsoft Word. Im Gegensatz zu einigen anderen Hilfswerkzeugen kann Doc-To-Help intern keine PDF-Dateien erzeugen.
Preisklasse: ● mittel
HelpStudio
Eines der wenigen Werkzeuge, die eine integrierte Unterstützung für Übersetzungen bieten. Projekte können entweder sofort in HelpStudio übersetzt werden, oder sie werden in XML exportiert, von einem externen Übersetzer mit Hilfe eines Translation-Memory-Tools übersetzt und dann wieder in HelpStudio importiert. Eine weitere interessante Funktion ist die Möglichkeit, eigene Widgets zu erstellen, was das Anlegen und Bearbeiten komplexer Inhalte wie Dropdown-Abschnitte, Miniaturbilder, Notizfelder, Includes usw. vereinfacht. Gute Single-Source-Publishing-Funktionen; die PDF-Ausgabe kann eine andere Struktur haben als die HTML-Ausgabe. Das Layout der erstellten PDF-Dateien kann jedoch nicht so flexibel angepasst werden wie bei einigen anderen Tools zur Erstellung von Hilfesystemen. Ausgezeichneter HTML-basierter Editor mit voller Code-Kontrolle.
HelpStudio ist ein Produkt von Contiem.
Preisklasse: ● mittel
HelpNDoc
Unkompliziertes Hilfeerstellungswerkzeug, das CHM-, WebHelp- (HTML), Qt-Hilfedateien, ePub- und Kindle- (MobiPocket) eBooks, anpassbare PDF- und Word-Dateien sowie Markdown-Dateien erstellt. Unterstützt Styles, Variablen und bedingten Inhalt. Styles sind auch im Word-Export enthalten, was diesen vollkommen flexibel nutzbar macht. Templates können bearbeitet werden. Exportiert auch Codeschnipsel zum Aufrufen der Online-Hilfe (C/C++, Fortran, Delphi/Pascal, Power Basic, Visual Basic; weitere Sprachen lassen sich über die integrierte Vorlagen-Engine hinzufügen).
Siehe auch Ausführliche Rezension zu HelpNDoc.
Preisklasse: ● niedrig
Beschreibung des Herstellers:
HelpNDoc ist ein einfach zu bedienendes und dennoch leistungsfähiges Hilfeerstellungswerkzeug, das verschiedene Dokumentationsformate aus einer einzigen Quelle erzeugen kann: HTML- und CHM-Hilfedateien, PDF- und Word-Handbücher, ePub- und Kindle-eBooks, Markdown-Dokumente, plattformübergreifende Qt-Hilfedateien sowie mobile Webseiten für iPhone und Android.
Vergessen Sie aufgeblähte Benutzeroberflächen und unverständliche Hilfeerstellungswerkzeuge: HelpNDoc bietet die fortschrittlichsten Funktionalitäten in ihrer einfachsten Form. Das Erstellen von HTML- und CHM-Hilfedateien ist normalerweise ein mühsamer Prozess, aber dank HelpNDoc werden Sie überrascht sein, dass es Spaß macht! Das Erstellen von Word- und PDF-Handbüchern, ePub- und Kindle-eBooks sowie Qt-Hilfe ist ebenso einfach. Die beeindruckende Template-Engine macht es Ihnen möglich, auch iPhone- oder Android-spezifische Dokumentationswebseiten im Handumdrehen zu erstellen.
Sie wissen, wie Sie den Windows-Explorer und Ihr bevorzugtes Textverarbeitungsprogramm benutzen? Dann wissen Sie bereits, wie man HelpNDoc benutzt: es ist kinderleicht! Dazu kommen noch viele weitere leistungsstarke Funktionen wie z. B. eine Live-Rechtschreibprüfung in einer vollständigen WYSIWYG-Umgebung (What You See Is What You Get), eine hochmoderne Vorlagen-Engine, eine integrierte Medienbibliothek, ein Projekt-Analysator. Jetzt können Sie sich langsam vorstellen, wie schnell und einfach es für Sie sein wird, Ihre nächste Hilfedatei zu erstellen und wie professionell diese aussehen wird.
OfficeHelp
Verwendet Microsoft Word zur Bearbeitung der Dokumente. Viele nützliche Funktionen ergänzen oder optimieren die eingebaute Funktionalität von Microsoft Word, wie z. B. Marginalien, bedingter Text, problemlose Handhabung nummerierter Listen und eine komfortable Querverweisfunktion. Die erstellten Online-Hilfedateien verwenden ein registerbasiertes Informationsdesign, das es ermöglicht, auch bei umfangreichen Dokumenten ein flaches und einfaches Inhaltsverzeichnis zu erstellen.
Preisklasse: ● mittel
https://dokay.de/en/officehelp-en
Beschreibung des Herstellers:
OfficeHelp: Ein schlankes und smartes Content-Managementsystem.
OfficeHelp ergänzt Microsoft Word mit Funktionen eines Content-Managementsystems.
* Single Source Publishing – In einem Word-Dokument steht alles drin.
* Mediengerechtes Schreiben – Einfach über unterschiedliche Farben und nicht über XML-Code.
* Modernes Webdesign – Ob Tablet, Smartphone oder PC – die Darstellung der Inhalte passt sich stets perfekt an.
* Kontextsensitive Einsprünge – Für viele Software-Dokumentationen ein Muss. Für OfficeHelp ein Leichtes.
* Multimedia inklusive – Filme und andere Medien können leicht integriert werden.
HelpSmith
Bietet alle grundlegenden Funktionen, die man von einem professionellen, modernen XML-basierten Help Authoring Tool erwartet, wie z. B. die vollständige Unterstützung von Formatvorlagen und Templates, Variablen, Bedingungen, eine optionale Befehlszeilenschnittstelle und die Möglichkeit, mit externen Versionskontrollsystemen und Translation-Memory-Tools zu arbeiten. Erstellt alle gängigen Ausgabeformate, wie WebHelp, CHM, PDF und Word. Kann Bildschirmaufnahmen mit automatischen Referenzbeschriftungen versehen.
Preisklasse: ● niedrig
Beschreibung des Herstellers:
HelpSmith ist ein funktionsreiches XML-basiertes Hilfeerstellungswerkzeug, mit dem Sie HTML-Hilfedateien (CHM), Web-Hilfesysteme (WebHelp mit einem vollständig responsiven Layout), gedruckte Handbücher, PDF- und MS Word-Dokumente aus einer einzigen Quelle erstellen können. Zu den grundlegenden Funktionen von HelpSmith gehören eine Textverarbeitung mit einer Live-Rechtschreibprüfung, dynamische Formatvorlagen, TOC- und Index-Editoren, Vorlagen, Variablen, anpassbare Themes für die Web-Hilfe, ein Medien-Repository zur Verwaltung von Bildern und Videos, und vieles mehr.
Für erfahrene technische Redakteure bietet HelpSmith die Möglichkeit, JavaScript- und CSS-Styles zu verwenden, Build-Tags, um verschiedene Versionen der gleichen Hilfedatei zu erzeugen, sowie ein Project-Merge-Tool, das für die Übersetzung oder für die Zusammenarbeit im Teams verwendet werden kann.
Darüber hinaus können Sie mit dem eingebauten Bildwerkzeug Screenshots aufnehmen, Bilder mit Anmerkungen versehen und Topic-Entwürfe für die Beschreibung von Benutzeroberflächen erstellen. Hervorzuheben ist, dass HelpSmith es Ihnen ermöglicht, Inhalte aus bestehenden Dokumenten zu importieren, wie aus CHM, MS Word, RTF, HTML und einfachen Textdateien. Zu guter Letzt bietet HelpSmith eine moderne Benutzeroberfläche mit einer flachen Lernkurve und verfügt über Beispielprojekte, die Ihnen helfen werden, schnell mit dem Produkt zu arbeiten.
Doc-O-Matic Author
Trotz des vergleichsweise niedrigen Preises sind alle wichtigen Funktionen vorhanden, die Sie von einem professionellen Hilfe-Autorentool erwarten können: Bedingter Text, Text-Schnipsel und Variablen, vollständige Kontrolle über Layout und Formatierung sowohl in HTML als auch in PDF, Unicode-Unterstützung, XML-Quelldateien und die Erstellung von PDF-Handbüchern mit vollem Funktionsumfang, ohne dass dazu ein zusätzliches Tool oder ein Konverter erforderlich ist.
Preisklasse: ● niedrig
Help Crafter
Einfaches Werkzeug zur Erstellung von Hilfen für den Mac.
Preisklasse: ● niedrig
DA-HelpCreator
Einfacher kommerzieller Generator für statische Websites, der Markdown-Dateien verwendet. Anders als die meisten Open-Source-Hilfegeneratoren, die Markdown verwenden, verfügt dieses Tool über einen eigenen eingebauten Editor und kann mit Hilfe eines Windows-Setup-Programms leicht installiert werden. Erzeugt statische HTML-Seiten oder CHM-Dateien. Kein Export in PDF oder andere druckbare Formate. Keine erweiterten Funktionen.
Preisklasse: ● niedrig
CHM Editor
WYSIWYG-Editor zum Bearbeiten von CHM-Dateien. Unterstützt auch die maschinelle Übersetzung vorhandener CHM-Dateien. Zusätzlich zu CHM kann die Professional-Version nach PDF, DOC und HTML exportieren.
Preisklasse: ● niedrig
Tools zur teilweise automatisierten Hilfeerstellung
Die folgenden Tools können halbautomatisch einige einfache Dokumentationen erstellen. Sie tun dies, indem sie Screenshots der Software erstellen, Tastatureingaben oder Mausbewegungen aufzeichnen oder die internen Ressourcendateien einer Anwendung analysieren. Dieser Ansatz erreicht zwar in der Regel nicht die gleiche Qualität wie eine manuell erstellte Dokumentation, kann aber ein effizienter Weg sein, um eine vorläufige Dokumentation zu erhalten oder Dokumente zu erstellen, die z. B. eine Schulung ergänzen. Außerdem können Sie die Ausgabe als Ausgangspunkt verwenden und später weitere Informationen ergänzen.
Dr. Explain
Erfasst automatisch alle Fenster eines Programms, fügt allen in den einzelnen Fenstern sichtbaren Bedienelementen Beschreibungen (Callouts) hinzu, beschriftet diese Callouts automatisch und erstellt dann ein vollständig verlinktes Online-Hilfesystem. Alles, was Sie tun müssen, ist, den automatisch hinzugefügten Text zu überarbeiten und, wo nötig, einige detailliertere Beschreibungen zu ergänzen. Zusätzlich zu CHM und WebHelp können Sie auch ein gedrucktes Benutzerhandbuch (PDF- oder RFT-Format) auf derselben Textbasis erstellen. Zusammen mit seiner Technical-Writing-Plattform TiWri unterstützt Dr. Explain auch die Zusammenarbeit im Team (nur Version „Ultimate“).
Preisklasse: ● mittel
ClickLearn
Zeichnet in gängiger Unternehmenssoftware einen Arbeitsablauf auf und wandelt die Aufzeichnung in mehrsprachige Lernmaterialien um, wie z. B. schriftliche Anleitungen, Video-Walk-Throughs, Simulationen und Bildschirmassistenten. Funktioniert zum Beispiel mit SAP, Oracle, IFS, Microsoft Dynamics und Microsoft Office, aber auch mit benutzerdefinierten Windows- und Webanwendungen.
Preisklasse: ● hoch
https://www.clicklearn.com/go/indoition
Beschreibung des Herstellers:
ClickLearn ist die marktführende Lösung für die Erstellung von Benutzeranleitungen, E-Learning und Prozessvideos für Unternehmenssoftware.
ClickLearn automatisiert die Erstellung Ihrer geschäftskritischen Walk-Throughs und spart Ihnen 80 % der Zeit, die Sie derzeit für die manuelle Erstellung für Dynamics 365|BC|F&O|CE und die meisten Ihrer anderen IT-Systeme aufwenden.
Die ClickLearn-Lösung produziert Ihre Walk-Throughs in acht verschiedenen Formaten aus einer einzigen Quelle, einschließlich schriftlicher Dokumentation, praktischer Übungen, Videos mit automatischen Effekten und Sprachaufnahmen. Darüber hinaus verfügt ClickLearn über einen virtuellen Assistenten, der die Anwender im Live-System führt.
Zeichnen Sie einfach Ihren Arbeitsprozess in Dynamics auf. Mit einem Klick produziert ClickLearn Ihre Walk-Throughs in allen Formaten und in mehr als 45 Sprachen und 135 Dialekten. Es erstellt ein komplettes E-Learning-Portal mit vollständiger Nachverfolgung und Bewertung und aktualisiert Ihre Arbeitsanweisungen, wenn Sie Ihre Dynamics-Plattform aktualisieren – ohne manuellen Aufwand Ihrerseits.
Help Generator
Enthält ein „Help Capture Tool“, das automatisch Themenseiten für jeden Teil einer Windows-Benutzeroberfläche erzeugt. Viele allgemeine Funktionen für die Hilfeerstellung sind ebenfalls verfügbar, sodass diese Software eigentlich eine Mischung ist aus einem Tool für die schnelle Hilfeentwicklung und einem herkömmlichen Tool für die Hilfeerstellung.
Preisklasse: ● niedrig
Scribe
Zeichnet auf, was Sie auf dem Bildschirm tun, macht automatisch Bildschirmfotos der Schritte und erstellt schließlich eine einfache, druckbare Anleitung des Prozesses.
Preisklasse: ● niedrig
ScreenSteps
Ermöglicht die Aufnahme von Screenshots einer Software und die einfache Erstellung von Schritt-für-Schritt-Anleitungen auf der Grundlage dieser Bilder. Ändert sich die dokumentierte Software, können die Bildschirmfotos mit minimalem Aufwand aktualisiert werden. Besonders nützlich zum Erstellen aufgabenbezogener Dokumentation.
Preisklasse: ● hoch
Flowshare
Erstellt Schritt-für-Schritt-Anleitungen für Software, indem die auf dem Bildschirm ausgeführten Aktionen erfasst werden.
Preisklasse: ● mittel
datango
Erstellt aus einer Reihe von Bildschirmaufnahmen Screencasts, interaktive Tutorials und auch gedruckte Dokumentationen.
Preisklasse: ● keine Preise veröffentlicht
Epilogue Opus
Zeichnet die in einem Programm durchgeführten Handlungen auf, erstellt daraus eine Dokumentation in verschiedenen Ausgabeformaten und stellt die Informationen den Benutzern zur Verfügung.
Preisklasse: ● keine Preise veröffentlicht
https://www.epiloguesystems.com
iorad
Erstellt Online-Tutorials auf der Grundlage von Screenshots. Es gibt auch eine kostenlose Version für öffentliche Tutorials.
Preisklasse: ● hoch
DokuTool
Ermöglicht das Erstellen einfacher, kurzer Anleitungen auf der Grundlage kommentierter Screenshots, was insbesondere für Supportzwecke eine effiziente Lösung sein kann. Kann nach HTML und PDF exportieren.
Preisklasse: ● niedrig
https://www.horland.de/dokutool.html
Hilfe-Konverter für Word, FrameMaker und Google Docs Dokumente
Die folgenden Help-Authoring-Tools verwenden Microsoft Word oder FrameMaker zur Bearbeitung der Texte oder konvertieren bestehende Word- oder FrameMaker-Benutzerhandbücher in Online-Hilfen.
WebWorks ePublisher
Einfach zu bedienen, unübertroffen in der Leistung, aber auch im Preis. Verfügbar in Versionen für Microsoft Word, FrameMaker und DITA-XML. Mit den entsprechenden Lizenzen ist es sogar möglich, gemeinsame Online-Hilfen aus verschiedenen Quellformaten zu generieren. Hohe Flexibilität bei geringem Anpassungsaufwand. Kann auch mit unübersichtlich formatierten Dokumenten verhältnismäßig gut umgehen.
Preisklasse: ● mittel
Adobe FrameMaker
FrameMaker selbst verfügt über einige gute Exportoptionen für die Erstellung von Online-Hilfen.
Preisklasse: ● mittel
Mif2Go
Konvertiert FrameMaker-Dateien in kompilierte Online-Hilfe (CHM), browserbasierte Hilfe (WebHelp), DITA und Microsoft Word. Ziemlich komplexe Installation und Anpassung erforderlich. Verwendet eine proprietäre „Document Coding Language“ (DCL) für die Konfiguration. Mif2Go ist vor allem dann interessant, wenn Sie benutzerdefinierte Konvertierungen benötigen, die von bestehenden Konvertern nicht angeboten werden, oder wenn Sie eine Konvertierung eng in einen bestimmten Produktionsprozess integrieren müssen.
Preisklasse: ● kostenlos (Freeware)
DocxManager
Website-Generator und Dokumentenmanager für Word-Dokumente. Ermöglicht es Ihnen, Teile eines langen Texts als separate Dokumente zu verwalten und zu bearbeiten, und fügt diese Teile dann zu einem einzigen zusammen.
Preisklasse: ● niedrig
Nocode
Generiert eine Dokumentations- oder allgemeine Website aus Dokumenten auf Google Docs.
Preisklasse: ● mittel
Help Producer
Fügt lediglich eine kleine Symbolleiste zu Microsoft Word hinzu. Help Producer ist jedoch überraschend leistungsfähig und kann nahtlos in Word-basierte Arbeitsabläufe integriert werden. Umfangreiche Anpassungsmöglichkeiten ( Templates, Formatvorlagen, Themes). Mit dem COM-Scripting-Objektmodell können Sie die Ausgabe steuern und komplexe Aufgaben automatisieren.
Preisklasse: ● mittel
https://www.mgtek.com/helpproducer
WordToHelp
Konvertiert Microsoft Word Dokumente (Doc, Docx) in CHM und in WebHelp.
Preisklasse: ● niedrig
http://www.softany.com/wordtohelp/
Doc Converter Pro
Konvertiert Word-Dateien oder PDF-Dateien in HTML-Dateien (erstellt aber kein Hilfesystem aus diesen HTLM-Dateien). Über Vorlagen können Sie steuern, wie die Dokumente konvertiert werden.
Preisklasse: ● niedrig
chmProcessor
Erzeugt kompilierte Hilfe (CHM), JavaHelp oder browserbasierte HTML-Hilfe (WebHelp) aus Microsoft Word Dateien. Teilt die Quelldokumente anhand von Überschriftenformaten auf.
Preisklasse: ● kostenlos (Open Source)
https://chmprocessor.sourceforge.net
NüHelp
Einfacher Konverter zum Umwandeln von Microsoft Word- und HTML-Dateien in eine CHM-Hilfedatei.
Preisklasse: ● kostenlos (Open Source)
https://sourceforge.net/projects/nuhelp/
Mammoth .docx to HTML converter
Aims at producing simple and clean plain HTML files from *.docx files.
Preisklasse: ● kostenlos (Open Source)
https://github.com/mwilliamson/mammoth.js
Reine HTML- und CHM-Compiler und -Konverter
HTML Help Workshop
Microsofts Compiler und grundlegendes Bearbeitungswerkzeug für das kompilierte Microsoft-Hilfeformat (CHM).
Preisklasse: ● kostenlos (Freeware)
https://www.microsoft.com/downloads/ (search for “help workshop”)
XMLmind Web Help Compiler (whc)
Konvertiert einen Satz statischer XHTML-Seiten in eine Webhilfe.
Preisklasse: ● kostenlos (Open Source)
https://www.xmlmind.com/ditac/whc.shtml
chmProcessor
Erzeugt kompilierte Hilfe (CHM), JavaHelp oder browserbasierte HTML-Hilfe (WebHelp) aus Microsoft Word-Dateien oder aus HTML-Dateien. Teilt die Quelldokumente an Stellen auf, an denen Überschriftenformate verwendet wurden.
Preisklasse: ● kostenlos (Open Source)
https://chmprocessor.sourceforge.net
Precision Helper
Kompiliert eine CHM-Datei mit vollem Funktionsumfang aus einem Satz von HTML-Dateien. Kann auch verwendet werden, um eine einfache browserbasierte Hilfe aus demselben Satz von Dateien zu erstellen und um mehrere HTML-Dateien in eine einzige HTML-Datei zusammenzuführen. Diese einzelne HTML-Datei kann dann in eine Textverarbeitung importiert werden, um ein gedrucktes Benutzerhandbuch aus derselben Quelle zu erstellen. Klare, moderne Benutzeroberfläche. Unterstützung für kontextabhängige Hilfe und Index-Stichwörter. Verschiedene nützliche Projektverwaltungsfunktionen.
Preisklasse: ● kostenlos (Freeware)
http://www.be-precision.com/products#helper
HTML Executable
Erzeugt eigenständige Desktop-EXE-Anwendungen aus Websites oder aus einer beliebigen Gruppe von HTML-Seiten und verknüpften Mediendateien. Kann zum Beispiel verwendet werden, um eine browserbasierte Hilfe (WebHerlp) in eine ausführbare Datei zu konvertieren. Ermöglicht es, für den Zugriff auf Informationen einen Lizenzschlüssel zu verlangen.
Preisklasse: ● niedrig
eWriter Creator
Kompiliert mehrere HTML-Dateien in eine einzige ausführbare Datei, die z. B. als Ersatz für eine CHM-Datei dienen kann.
Preisklasse: ● kostenlos (Freeware)
https://www.helpandmanual.com/ewriter/
Nativefier
Erstellt eine Desktop-Anwendung aus einer beliebigen Website (z. B. einer WebHelp). Für Windows, Linux und Mac.
Preisklasse: ● kostenlos (Open Source)
https://github.com/nativefier/nativefier
Asciidoctor
Textverarbeitung und Publishing-Toolchain zur Konvertierung von AsciiDoc-Inhalten nach HTML5, DocBook und in andere Formate.
Preisklasse: ● kostenlos (Open Source)
PDFreactor
Erstellt automatisch PDF-Dateien aus HTML- und XML-Input. Verwendet CSS für Seitenlayout und Formate.
Preisklasse: ● hoch
Softany CHM to PDF Converter
Konvertiert CHM-Dateien in PDF-Dateien einschließlich Deckblatt, Inhaltsverzeichnis, Kopf- und Fußzeile, Seitenzahl usw.
Preisklasse: ● niedrig
Hilfetools mit Schwerpunkt Code- und API-Dokumentation
Document! X
Automatisiert den Prozess der Erstellung und Pflege der Dokumentation, insbesondere für komplexe Komponenten oder XSD-Schemas. Hoher Grad an Automatisierung und Flexibilität. Übersetzungen in Fremdsprachen lassen sich entweder mit Hilfe eines integrierten Übersetzungseditors oder über XML-Export/Import vornehmen.
Document! X ist ein Produkt von Contiem.
Preisklasse: ● mittel
Doc-O-Matic Professional
Professionelles Dokumentationswerkzeug, insbesondere für die Quellcodedokumentation und für Entwicklerdokumentation. Die HTML-Ausgabe ist in hohem Maße anpassbar. Gute Unterstützung für Single Source Publishing. Kann auch hochwertige PDF-Handbücher erstellen.
Preisklasse: ● mittel
GhostDoc
Erzeugt korrekt formatierte Methoden- und Typdokumentation aus Quellcodekommentaren. Ermöglicht das Bearbeiten der Dokumentation im WYSIWYG-Modus, wobei die Änderungen in die XML-Dokumentation im Code übernommen werden. Die GhostDoc Pro Enterprise Edition enthält außerdem eine Funktion, mit der Sie auch konzeptuelle Inhaltsseiten in Ihre Hilfen einfügen können. Die Ausgabe erfolgt in verschiedenen Online-Formaten. Die integrierte Rechtschreibprüfung kann sowohl Ihre Kommentare als auch Ihren Code auf Rechtschreibfehler überprüfen.
Preisklasse: ● niedrig
West Wind HTML Help Builder
Obwohl dieses Tool seine Stärken vor allem bei der Dokumentation von Quellcode und Programmbibliotheken zeigt, erfüllt es auch die Anforderungen von Personen, die Endbenutzerdokumentation erstellen. Unterstützt unterschiedliche Informationstypen und Vorlagen und bietet Ihnen volle Kontrolle über den generierten HTML-Code. Sie können auch saubere Microsoft Word Dokumente erstellen, einschließlich Absatz- und Zeichenformaten. Ein weiterer Vorteil ist die integrierte Unterstützung für mehrere Benutzer. Ein großer Nachteil des Programms ist, dass es keinen bedingten Text und keine Textvariablen unterstützt.
Preisklasse: ● mittel
VSdocman
Direkt in Visual Studio integriert. Kann automatisch Namespaces, Typen und deren Elemente sowie Dokumentationskommentare in Ihrem Code lesen und sie in MSDN-ähnliche Dokumentation umwandeln. Zusätzlich können Sie auch Ihre eigenen Topics hinzufügen und bearbeiten. Für erweiterte Bearbeitungen und Weiterverarbeitung können Sie optional nach Help & Manual (ein anderes Help Authoring Tool) und nach XML exportieren.
Preisklasse: ● niedrig
Documentation Insight
Lösung für Delphi source code documentation.
Preisklasse: ● niedrig
Stoplight
Erstellt automatisch Dokumentation aus OpenAPI-Dateien. Diese Dokumentation kann Code-Beispiele in verschiedenen Programmiersprachen enthalten, in Markdown geschriebene Anleitungen, eingebettete Testfunktionen sowie sowohl öffentliche als auch private Dokumentation mit granularen Rollen und Berechtigungen.
Preisklasse: ● divers
https://stoplight.io/api-documentation
DocFX
Erstellt eine statische Website, die sowohl konzeptionelle Dokumentation aus Markdown-Dateien enthält als auch API-Dokumentation aus .NET-Quellcode und Quellcode-Kommentaren. Anders als viele ähnliche Tools auch unter Windows lauffähig.
Preisklasse: ● kostenlos (Open Source)
https://dotnet.github.io/docfx/
Sphinx
Entwickelt für die Dokumentation von Python-Projekten und C/C++-Projekten. Ausgabeformate sind HTML (WebHelp), Windows HTML Help (CHM) und LaTeX für druckbare PDF-Versionen.
Preisklasse: ● kostenlos (Open Source)
Read the Docs
Transformiert und hostet in reStructuredText oder Markdown geschriebene Dokumentation mit Hilfe von Sphinx. Fügt verschiedene erweiterte Funktionen für den professionellen Einsatz hinzu.
Preisklasse: ● hoch
Microsoft Sandcastle
Erzeugt Dokumentation im MSDN-Stil durch Scannen von Quellcode-Assemblies. Integriert optional auch XML-Dokumentationskommentare.
Preisklasse: ● kostenlos (Freeware)
Slate
Hilft Ihnen bei der Erstellung von gut aussehender API-Dokumentation auf der Grundlage von Markdown. Zu den Funktionen gehören ein hervorragendes Navigationsmenü und Syntaxhervorhebung von Codebeispielen. Dokumentation und Codebeispiele können nebeneinander angezeigt werden. Wenn Sie Codebeispiele in verschiedenen Programmiersprachen bereitstellen, können Sie Registerkarten zum Umschalten zwischen diesen Sprachen hinzufügen.
Preisklasse: ● kostenlos (Open Source)
https://github.com/slatedocs/slate
Swagger UI
Erzeugt automatisch die in einer Swagger-Spezifikation beschriebene Dokumentation. Swagger2Markup kann verwendet werden, um diese Dokumentation auch mit manuell geschriebener Dokumentation zu kombinieren.
Preisklasse: ● kostenlos (Open Source)
https://github.com/Swagger2Markup/swagger2markup
Docbox
Erzeugt REST-API-Dokumentation in einem zweispaltigen Layout aus Markdown-Dateien.
Preisklasse: ● kostenlos (Open Source)
https://github.com/tmcw/docbox
DapperDox
Kombiniert API-Dokumentation mit in Markdown geschriebener Dokumentation.
Preisklasse: ● kostenlos (Open Source)
agilo
Erstellt API-Dokumentation aus Daten, die im Blueprint Markdown-basierten Dokumentenformat geschrieben wurden. Verschiedene Themes werden mitgeliefert.
Preisklasse: ● kostenlos (Open Source)
https://github.com/danielgtaylor/aglio
Javadoc
Erzeugt API-Dokumentation im HTML-Format aus Doc-Kommentaren im Quellcode.
Preisklasse: ● kostenlos (Freeware)
https://www.oracle.com/java/technologies/javase/javadoc.html
ReDoc
Erzeugt Dokumentation aus OpenAPI- (Swagger-) Definitionen.
Preisklasse: ● kostenlos (Open Source)
https://github.com/Redocly/redoc
TypeDoc
Dokumentationsgenerator für TypeScript-Projekte.
Preisklasse: ● kostenlos (Open Source)
Doxygen
Dokumentationssystem für C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP und C#.
Preisklasse: ● kostenlos (Open Source)
VBDoxygen
Visual-Basic-Add-In, das VB-Code in eine Java-ähnliche Syntax für die Verarbeitung durch Doxygen umwandelt.
Preisklasse: ● kostenlos (Open Source)
https://sourceforge.net/projects/vbdoxygen/
ROBODoc
Erstellt Quellcode-Dokumentation durch Extrahieren von Kommentaren aus Shell-Skripten und Quellcode in C, C++, Fortran, Perl, Assembler, DCL, DB/C, Tcl/Tk, Forth, Lisp, COBOL, Occam, Basic, HTML, Clarion und jeder anderen Sprache, die Kommentare unterstützt.
Preisklasse: ● kostenlos (Open Source)
https://rfsber.home.xs4all.nl/Robo/index.html
apiDoc
Erzeugt Dokumentation aus Kommentaren im Quellcode.
Preisklasse: ● kostenlos (Open Source)
ApiGen
Spezialisiert auf Dokumentation für PHP-Projekte.
Preisklasse: ● kostenlos (Open Source)
https://github.com/ApiGen/ApiGen
RDoc
Spezialisiert auf Dokumentation für Ruby-Projekte.
Preisklasse: ● kostenlos (Open Source)
documentation.js
Erzeugt Dokumentation aus Kommentaren im JavaScript-Quellcode (JSDoc-Syntax).
Preisklasse: ● kostenlos (Open Source)
MireDot
REST-API-Dokumentationsgenerator für Java. Nimmt den bereits vorhandenen Java-Code und kompiliert ihn zu einer Dokumentation im HTML- und Word-Format.
Preisklasse: ● mittel
Hologram
Erzeugt automatisch einen Styleguide aus den Kommentaren in einer CSS-Datei. Die Kommentare und damit das Ergebnis lassen sich in Markdown formatieren.
Preisklasse: ● kostenlos (Open Source)
https://trulia.github.io/hologram/
Aigis
Erzeugt automatisch einen Styleguide aus den Kommentaren in einer CSS-Datei. Verwendet Markdown für die Formatierung.
Preisklasse: ● kostenlos (Open Source)
https://aigis-styleguide.github.io/aigis/
styledown
Erzeugt eine CSS-Styleguide aus Kommentaren in einer CSS-Datei.
Preisklasse: ● kostenlos (Open Source)
https://github.com/styledown/styledown
docToolchain
AsciiDoc-Toolchain für die Dokumentation von Software-Architekturen.
Preisklasse: ● kostenlos (Open Source)
https://github.com/docToolchain/docToolchain
Statische Hilfe-Seiten-Generatoren
GitBook
Dokumentationsformat und Toolchain unter Verwendung von Git und Markdown. Bietet Web- und Desktop-Editoren (Markdown oder AsciiDoc), Team-Authoring-Unterstützung sowie Versionskontrolle und Unterstützung für mehrere Sprachen. Kann HTML, PDF, ePub oder Mobi ausgeben. Vorlagen für API-Dokumentation, Wissensdatenbanken und manuelle Dokumentation.
Preisklasse: ● divers
https://github.com/GitbookIO/gitbook
Foliant
Erzeugt HTML, pdf und docx aus Markdown-Quelldateien. Integriert Pandoc für pdf sowie docx und MkDocs für HTML. Unterstützt Snippets und bedingte Inhalte.
Preisklasse: ● kostenlos (Open Source)
https://github.com/foliant-docs/foliant
Jekyll
Allgemeiner Generator für statische Websites, häufig auch verwendet für Dokumentationsseiten.
Preisklasse: ● kostenlos (Open Source)
Documentation theme for Jekyll
Preisklasse: ● kostenlos (Open Source)
https://github.com/tomjoht/documentation-theme-jekyll
CloudCannon
Cloud CMS für Jekyll. Ruft das Repository ab und baut Ihre Website neu auf. Änderungen, die direkt auf CloudCannon vorgenommen werden, werden zurück in das Repository übertragen.
Preisklasse: ● mittel
Forestry
CMS für statische Websites mit Unterstützung für Jekyll, Hugo und Git.
Preisklasse: ● mittel
HUGO
Ein weiterer der beliebtesten Open-Source-Generatoren für statische Websites. Wird manchmal auch für Dokumentations-Websites verwendet.
Preisklasse: ● kostenlos (Open Source)
DAUX.IO
Dokumentationsgenerator, der eine einfache Ordnerstruktur und Markdown-Dateien verwendet, um WebHelp on the fly zu erstellen. Muss auf einem Webserver installiert werden. Die wichtigsten Funktionen sind: Mobilfreundliches responsives Design, automatisches Syntax-Highlighting, Themes, Flat-Design-Stil, SEO-freundliche URLs zum Teilen sowie Unterstützung für Google Analytics und Piwik Analytics.
Preisklasse: ● kostenlos (Open Source)
Doctor
Dokumentations-Server, der eine HTML-Dokumentations-Website aus Markdown-Dateien erstellt, die an einem beliebigen Ort gespeichert sind, z. B. auf Github, Dropbox, Google Drive usw.
Preisklasse: ● kostenlos (Open Source)
https://github.com/minio/doctor
Docusaurus
Tool zum Erstellen einer statischen Dokumentations-Website aus Markdown-Dateien. Kann auch (statische) Blog-Seiten und benutzerdefinierte Seiten enthalten.
Preisklasse: ● kostenlos (Open Source)
Antora
Generator für Dokumentations-Sites mit mehreren Repositories. Kann den (ASCIIDoc)-Inhalt aus mehreren Repositories abrufen und zusammenfassen, um eine Dokumentationsseite zusammenzustellen.
Preisklasse: ● kostenlos (Open Source)
Orchid
Dokumentations-Engine und Generator für statische Websites mit dem Ziel, eine hohe Kompatibilität mit anderen Generatoren für statische Websites zu erreichen. Verschiedene Plugins verfügbar, z. B. für die Integration mit Javadoc.
Preisklasse: ● kostenlos (Open Source)
MkDocs
Generator für statische Websites zur Projektdokumentationen. Die Quelldateien der Dokumentation werden in Markdown geschrieben. Für die Erstellung muss Python auf Ihrem System installiert sein.
Preisklasse: ● kostenlos (Open Source)
Theme for MkDocs
Preisklasse: ● kostenlos (Open Source)
https://squidfunk.github.io/mkdocs-material/
docpress
Erstellt einfache statische Dokumentationsseiten.
Preisklasse: ● kostenlos (Open Source)
docsify
Erstellt einfache statische Dokumentationsseiten.
Preisklasse: ● kostenlos (Open Source)
Markdoc
Erstellt Dokumentationsseiten aus Markdown-Dateien. Erweitert Markdown um eine eigene Syntax für Tags und Anmerkungen.
Preisklasse: ● kostenlos (Open Source)
VuePress
Vue-basierter Generator für statische Websites für inhaltsreiche Websites, z. B. für technische Dokumentationen.
Preisklasse: ● kostenlos (Open Source)
docz
Vollständig mit dem statischen Website-Generator GatsbyJS erstellt und kann somit das riesige Ökosystem von GatsbyJS mit Plugins und Tools nutzen.
Preisklasse: ● kostenlos (Open Source)
Cloud-basierte Redaktionssysteme für Technische Dokumentation (SaaS)
Paligo
Leistungsstarkes, aber dennoch ziemlich einfach zu bedienendes CMS für technische Dokumentation, einschließlich Übersetzungsmanagement. Verfolgt einen strukturierten, themenbasierten Schreibansatz auf der Grundlage einer integrierten DTD (DocBook).
Siehe auch Ausführliche Rezension zu Paligo.
Preisklasse: ● hoch
DocTech
Webbasiertes Content-Management-System.
Preisklasse: ● mittel
https://www.thedoctech.com/en-home/features/
Beschreibung des Herstellers:
Web-Lösung für das Erstellen und Veröffentlichen strukturierter Onlinedokumentation. Sie bietet:
– vollständige Rückverfolgbarkeit der Inhalte
– erweiterte Suche nach Tags und Schlüsselwörtern für das Wiederverwenden von Inhalten
– Automatisiertes Inhaltsverzeichnis und Revisionslisten
– verknüpfte Inhalte mit vollautomatischen und halbautomatischen Aktualisierungen, die ein einfaches Verwalten mehrerer Varianten desselben Dokuments ermöglichen
– benutzerdefinierte Freigabeprozesse für jedes Projekt/jeden Unternehmensbereich
– Zeitsparender Freigabeprozess für Dokumente
– mehrstufige Versionierung
– rollenbasierte Dokumentenversionierung
– Import von und Export in mehrere Formate, einschließlich HTML, DOC und PDF
– benutzerdefinierte automatische Aktualisierungserinnerungen und E-Mail-Benachrichtigungen
– DITA/XML-Konformität
– eingebauter WYSIWYG-Editor
– vom Benutzer anpassbare CSS-Stilvorlagen
– Mehrsprachige Benutzeroberfläche
– Möglichkeit zur Bereitstellung von Inhalten für Unternehmensintranets, wissensbasierte Foren etc.
Damit ist TocTech eine einfache, intuitive und vollständige End-to-End-Lösung für die gemeinsame Nutzung von Inhalten über mehrere Kanäle und die kontinuierliche Einhaltung von Audits.
Manula
Einfach zu verwendendes Tool zum Schreiben von Handbüchern. Erstellt öffentliche und private Online-Handbücher für Desktops, Tablets und Telefone. Erzeugt außerdem auch herunterladbare PDF-Handbücher.
Preisklasse: ● mittel
ClickHelp
Modernes Werkzeug zum Erstellen von Online-Hilfen in einem Webbrowser. Die erstellten Dokumente können in der Cloud des Anbieters gehostet werden. Content Management und Single-Sourcing-Funktionalität zur Erstellung von Online- und gedruckter Dokumentation aus derselben Quelle (PDF, DOCX, EPUB, ODT, RTF, MHT, HTML). Kann vorhandene Hilfedateien aus dem CHM-Format importieren, wobei Styles und Skripte erhalten bleiben. Unterstützt sowohl WYSIWYG- als auch Quellcode-Bearbeitung von Topics.
Preisklasse: ● mittel
Docsie
Onlinedokumentationstool mit einem Schwerpunkt auf Einfachheit und Team-Support. Unterstützt Übersetzungen und verfügt über eine Authoring-Memory-Funktion.
Preisklasse: ● divers
Document360
Einfache Erstellung von Hilfesystemen und Wissensdatenbanken zur Selbsthilfe (keine gedruckte Dokumentation). Bietet einen Markdown-Editor, Unterstützung für Team-Authoring, Versionierung, Analysen, Zugriffsbeschränkungen und mehr.
Preisklasse: ● hoch
MadCap Central
Cloud-basierte Plattform für das Inhalts- und Projektmanagement von Dokumentationsprojekten, die mit dem Desktop-basierten Help Authoring Tool MadCap Flare erstellt wurden. Bietet außerdem einen vereinfachten, webbasierten Editor für Fachexperten und andere Mitwirkende für Reviews und zum Bearbeiten in Flare geschriebener Inhalte (AMS-Lizenz erforderlich).
Preisklasse: ● hoch
https://www.madcapsoftware.com
DeveloperHub
Gehostetes Dokumentationsportal für Produkt- und API-Dokumentation.
Preisklasse: ● hoch
snazzyDocs
Sofort einsatzbereite Help-Site-Lösung mit Basisfunktionen.
Preisklasse: ● mittel
HelpServer
Webbasiertes CMS zum Bereitstellen von Hilfen und Dokumentationen. Unterstützt strukturiertes Authoring und Team-Authoring. Erzeugt verschiedene Ausgabeformate, wie HTML, Video und PDF.
Preisklasse: ● keine Preise veröffentlicht
ReadMe.io
Gehostete Onlinedokumentationslösung mit besonderem Schwerpunkt auf API- und Entwicklerdokumentation.
Preisklasse: ● divers
tomehost
Spezialisiertes Content-Management-System für die Erstellung und Veröffentlichung von Online-Benutzerhandbüchern.
Preisklasse: ● mittel
Typemill
Selbstgehostetes Flat-File-CMS für textbasierte Websites, wie z. B. Dokumentationswebsites.
Preisklasse: ● kostenlos (Open Source)
Grav + Documentation theme for Grav
Open-Source-Flat-File-CMS, das auch zum Erstellen von Dokumentations-Websites verwendet werden kann. Anders als viele ähnliche Website-Generatoren ist Grav besonders einfach einzurichten. Sie müssen nur die Dateien auf einen Webserver kopieren. Es ist keine weitere Installation erforderlich.
Preisklasse: ● kostenlos (Open Source)
https://github.com/getgrav/grav-theme-learn2
Tools mit Schwerpunkt Wissensdatenbanken und FAQ-Seiten
Bei den folgenden Systemen handelt es sich um Wissensdatenbank- und FAQ-Lösungen mit besonderem Schwerpunkt auf Produktwissen für Kunden. (Beachten Sie, dass diese Sammlung keine allgemeinen Wissensdatenbank-Systeme für Geschäfts- und Geschäftsprozesswissen enthält, die intern in einem Unternehmen verwendet werden. Auch enthält diese Sammlung keine allgemeinen Selbsthilfe-Portale und keine Helpdesk-Software).
https://www.zendesk.com/service/help-center/
https://www.helpscout.com/knowledge-base/
https://www.salesforce.com/solutions/small-business-solutions/help-desk-software/
https://www.zoho.com/desk/multibrand-help-center.html
https://freshdesk.com/self-service
https://www.happyfox.com/knowledge-base/
Sie können auch ein Web-Content-Management-System verwenden, um eine FAQ-Site oder eine einfache Wissensdatenbank zu erstellen. Beachten Sie jedoch, dass diese Seiten nicht über eine intelligente Suche verfügen, wie dies bei vielen der oben aufgeführten erweiterten Wissensdatenbanken der Fall ist. Hier sind zum Beispiel einige Wissensdatenbank- und FAQ-Themes für Wordpress:
https://themeforest.net/item/knowledge-base-helpdesk-wordpress-theme/18600587
https://themeforest.net/item/knowhow-a-knowledge-base-wordpress-theme/2813111
https://themeforest.net/item/flatbase-a-responsive-knowledge-basewiki-theme/7264664
https://herothemes.com/themes/knowall-wordpress-knowledge-base/
https://themeforest.net/item/infocenter-knowledge-base-and-qa-wordpress-theme/19488071
https://themeforest.net/item/helper-knowledge-base-support-wordpress-theme/10004046
https://themeforest.net/item/knowledge-base-helpdesk-wiki-faq-wordpress-theme/3434096
https://themeforest.net/item/knowledge-base-helpdesk-wiki-faq-wordpress-theme/3434096
https://launchandsell.com/themes/wikipress-wordpress-wiki-theme
Wikis und vergleichbare Systeme
Im Bereich der Wikis eignen sich für technische Dokumentation und zum Zweck der Benutzerunterstützung insbesondere:
Confluence, Enlite, and other add-ins
Kommerzielles Wiki, das insbesondere in Kombination mit den SCROLL-Add-ons von K15t Software die Anforderungen an ein professionelles Hilfe-Authoring-Tool erfüllt. Es sind auch diverse Plugins für Code- und API-Dokumentation verfügbar. Enlite ist im Wesentlichen eine vorkonfigurierte, gebündelte Version von Confluence plus einige der Plugins. Refined for Confluence kann aus Confluence allgemeine Websites generieren sowie von Confluence unabhängige Dokumentationssites.
Preisklasse: ● divers
https://www.atlassian.com/software/confluence
https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin/server/overview
https://marketplace.atlassian.com/apps/142/comala-document-management?hosting=server&tab=overview
BIT.AI
Collaboration-Plattform für die Erstellung von dynamischen Notizen, technischen Dokumentationen, Wikis, Wissensdatenbanken, Schulungsunterlagen und Kundenportalen.
Preisklasse: ● mittel
Archbee
Webbasierte Dokumentationsplattform mit integrierter Unterstützung für die Zusammenarbeit beim Schreiben von Entwicklerhandbüchern, API-Referenzen und auch Produktdokumentation. Kann Inhalte aus verschiedenen anderen Entwicklungs- und Collaboration-Tools integrieren.
Preisklasse: ● divers
Dokit
Basiert auf MediaWiki. Kann Vorlagen, Formulare und Metadaten verwenden, um Inhalte zu strukturieren und zu organisieren. Verfügt über eingebaute Übersetzungsfunktionen, Versionsverwaltung, Rechteverwaltung, semantische Suche, soziale Funktionen, PDF-Export.
Preisklasse: ● keine Preise veröffentlicht
Outline
Team-Wissensdatenbank für interne Dokumentation. Die selbst gehostete Version ist kostenlos (Open Source).
Preisklasse: ● mittel
https://github.com/outline/outline
Dozuki Guidebook
Preisklasse: ● keine Preise veröffentlicht
BlueSpice
Preisklasse: ● hoch
MediaWiki, Semantic MediaWiki
Preisklasse: ● kostenlos (Open Source)
https://www.semantic-mediawiki.org
dokuwiki
Preisklasse: ● kostenlos (Open Source)
Tiki Wiki
Preisklasse: ● kostenlos (Open Source)
TWiki
Preisklasse: ● kostenlos (Open Source)
XML-Editoren für die Erstellung technischer Dokumentation
Oxygen XML Author
XML-Editor mit hervorragender Unterstützung für DITA. Außerdem verfügt er über einen eigenen Konverter für WebHelp und die Möglichkeit, PDF mit CSS zu gestalten. Eine weitere interessante Funktion ist, dass Oxygen auch einen integrierten Markdown-Editor besitzt und Markdown-Dokumente in DITA-Projekte integrieren kann. Mitwirkende und Reviewer können einen vereinfachten Web-Editor verwenden.
Preisklasse: ● mittel
XMetaL
Preisklasse: ● keine Preise veröffentlicht
Arbortext
Preisklasse: ● keine Preise veröffentlicht
Adobe FrameMaker
Preisklasse: ● mittel
Xeditor
Webbasierter WYSIWYG XML-Editor.
Preisklasse: ● keine Preise veröffentlicht
UltraXML
Preisklasse: ● keine Preise veröffentlicht
XMLmind XML Editor
Es gibt auch eine kostenlose Personal Edition mit eingeschränktem Funktionsumfang und nur für nicht-kommerzielle Zwecke.
Preisklasse: ● mittel
FontoXML
Webbasierter XML-Editor, der speziell für Fachexperten und gelegentliche Autoren entwickelt wurde, um strukturierte Inhalte zu erstellen. DITA-kompatibel. Der DITA-Editor für kleine Teams ist kostenlos.
Preisklasse: ● keine Preise veröffentlicht
Simply XML Content Mapper
Ermöglicht es Ihnen, wiederverwendbare XML-Inhalte direkt aus Microsoft Word zu erstellen.
Preisklasse: ● keine Preise veröffentlicht
Codex
Einfach zu bedienender DITA-Editor, speziell entwickelt für Techniker und Ingenieure, die nicht viel Zeit mit dem Schreiben und Editieren verbringen möchten.
Preisklasse: ● kostenlos (Freeware)
Vex
Visual XML editor based on Eclipse. Comes with DITA and DocBook integrations.
Preisklasse: ● kostenlos (Open Source)
Content-Management-Systeme für Technische Dokumentation
Diverse DITA- und Nicht-DITA-Content-Management-Systeme sind erhältlich von folgenden Anbietern (in alphabetischer Reihenfolge aufgeführt). Die Preise bewegen sich in der Regel im gehobenen Bereich. Preisangaben sind meist nur auf Nachfrage verfügbar.
https://business.adobe.com/products/experience-manager/guides/aem-guides.html
https://www.boeingservices.com/boeing-spectrum/
https://www.ec-systems.de/de/home/
https://www.fischer-information.com
https://www.gds.eu/en/content-management-solutions
https://www.orbistechnologies.com
https://www.sequencesoftware.com
DITA- und XML-Tools
Werkzeuge für Transformation, Rendering und Anzeige
DITA Open Toolkit
Transformiert XML-DITA-Inhalte in ausgabefähige Formate wie HTML und PDF.
Preisklasse: ● kostenlos (Open Source)
DocBook
DocBook XSL-Stylesheets und andere Werkzeuge.
Preisklasse: ● kostenlos (Open Source)
https://sourceforge.net/projects/docbook/
XMLmind DITA Converter (ditac)
Alternative zum DITA Open Toolkit. Ermöglicht Ihnen die Konvertierung von DITA in XHTML, HTML, browserbasierte Hilfe (WebHelp), CHM, EPUB, PDF und andere.
Preisklasse: ● kostenlos (Open Source)
https://www.xmlmind.com/ditac/
WebWorks ePublisher
Kann verwendet werden, um DITA in WebHelp und andere Formate zu konvertieren.
Preisklasse: ● keine Preise veröffentlicht
DITA2Go
Konvertiert DITA-Dateien in HTML/XML, diverse kompilierte Hilfeformate sowie Word.
Preisklasse: ● kostenlos (Freeware)
TopLeaf
Beschreibung des Herstellers:
TopLeaf ist ein XML-Publishing-System, das mit Hilfe einer Rendering-Engine und eines Stylesheet-Entwicklungs-Toolkits hochwertige gestalteten Output in einem Bruchteil der Zeit herkömmlicher Publishing-Prozesse erstellt. Zu den Funktionen von TopLeaf gehören ein visueller PDF-Layout-Formatierer, verschiedene Publishing-Ausgabetypen und DITA-Plugins für Oxygen XML Editor, XMetaL Author und das DITA Open Toolkit. Die XML-Lösung funktioniert gut in automatisierten, auf Content-Management-Systemen basierenden Umgebungen, einschließlich serverbasierter integrierter Anwendungen. TopLeaf kann in jedes CMS integriert werden, einschließlich der CCMS-Lösungen RSuite Standard und RSuite Enterprise, da TopLeaf Teil der Contiem-Produktpalette ist.
Preisklasse: ● keine Preise veröffentlicht
RSuite
Beschreibung des Herstellers:
Mit RSuite können Unternehmen ihre gesamten digitalen Inhalte von einem einzigen System aus automatisieren, verwalten und veröffentlichen. RSuite kann auf die Content-Anforderungen eines Unternehmens skaliert werden, von einer sofort einsatzbereiten Lösung für die Verwaltung von Inhalten und Daten (RSuite Standard) bis hin zu einer hochgradig konfigurierbaren, kommerziellen, in der Cloud und vor Ort gehosteten Lösung für hochwertige Multi-Channel-Inhalte (RSuite Enterprise). Die vollständige Software-Suite umfasst auch Produkte wie ein XML-Publikationssystem, Cloud-Textanalysedienste sowie Analyse- und Wissensproduktion. Mit patentierten semantischen Suchfunktionen, dynamischen Reflowable Outputs und Sicherheit auf Verteidigungsministeriumsebene bietet Contiem All-in-One-Content-Lösungen, die die Effizienz im gesamten Content-Ökosystem eines Unternehmens steigern.
Preisklasse: ● keine Preise veröffentlicht
MiramoPDF
Unterstützt die Neugestaltung von Dokumenten über eine grafische Benutzeroberfläche, ohne dass XSLT oder andere Programmierungen erforderlich sind. Kann mit Oxygen XML Editor oder dem DITA Open Toolkit integriert werden.
Preisklasse: ● keine Preise veröffentlicht
Antenna House Formatter
Leistungsstarke Software für die automatische Veröffentlichung von PDF-Dateien aus XML-, DITA- und S1000D-Daten. Kann XSL-FO oder CSS verwenden.
Preisklasse: ● mittel
Publican
DocBook-Werkzeuge zum Erstellen von PDF-, WebHelp- und anderen Ausgabeformaten.
Preisklasse: ● kostenlos (Open Source)
https://sourceware.org/publican/
DITA2wiki
Veröffentlicht DITA-Inhalte in Confluence.
Preisklasse: ● kostenlos (Open Source)
https://sourceforge.net/projects/dita2wiki/
Prince
Konvertiert HTML- und XML-basierte Dokumente (z. B. DITA) in PDF. Dokumente können mit CSS formatiert werden.
Preisklasse: ● mittel
Vivliostyle
CSS-Satzprogramm.
Preisklasse: ● kostenlos (Open Source)
RenderX XEP Engine
Konvertiert XML-Dokumente in druckbare Dokumente, wie PDF, PostScript, AFP, XPS, PPML, SVG und HTML. Verwendet dazu XSL Formatting Objects.
Preisklasse: ● mittel
XMLmind XSL-FO Converter
XSL-FO-Prozessor. Konvertiert XSL-FO in RTF, WordprocessingML (kann in Word 2003+ geöffnet werden), Office Open XML und OpenOffice.
Preisklasse: ● mittel
Saxonica
XSLT- und XQuery-Verarbeitungswerkzeuge.
Preisklasse: ● divers
HICO X-Publisher
Extrahiert XML- und SGML-Inhalte aus dem Dateisystem oder einem Content Management System, stellt die Inhalte für verschiedene Zielgruppen zusammen und publiziert automatisch gedruckte und elektronische Dokumente.
Preisklasse: ● keine Preise veröffentlicht
Apache FOP
Druckformatierer auf Basis von XSL-FO. Primäres Ausgabeziel ist PDF.
Preisklasse: ● kostenlos (Open Source)
https://xmlgraphics.apache.org/fop/
Migrations- und Konvertierungs- sowie weitere DITA-Tools
Stilo Migrate
Ermöglicht Benutzern das Hochladen von Dokumenten in proprietären Formaten, einschließlich Word und FrameMaker, und konvertiert diese Dokumente nach DITA XML.
Preisklasse: ● keine Preise veröffentlicht
ConverToo
Konvertiert Word-Dateien nach DITA. Funktioniert auch bei schlecht formatierten Dokumenten, da das visuelle Erscheinungsbild des Inhalts und nicht die Absatz- und Zeichenformate berücksichtigt werden. Der Preis hängt ab vom Umfang der zu konvertierenden Dokumente.
Preisklasse: ● divers
DITA to WordPress Import Tool
Importmodul, das die zweispaltige browserbasierte Hilfeausgabe aus dem DITA Open Toolkit verwendet und die Hierarchie der XHTML-Seiten in WordPress importiert.
Preisklasse: ● kostenlos (Open Source)
https://journalized.zed1.com/wordpress-plugins/dita-to-wordpress-import-tool/
upCast
Konvertiert Word nach XML und umgekehrt.
Preisklasse: ● keine Preise veröffentlicht
WinANT
Windows-Schnittstelle zum Ant-Build-Dienstprogramm für die Verarbeitung von DITA-Dokumenten.
Preisklasse: ● kostenlos (Open Source)
https://sourceforge.net/projects/winant-echidna/
DITA-OT Markdown plug-in
Ermöglicht die Verwendung von Markdown DITA als Quelldateien für das DITA Open Toolkit.
Preisklasse: ● kostenlos (Open Source)
https://github.com/jelovirt/dita-ot-markdown
DITA-FMx
Reihe von Plug-ins und Strukturierungsprogrammen, mit denen Sie DITA-XML-Dateien in FrameMaker erstellen und bearbeiten können. Bietet eine vollständige Lösung für DITA-Authoring und -Publishing.
Preisklasse: ● niedrig
DITA Compare
Vergleicht DITA-Dokumente und fügt Revisionskennzeichen oder Statusattribute hinzu, die die Änderungen zwischen den verschiedenen Versionen anzeigen. Sie können dies zu Überprüfungszwecken verwenden oder die Attribute in Ihrer Publishing-Pipeline verarbeiten und Ihren veröffentlichten Dokumenten Styling- oder Änderungsleisten hinzufügen.
Preisklasse: ● keine Preise veröffentlicht
https://www.deltaxml.com/products/compare/dita-compare/
DITA Merge
Nimmt zwei oder mehr DITA-Dateien und führt die Änderungen zusammen. Konflikte können interaktiv oder automatisch durch XPath-basierte Regeln verwaltet werden.
Preisklasse: ● keine Preise veröffentlicht
https://www.deltaxml.com/products/merge/xml-merge/
dita-ot-pdf-css
DITA Open Toolkit Plugin zum Generieren von PDF-Ausgaben mit CSS Paged Media (erfordert einen der kommerziellen PDF-Formatierer PDFReactor oder Vivliostyle).
Preisklasse: ● kostenlos (Open Source)
https://github.com/xmlrocks/dita-ot-pdf-css-page
Auf die Erstellung technischer Dokumentation spezialisierte Textverarbeitungen und Add-ons
Adobe FrameMaker
Preisklasse: ● mittel
FrameScript/ElmScript
FrameMaker-Scripting- und Anpassungstool.
Preisklasse: ● niedrig
FrameMaker Plug-ins
http://www.cudspan.net/plugins/
https://www.siliconprairiesoftware.com
http://www.weststreetconsulting.com
QuickSilver
Werkzeug zur Erstellung und Verwaltung langer Dokumente.
Preisklasse: ● keine Preise veröffentlicht
https://broadvision.com/products/quicksilver/quicksilver-overview/
OfficeForms
Add-on für Microsoft Word, das Ihnen die Möglichkeiten des Single-Source-Publishing bietet, einschließlich einer Datenbank und bedingter Ausgabe.
Preisklasse: ● mittel
https://dokay.de/en/officeforms-en
Beschreibung des Herstellers:
OfficeForms: Das einfachste Redaktionssystem.
OfficeForms ergänzt Microsoft Word mit Funktionen eines Redaktionssystems.
* Bausteinverwaltung – Zentral abgelegte Bausteine sind die bessere Alternative zu Copy & Paste.
* Variantenverwaltung – Variable Inhalte vermeiden Redundanzen.
* Mehrsprachigkeit – Übersetzungen lassen sich intelligent managen.
Und das alles mit Word und nach dem WYSIWYG-Prinzip.
SmartDocs
Fügt Funktionen zur Verwaltung und Wiederverwendung von Inhalten in Microsoft Word-Dokumenten hinzu.
Preisklasse: ● mittel
FS Pro
Add-ons für Microsoft Word und Confluence, die Sie dabei unterstützen, beim Schreiben die Information Mapping Methode anzuwenden.
Preisklasse: ● mittel
https://informationmapping.com/collections/software
SingleFeeder
Textbausteinbibliothek und Translation Memory für effizientes Publishing. Verfügt über Schnittstellen zu Word, FrameMaker, InDesign, PowerPoint und XLIFF.
Preisklasse: ● mittel
https://www.singlefeeder.de/en-gb
data2check
Überprüft Word-Dokumente und InDesign-Dateien auf unerwünschte Formate und manuelle Formatierungen, um Konsistenz zu gewährleisten.
Preisklasse: ● kostenlos (Webanwendung)
Macros for Writers and Editors
Sammlung von Microsoft Word Makros.
Preisklasse: ● kostenlos (Freeware)
GeWoVa
Add-on für Microsoft Word, das die Funktionen für die Arbeit mit Dokumentvariablen hinzufügt. Sie können Variablen erstellen, einfügen und aktualisieren, Variablen in Excel gesammelt exportieren und Variablen aus Excel gesammelt importieren.
Preisklasse: ● niedrig
PowerTOC
Erstellt ein Inhaltsverzeichnis für einen Satz von PowerPoint-Folien.
Preisklasse: ● niedrig
https://momsoftco.com/products/powertoc/
Indexing tools
Mit den meisten Werkzeugen zur Erstellung von Hilfesystemen und mit anderen Redaktionssystemen für Technische Dokumentation können Sie problemlos Indexeinträge hinzufügen. Wenn Sie jedoch HTML-Seiten manuell erstellen oder wenn Sie einige anspruchsvolle Indexierungsfunktionen nutzen möchten, können die folgenden Indexierungswerkzeuge hilfreich sein.
https://www.editorium.com/dexter.htm
Annotate.co
Ist selbst kein Editor, sondern ermöglicht es Ihnen, ein PDF- oder Word-Dokument hochzuladen und dieses Dokument mit Kollegen zu teilen. Jede Person kann dem Text und den Bildern Notizen und Tags hinzufügen und auf die Notizen der anderen antworten. Sie können Notizen als erledigt oder wieder offen markieren. Es ist auch eine kostenlose Version für bis zu 3 Benutzer erhältlich.
Preisklasse: ● keine Preise veröffentlicht
PleaseReview
Bietet Überprüfungs- und Co-Autorenfunktionen für Microsoft Word-Dokumente.
Preisklasse: ● keine Preise veröffentlicht
https://www.ideagen.com/products/pleasereview
indoition Starter Template
Professionelle Microsoft Word-Vorlage und OpenOffice / LibreOffice-Vorlage für die Erstellung technischer Dokumentation. Ziel ist es, übersichtliche Dokumente zu erstellen, die für den Benutzer ansprechend und für den Autor effizient zu erstellen und zu pflegen sind.
Preisklasse: ● niedrig
https://www.indoition.com/de/products/formatvorlage-technische-dokumentation-funktionen.htm
Klassische DTP-Programme
Adobe InDesign
Preisklasse: ● mittel
QuarkXPress
Preisklasse: ● mittel
VivaDesigner
Gibt es auch in einer kostenlosen Version.
Preisklasse: ● mittel
Affinity Publisher
Preisklasse: ● niedrig
https://affinity.serif.com/en-us/publisher/
Microsoft Publisher
Preisklasse: ● niedrig
Scribus
Preisklasse: ● kostenlos (Open Source)
Klassische Textverarbeitungsprogramme
Microsoft Word
Preisklasse: ● mittel
OpenOffice, LibreOffice
Preisklasse: ● kostenlos (Open Source)
Google Docs
Preisklasse: ● kostenlos (Webanwendung)
SoftMaker Office
Preisklasse: ● niedrig
https://www.freeoffice.com/en/
WordPerfect Office
Preisklasse: ● mittel
ONLYOFFICE
Preisklasse: ● kostenlos (Open Source)
SMASHDOCs
Spezialisiert auf kollaboratives Editieren.
Preisklasse: ● keine Preise veröffentlicht
Papyrus
Entwickelt speziell für die Bearbeitung langer Dokumente. Inklusive DUDEN Korrektor (für deutsche Texte).
Preisklasse: ● niedrig
RagTime
Preisklasse: ● mittel
http://www.ragtime.de/start.html
LyX
Preisklasse: ● kostenlos (Open Source)
Scrivener
Geht einen Schritt weiter als reine Textverarbeitungsprogramme und unterstützt auch die Recherche und das Strukturieren eines Dokuments.
Preisklasse: ● niedrig
https://www.literatureandlatte.com
Entscheidungshilfen: Auswahl eines Help Authoring Tools
Für die Erstellung von Online-Hilfen gibt es zahlreiche spezialisierte Editoren und Konverter, sogenannte „Help Authoring Tools“, kurz HATs. Viele dieser Werkzeuge bieten heute auch Möglichkeiten zum Single-Source-Publishing, d. h. sie können mehrere Ausgabeformate und Varianten aus einer gemeinsamen Textquelle heraus generieren. Während die meisten Tools die Generierung verschiedener Online-Formate (z. B. Browser-basierte Hilfen, kompilierte Online-Hilfen) sehr gut beherrschen, sind nur wenige Tools in der Lage, auch gedruckte Handbücher (PDF) in professioneller Qualität zu erzeugen. Große Unterschiede zwischen den Tools zeigen sich auch, wenn es um die Übersetzung Ihrer Projekte in Fremdsprachen geht.
Die folgende Checkliste kann Ihnen bei der Entscheidung helfen, welches Help Authoring Tool Ihren spezifischen Anforderungen am besten entspricht.
Grundlegende Gruppen von Tools
Das wichtigste Unterscheidungsmerkmal ist die Frage, wo und wie Autoren ihre Texte zusammenstellen und formatieren.
▪Tools mit integriertem Editor
Die meisten Tools zur Erstellung von Hilfetexten verfügen über einen eigenen, voll integrierten WYSIWYG-Editor.
Vorteile: Texte und Meta-Informationen können gemeinsam erstellt und verwaltet werden. Es fallen keine zusätzlichen Lizenzkosten für einen externen Editor an. Es muss nur ein Softwarepaket installiert und aktualisiert werden.
Nachteil: Die integrierten Editoren bieten oft nicht den gleichen Komfort und die gleiche Effizienz wie die bekannten Textverarbeitungsprogramme. Wenn Sie z. B. Makros oder Autotext verwenden möchten, müssen Sie häufig ein Utility eines Drittanbieters benutzen.
▪Tools, die einen externen Editor verwenden
Andere Tools verfolgen den gegenteiligen Ansatz und verwenden einen externen Editor, um die Texte zu erstellen – meist Microsoft Word, aber in zunehmendem Maße auch FrameMaker, HTML-Editoren und XML-Editoren.
Vorteil: Sie können alle Funktionen Ihres bevorzugten Editors nutzen.
Nachteil: Oft ist die Bedienung ineffizient. Da die Quelldaten meist mit zusätzlichen Metainformationen versehen sind (z. B. in Form versteckter Texte oder mit Hilfe von Feldfunktionen), wird der Übersetzungsprozess besonders fehleranfällig. Hinzu kommen die typischen und bekannten Probleme der verschiedenen Editoren, sodass diejenigen, die schon immer ungern mit einem dieser Editoren, wie z.B. Microsoft Word, gearbeitet haben, mit einem Tool, das diesen Editor integriert, nicht glücklich werden.
▪Reine Konverter
In dieser Gruppe sind Texterstellung und Hilfegenerierung weitgehend entkoppelt. Komplette Benutzerhandbücher (meist mit Microsoft Word oder FrameMaker geschrieben) werden erst im zweiten Schritt in eine Online-Hilfe umgewandelt. Grundlage für die Formatierung ist meist eine bestimmte Formatvorlage, die beim Schreiben der Texte strikt eingehalten werden muss. Außerdem müssen, ähnlich wie bei solchen Tools, die einen externen Editor verwenden, oft zusätzliche Meta-Informationen in den Text integriert werden.
Vorteil: Dieses Verfahren fördert das effiziente Single-Source-Publishing, insbesondere wenn die Inhalte bereits in Form druckbarer Benutzerhandbüchern vorliegen.
Nachteil: Die Buchmetapher kann den Autor leicht dazu verleiten, Inhalte zu schreiben, die nicht so modular sind, wie es für eine Online-Hilfe erforderlich ist. Das Ergebnis ist dann nicht selten ein „Buch auf dem Bildschirm“ statt einer mediengerechten Online-Hilfe. Ein weiterer Nachteil ist die Tatsache, dass die Dokumentation für verschiedene Produktvarianten nicht wirklich aus der gleichen Quelle generiert werden kann.
Andere Konverter basieren auf XML-DITA. Mit diesen Konvertern lassen sich die oben genannten Nachteile vermeiden, da sie den Autor zwingen, von Grund auf eine modulare, onlinefähige Struktur zu entwickeln.
Unterstützung für Übersetzungen?
Wenn die Online-Hilfe für bestimmte Sprachen Unicode-kompatibel sein muss, schränkt dies die Auswahl an Tools ein. Nicht alle Programme unterstützen Unicode. Auch beim Übersetzungsworkflow gibt es erhebliche Unterschiede. Viele Tools ignorieren die Übersetzungsanforderungen vollständig. Andere bieten ausgefeilte Export- und Importoptionen für Texte, die an externe Übersetzer geschickt werden sollen, oder die Tools ermöglichen es dem Autor, mehrere Sprachen parallel zu bearbeiten.
Teamunterstützung?
Nur wenige der klassischen Hilfeerstellungswerkzeuge unterstützen explizit die gleichzeitige Bearbeitung durch mehrere Autoren. In einigen Fällen kann dies bis zu einem gewissen Grad auch manuell auf Dateiebene erreicht werden, aber das funktioniert nur bei den Werkzeugen, die jedes Topic in einer eigenen Datei speichern. Wenn Ihr Team an verschiedenen Standorten arbeitet, kann ein Remote-Zugriff erforderlich sein.
Weitere Überlegungen sind:
▪Verfügt das Tool über ein eingebautes Versionskontrollsystem oder kann es mit einem externen VCS verbunden werden?
▪Bietet das Tool Unterstützung für den Review-Prozess?
▪Bietet das Tool eine Möglichkeit für Fachexperten, Informationen auf effiziente und einfache Weise beizusteuern?
Echtes Single-Source-Publishing?
Die meisten Tools behaupten, Single-Source-Publishing zu unterstützen, d. h. Texte einmal zu erstellen und sie dann in verschiedenen Formaten und Medien zu veröffentlichen. Solange es sich bei diesen Texten nur um unterschiedliche Hilfeformate handelt, wie z. B. kompilierte Hilfe oder browserbasierte Hilfe, funktioniert dies in der Regel problemlos. Wenn es aber darum geht, zusätzlich druckbare Handbücher oder PDFs zu erstellen, dann trennen folgende Aspekte die Spreu vom Weizen:
▪Lässt sich die Formatierung der exportierten Dokumente feinjustieren? Viele Tools exportieren zum Beispiel nicht die Namen von Absatz- und Zeichenformaten. So ist es kaum möglich, ein professionelles Drucklayout effizient zu erreichen.
▪Ist es möglich, medientypische Textfragmente wie „auf Seite“ oder „in Kapitel“ automatisch zu entfernen oder einzufügen?
▪Kann der Export auf bestimmte Inhalte beschränkt werden?
Müssen Dokumentationen sowohl für unterschiedliche Medien als auch für unterschiedliche Produktvarianten aus der gleichen Quelle generiert werden (z.B. für eine Standard- und eine Pro-Version), erfährt das Single Source Publishing eine weitere Dimension. Einige Tools ermöglichen es, sogenannte bedingte Texte zu definieren oder Flags zu setzen, um bestimmte Textabschnitte bei Bedarf auszublenden. Weitere wichtige Funktionen sind Variablen und Textschnipsel (Snippets) (manchmal auch als embedded Topics bezeichnet), die es Ihnen ermöglichen, einzelne Textabschnitte mehrfach zu verwenden – z. B. Produktnamen oder einen Warnhinweis.
Automatisierung des Build-Prozesses?
Kann die Erstellung der Dokumentation für mehrere Produktvarianten automatisiert werden? Ist es möglich, das Tool von der Kommandozeile oder skriptgesteuert aufzurufen? Kann das Tool mit allen erforderlichen Einstellungen und Parametern aufgerufen werden?
Kann das Tool in einen allgemeinen Build-Prozess integriert werden?
Dokumentation von Quellcode?
Einige Tools sind auf die Dokumentation von Code und Komponenten spezialisiert. Sie scannen den Quellcode und erzeugen automatisch ein vollständig verlinktes Grundgerüst für die Dokumentation. Zitate aus dem Quellcode werden ebenfalls automatisch formatiert (Funktion Syntax-Highlighting).
Manuelle Formatierung?
Die Verwendung eines kostengünstigen Tools kann sich als kostspielige Angelegenheit erweisen, wenn ein Projekt größer wird als ursprünglich erwartet oder wenn es später überarbeitet werden muss. Die meisten Low-cost-Tools unterstützen keine definierbaren Absatz- und Zeichenformate und formatieren jedes Wort manuell. Wenn dann eine globale Änderung des Layouts notwendig wird, kommt das böse Erwachen.
Eine kostengünstige Lösung dürfte nur für diejenigen eine wirtschaftliche Alternative sein, die nur gelegentlich eine kleine Online-Hilfe erstellen und diese nicht regelmäßig weiterpflegen und aktualisieren müssen.
Kontrolle über den HTML-Code?
Obwohl alle aktuellen Hilfeformate HTML-basiert sind, gewähren Ihnen nur wenige Tools die volle Kontrolle über den generierten HTML-, JavaScript- und CSS-Code. Hier müssen Sie eine grundlegende Entscheidung treffen: Möchten Sie den Code manuell anpassen können oder suchen Sie ein Werkzeug, das Ihnen die meisten technischen Details abnimmt?
Weitere Aspekte der Erstellung
Schließlich stellen sich noch Fragen zu Leistung, Effizienz und Funktionsumfang:
▪Gibt es Unterstützung für erweiterte Navigationsfunktionen wie erweiterbare Abschnitte, einen Brotkrümel-Navigation (Breadcrumb-Trail), Links zu verwandten Themen und Mini-TOCs?
▪Ist es möglich, die browserbasierte Hilfe kontextabhängig aufzurufen? Oder wird immer nur die Startseite (index.html) angezeigt?
▪Wie einfach ist es, Altdaten aus anderen Tools zu importieren?
▪Welche anderen nützlichen Funktionen bietet die Software? Einige Tools werden beispielsweise mit nützlichen Hilfsprogrammen geliefert, wie z. B. einem Tool für Bildschirmaufnahmen (Screen Capture Tool) oder mit Werkzeugen für die Bildbearbeitung.
Strategische Fragen
Abgesehen von den Funktionen, der Leistung und der Benutzerfreundlichkeit des Help Authoring Tools sollten Sie auch die folgenden Worst-Case-Szenarien in Betracht ziehen:
▪Was passiert, wenn der Hersteller des Tools das Produkt oder seinen Betrieb einstellt? Benötigt Ihr Tool einen vom Hersteller betriebenen Server? Muss Ihr Tool bei der Installation auf einem neuen Computer aktiviert werden? Falls eines dieser Szenarien eintritt: Könnten Sie das Tool zumindest für begrenzte Zeit weiterhin verwenden?
▪Wie einfach können Sie Ihre Quelldateien migrieren, wenn Sie in Zukunft auf ein anderes Tool umsteigen wollen oder müssen? Verwendet das Tool standardisierte Formate wie XML/DITA, um seine Daten zu speichern? Können Sie nur den Output einer einzigen bestimmten Dokumentationsvariante migrieren oder können Sie die Quelldateien Ihres Projekts zusammen mit allen Metadaten migrieren?
Haben Sie von diesem Guide profitiert?
Vielleicht unterstützten Sie im Gegenzug dessen weitere Pflege und erwerben die PDF-Version (ca. 150 Seiten, €9,90) oder eines meiner Bücher?
Danke!
Diese Seite wurde zuletzt aktualisiert: 06/2023
Möchten Sie von wichtigen Updates erfahren? Folgen Sie mir auf LinkedIn.
Lust auf mehr? Siehe weitere Tools und Webseiten zum Thema Technische Dokumentation.
Rechtliche Hinweise:
Diese Seite enthält möglicherweise bezahlte, als solche gekennzeichnete Werbeanzeigen. Die verlinkten Webseiten und deren Herausgeber stehen ansonsten in keiner geschäftlichen Beziehung zu indoition Ingenieurbüro für Technische Kommunikation Marc Achtelig und geben nicht dessen Meinung wieder. Copyright verlinkter Inhalte bei deren jeweiligen Rechteinhabern. Beachten Sie die auf den verlinkten Seiten angegebenen Lizenzbedingungen! Mögliche Angaben zu Preisen und Lizenzen auf dieser Seite dienen lediglich der Vorabinformationen und sind ohne Gewähr.