Was ist ein Autorenwerkzeug?
Autorenwerkzeug, manchmal auch Autorentool oder Help Authoring Tool (HAT) genannt, ist ein sehr allgemeiner Überbegriff für Software, welche einen bei der Erstellung von (Technischen) Dokumentationen hilft. Da der Begriff Autor bereits im Namen enthalten ist, kann man sich gut vorstellen, dass es darum geht mit einem solchen Werkzeug Inhalte, meist Texte, Beschreibungen einschließlich Bilder, zusammenzustellen und in einem geeigneten Format zu veröffentlichen. Der Autor ist dabei oft nicht eine Einzelperson sondern, wie in vielen Unternehmen üblich, ein Team. Das Ergebnis ist eine Dokumentation, Beschreibung, Anweisung zu einem Produkt, Prozedere oder einer Verfahrensweise. Dieser Inhalt muss praktischer Weise in verschiedenen Formaten, z.B. als HTML-Online-Version, CHM-Datei oder als PDF-Datei bereitgestellt werden können.
Zielgruppen
Bei den Zielgruppen muss man unterscheiden zwischen dem Anwender des Autorenwerkzeugs, also demjenigen der die Dokumentation verfasst (Autor) und demjenigen der mit dem Ergebnis der Dokumentation arbeiten muss (Leser/Anwender).
Für letzteren ist es wichtig, dass die Doku, Anleitung gut verständlich, nachvollziehbar und strukturiert ist. Für den Content ist zwar immer noch im wesentlichen der Verfasser verantwortlich, aber ein Help Authoring Tool nimmt diesen zum Beispiel bereits bei der Strukturierung viel Arbeit ab.
Auf der Seite der Autoren sind typische Personenkreise:
- Software- und Hardware-Entwickler
- Administratoren
- Maschinenbauer
- e-Learning Produzenten
Auf der Seite der Leser/Anwender sind typischer Weise Personen, die:
- mit einer bestimmten Software arbeiten müssen,
- für Reparatur- und Wartungszwecke die Technische Dokumentation einer Anlage lesen müssen
- eine Bedienungsanleitung/-anweisung für ein Produkt lesen müssen,
- sich zu bestimmten Themen informieren müssen (Wissensdatenbank/Glossar)
- Teilnehmer von Weiterbildungen
Zielanwendungen
Nachfolgend ist eine unvollständige Auflistung möglicher Zielanwendungen bei denen ein HAT unterstützen kann:
- Bereitstellung von Online Hilfen für Software
- Erstellung und Pflege einer Wissensdatenbank, z.B. innerbetrieblich im Intranet
- Technische Dokumentation zu einem Produkt
- Erstellung von Begleitmaterial für ein Seminar oder Weiterbildungskurs
- Bereitstellung von innerbetrieblichen Durchführungsanleitungen
Funktionen und Aufgaben
In erster Linie geht es darum digitale Inhalte zu erzeugen. Hier erwarten man von einem solchen Help Authoring Tool maximale Unterstützung bzw. eine große Arbeitserleichterung, die ein normales Textverarbeitungsprogramm, wie Microsoft Word oder LibreOffice, nicht liefern kann. Über einen Editor sollte man im HAT schnell schreiben und formatieren können. Hier bietet sich zum Beispiel Markdown und HTML als Syntax an. Außerdem sollte es möglich sein, schnell Bildmaterial einzufügen. Denn jedes Bild sagt mehr als tausend Worte. Ferner unterstützt die Software bei der Anpassung einer individuellen Designs über Templates sowie bei der hierarchischen Strukturierung von Inhalten. Auch die automatische Erzeugung von Content, wie Inhaltsverzeichnisse, Navigations-Elemente oder Sitemaps erleichtern den Workflow.
Ein weiteres wichtiges Element von Autorenwerkzeuge sind verschiedene Export-Möglichkeiten. So wird eine Technische Dokumentation oft in vielen Formaten benötigt, je nach betreffenden Anwender. Der eine benötigt es als Handout in Papierform, ein anderer benötigt die Doku als Download im PDF-Format und wieder andere User wollen Online darauf zugreifen. Und der Software-Entwickler möchte in seinem Programm eine CHM-Datei bereitstellen.
Abhängig vom Anwendungsgebiet gibt es verschiedene Autorenwerkzeuge. Produkt- und Softwareentwickler werden eher zu einem Help Authoring Tool greifen, das die Anforderungen einer Technischen Dokumentation erfüllt. Zum Erzeugen einer Video-Dokumentation wird man eher zu einem Image- und Video-Capturing Programm greifen. Wer einen E-Learning oder Online-Kurs anbietet, wird auf eine E-Learning-Plattform setzen, welche nach Möglichkeit auch gleich die Erstellung eines Wissenstest mit Prüfung und Auswertung, ggf. auch mit Ausstellung eines Zeugnisses/Zertifikats, anbietet.
2 Kommentare