Ein Redaktionsleitfaden in der Technischen Dokumentation ist kein Regelwerk. Er dient mehr dazu, die Anwender zu schulen. Deswegen sollten Inhalte gut und übersichtlich strukturiert sein. Beispiele verdeutlichen die Inhalte noch besser. Für einen Redaktionsleitfaden gilt: Je länger und dichter der…
Redaktionssysteme dienen zur Verwaltung der Technischen Dokumentation und den Metadaten wie Datenstruktur und Layout des Inhaltes. Das Spektrum an Funktionen umfasst unter anderem das Erstellen, Verwalten, Publizieren und Übersetzen von Inhalten. Zudem ist durch die modulare Arbeitsweise mit dem Redaktionssystem…
Single Source Publishing steht für einen XML-Standard, auf dem moderne Redaktionssysteme in der Technischen Dokumentation basieren, die den Vorteil bieten, dass den Inhalt und Layout voneinander getrennt verwaltet. Der Content muss mann dann nicht unnötig mehrfach verwalten und kann diesen…
Dank der Wiederverwendbarkeit der Bausteine lassen sich die Betriebsanleitungen jeder Maschinenvariante nahezu automatisch aus dem System heraus generieren. Änderungen und Korrekturen an den Inhalten der Technischen Dokumentation nimmt man nur an einer zentralen Stelle vor. Die Änderungen und Korrekturen passen…
Eine gute und verständliche Technische Dokumentation verringert Risiken, reduziert den Supportaufwand und erhöht die Kundenzufriedenheit. Zudem vermeidet eine klare und verständliche interne Sprache Fehler und beschleunigt Prozesse. Außerdem erhöht eine einheitliche Terminologie für Fachbegriffe (wie z. B. NiO, Schütz, usw.)…
Terminologie in der Technischen Dokumentation sind die Einheitliche Formulierung von Fachbegriffen. Eine Betriebsanleitung für eine Maschine oder ein Gerät muss auch für Laien verständlich formuliert sein. Dabei sollte man gänzlich auf Synonyme verzichten und stattdessen auf konsistente Wiederholungen setzen. Ein…
Text und Bild in der Technischen Dokumentation stellt eine sinnvolle Kombination dar, um eine Betriebsanleitung logisch und verständlich zu gestalten. Beide Komponenten ergänzen sich gegenseitig und sorgen damit für eine gut strukturierte Übersicht. Dies führt dazu, dass sowohl die motorische…
Videos sind in Marketing und Vertrieb bereits ein beliebtes Mittel, um Kaufentscheidungen zu beeinflussen. In der Technischen Dokumentation können Videos zudem als spontanes Kommunikationsmittel eingesetzt werden. Eine Maschine oder ein Fertigungsprozess kann mit einer Kamera aufgenommen und von der Technischen…
Videos in der Technischen Dokumentation kaschieren Leseschwächen der Anwender und erhöhen die Akzeptanz von Anleitungen. So können erklärende Videos als Add-on zur Papieranleitung die Verständlichkeit einer Maschine erhöhen. Die Erstellung von Videos führt dafür aber auch zwangsläufig zur Erhöhung der…
Die Möglichkeiten für den Einsatz von Videos in der Technischen Dokumentation können in folgende Aufnahmesituationen unterteilt werden: Bewegtes Objekt: Zum Beispiel ein Technisches Produkt in Bewegung Animation: Abläufe in künstlicher Bewegung dargestellt Moderation: Aufnahme eines Sprechers oder einer Sprecherin Übersichtsfilm: Übersicht…