FAQ Category: Technische Dokumentation

Die Modularisierung von Dokumenten sollte folgende Anforderungen erfüllen:

Dokumente einfach klein zu schneiden, um sie im Redaktionssystem besser wiederverwenden zu können ist nicht die Lösung. Ein sinnvolles Modularisierungskonzept schöpft das volle Optimierungspotenzial der Modularisierung aus.

Um mit einem Redaktionssystem sinnvoll zu arbeiten, gibt es bestimmte Anforderungen, die Dokumente erfüllen sollten. Ein Modularisierungskonzept legt fest wie Dokumente modularisiert werden sollen, um sinnvoll wiederverwendet werden zu können.

Bei „Stand der Technik“ handelt es sich um einen unbestimmten Rechtsbegriff. Er ist einer der wichtigsten Technikklauseln für Maschinensicherheit, Produktsicherheit und Arbeitssicherheit. Mit der Klausel „Stand der Technik“ soll sichergestellt werden, dass die beste verfügbare Technik zum aktuellen Zeitpunkt zum Einsatz kommt.

Als Hersteller meines Produktes bzw. meiner Maschine muss ich darauf achten, dass meine Technische Dokumentation dem aktuellen Stand der Technik entspricht. Verbesserte Methoden und Weiterentwicklungen zur Produktsicherheit müssen in der Betriebsanleitung aktualisiert werden.

Technische Dokumentationen im digitalen Format gewinnen immer mehr an Bedeutung. Prinzipiell lassen sich digitale Dokumentationen in nahezu jedem elektronischen Format erstellen. Häufig werden sie als Online-Hilfen oder in PDF publiziert.

3D-Animationen eignen sich hervorragend, um bestimmte Abläufe oder Funktionen eines Produktes visuell darzustellen. Beispielsweise können so einzelne Montageschritte im Montagehandbuch dargestellt werden. Auch für den Technischen Redakteur sind 3D-Animationen wichtige Informationen, um das Produkt besser zu verstehen.

Auch 3D-Animationen können für die Technische Dokumentation hilfreich sein. Einsatzmöglichkeiten finden sich in:

An eine moderne Technische Redaktion werden heute einige Anforderungen gestellt, die es zu bewältigen gibt. Anleitungen, Übersetzungen oder Web-Informationen müssen dem Nutzer jederzeit zur Verfügung stehen und auf Knopfdruck produziert werden. Viele Unternehmen erfüllen immer individuellere Kundenanforderungen (z. B. wird ein Auto aufwendig konfiguriert). Das erhört die Anforderungen an die Dokumentation zusätzlich.

Metadaten können als eine der wichtigsten Werkzeuge für die Technische Dokumentation in Content Management und Content Delivery fungieren. Mit Metadaten lassen sich Produkte automatisiert zu bestimmten Gruppen zuordnen, Zielgruppen festlegen oder Geräteeigenschaften managen.