Moderner Ansatz für technisches Dokumentation
Auf dem heutigen Markt gibt es eine breite Palette von Werkzeugen für die technische Redaktion.
Es gibt Systeme für einfache Aufgaben, die nicht die Verarbeitung großer Inhaltsmengen erfordern. Als Beispiel kann eine Bedienungsanleitung für einen kleinen Artikel wie eine Armbanduhr oder ein einfaches Computerprogramm wie ein Englisch-Spanisch-Wörterbuch dienen. In diesen Fällen eignet sich einer der bekannten Editoren (Adobe PageMaker, Adobe InDesign und das am weitesten verbreitete Microsoft Word) für das Ziel. Das Endergebnis ist in der Regel eine PDF-Datei, die zusammen mit dem Produkt verteilt wird.
Bei einem großen Produktionsumfang ist eine Anpassung jedoch unvermeidlich: Jede Änderung eines Artikels, jede neue Version eines Computerprogramms vervielfacht die zu verarbeitenden Inhaltsmengen. Infolgedessen werden mehr Zeit und Geld benötigt.
Um die Aufgabe zu vereinfachen, wurden ausgefeiltere Mittel zur Verwaltung von Inhalten erfunden. Das System SCHEMA ST4 ist eines der bekanntesten Beispiele dafür – der Architekt überwacht die Erstellung und Pflege von Dokumentationsvorlagen, und der technische Redakteur kontrolliert den Inhalt selbst. ST4 ermöglicht eine Segmentierung, so dass Sie jedem Segment des Inhalts spezifische Metadaten zuweisen können, damit diese automatisch in die Dokumentation für die entsprechenden Produkte aufgenommen werden.
Die Vorlagen werden von den Architekten entwickelt. Die textlichen Inhalte und Grafiken werden von technischen Redakteuren und Grafikern erstellt. Das System ermöglicht den Export der endgültigen Inhalte in verschiedene Formate – zum Beispiel in PDF, Microsoft Word und HTML5, die sich bereits großer Beliebtheit erfreuen. Wenn Sie eine Dokumentation im HTML5-Format haben, können Sie die gewünschten Informationen schnell finden, indem Sie Schlüsselwörter oder das Inhaltsverzeichnis verwenden. Um ein Dokument im HTML5-Format anzuzeigen, kann ein herkömmlicher Webbrowser wie Google Chrome oder Microsoft Edge verwendet werden.
Eine spezielle Schnittstelle dient dazu, die Dokumentation zur Übersetzung zu schicken. Wenn die Übersetzung abgeschlossen ist, exportiert der Übersetzer den übersetzten Inhalt zurück in ST4. Die Vollständigkeit der Übersetzung des Projekts im Allgemeinen und die seiner Knoten im Besonderen wird durch die Anzeige des Übersetzungsstatus angezeigt. All dies vereinfacht die Lokalisierung der Dokumentation und ihre Übersetzung in andere Sprachen. Es besteht keine Notwendigkeit, verstreute Dateien manuell zu sammeln, da alle notwendigen Informationsknoten automatisch im System erfasst werden. Der technische Redakteur braucht nur die notwendigen Befehle in der grafischen Oberfläche des ST4-Systems zu verwenden, um das Projekt zur Übersetzung zu senden. In den meisten Fällen wird das Projekt jedoch zunächst nur an den Übersetzer geschickt, um die Kosten für die Übersetzung zu ermitteln. Dann wird entschieden, ob die Übersetzung in Auftrag gegeben werden soll oder nicht.
Für die direkte Bearbeitung des Dokumentationstextes wird der XMetaL-Editor verwendet, der mit dem ST4-System kompatibel ist. Er ist für Dokumente gedacht, die auf einer XML-ähnlichen Struktur beruhen, und ermöglicht die Bearbeitung des Inhalts sowohl im WYSIWYG-Modus als auch im Tag-Markup-Modus. Im letzteren Modus kann der Autor sehen, welches Tag für den jeweiligen Dokumentteil verwendet wird. Die Fähigkeit des Programms, in den XML-Bearbeitungsmodus zu wechseln, gewährleistet ein möglichst genaues Arbeiten. Die Arbeit im XML-Bearbeitungsmodus ist jedoch in der Regel nicht Teil der täglichen Routine. Illustrationsdateien können in den Formaten Adobe Illustrator, PDF, EPS oder PNG vorliegen. Sie können mit dem Projekt verknüpft und in der Dokumentation verwendet werden.
Im Vorfeld erstellte Dokumentationsvorlagen sparen Ihnen Zeit bei der Formatierung typischer Dokumentationsinhalte. Sie brauchen nur eine Dokumentationsvorlage aus den vorbereiteten Vorlagen entsprechend dem gewünschten Dokumentationsthema auszuwählen und dann bestimmte Dokumentationsknoten damit zu verknüpfen. Jeder Knoten steht für einen mindestens eigenständigen Dokumentationsabschnitt. Dabei kann es sich zum Beispiel um einen Haftungsausschluss oder einen Unterabschnitt handeln, der einen Menübefehl oder einen Teil der Schnittstelle eines Computerprogramms oder eines Hardwaregeräts beschreibt. Kopf- und Fußzeilen werden automatisch entsprechend der vom Architekten festgelegten Vorlage formatiert. Der technische Redakteur braucht nur den Text einzugeben und die Markierung zu setzen. Textteile können als GUI-Elemente, als Dateinamen, als Unterabschnitte innerhalb von Abschnitten usw. gekennzeichnet werden. Für reinen Text ist kein Markup erforderlich.
Das System bietet eine Versionskontrolle für einzelne Knoten und für das gesamte Projekt. Jedes Mal, wenn ein Projekt zur Veröffentlichung freigegeben wird, wird automatisch eine neue Version erstellt. Ebenso wird automatisch eine neue Version erstellt, wenn Sie beginnen, einen Dokumentationsknoten zu bearbeiten, der bereits zur Veröffentlichung freigegeben wurde.
Das ST4-System verfügt über eine ausführliche Hilfe im HTML5-Format, die Informationen zu jeder Option oder jedem Befehl enthält. Es ist möglich, Skripte zu verwenden, um Routineprozesse zu automatisieren, und es steht ein umfangreiches taxonomisches System zur Verfügung. Sie können zum Beispiel bestimmten Dokumentationsknoten Attribute zuweisen, die auf bestimmte Produktversionen hinweisen, zu denen sie gehören, und Sie können Ihre Kommentare direkt in den Text und auch in die Metadaten einfügen. Kommentare sind in dem veröffentlichten Text nicht enthalten.
Nach Beendigung seiner Arbeit an einer Reihe von Knoten kann der technische Redakteur die Knoten als „freigegeben“ markieren und sie seinem Vorgesetzten zur Prüfung übermitteln. Später, wenn der Inhalt als endgültig betrachtet wird, sollten die Knoten als „genehmigt“ markiert werden. Sie können dann in das Projekt integriert und an die Übersetzer zur Lokalisierung geschickt werden. Wenn keine Übersetzung erforderlich ist, können Sie die Ausgabe sofort in einem bestimmten Format auf der Website veröffentlichen: HTML5, PDF oder Microsoft Word.
Moderne Systeme zur Erstellung technischer Dokumentationen, wie SCHEMA ST4, bieten weitaus mehr Möglichkeiten als die herkömmlichen Desktop-Publishing-Systeme. Sie verfügen über einen größeren Funktionsumfang und erleichtern die Arbeit mit Dokumentationen in großen Mengen. Sie sparen Ihnen Zeit und Geld.
