Technische Dokumentation

Dokumentation und strukturierte Inhaltserstellung mit XML für technische Redakteure

Hatten Sie jemals den Eindruck, Sie verbringen genauso viel Zeit beim Schreiben des Inhaltes als wie Sie für die Seitenentwicklung und Formatierung, zum Beispiel für die Änderung von Style und Seitenumbrüchen aufwenden?

Schreiben Sie Dokumente mit verschiedenen Sprachversionen oder haben Sie evtl. mehrere Varianten von einem einzigen Dokument? Wäre es von Vorteil, bereits vorhandene Inhalte in existierenden technischen Dokumentationen wiederzuverwenden?

Einer unserer Kunden hat uns einmal gefragt: Wie bewältigt man die Erstellung von technischen Dokumenten in 23 Sprachen mit 20 Produkten und 10 Produkt Varianten? Hatten Sie jemals das Gefühl, dass Sie denselben Text wieder, und wieder und wieder geschrieben haben…

Die Antwort liegt in der Verwendung von spezieller technischer Dokumentations-Software für die strukturierte und komponentenbasierende Inhaltserstellung und dem Einsatz von XML als technologische Grundlage.

Dadurch, dass XML unabhängig vom Format der Datenausgabe ist, kann sich der technische Redakteur bzw. Autor ausschließlich auf die Inhaltserstellung konzentrieren, anstelle darüber nachzudenken, wie die Informationen am Ende im jeweiligen Datenausgabenformat konsumiert werden.

Inhalte der technischen Dokumentation werden zerlegt, klassifiziert und in strukturierter Form verwaltet. Text und Bilder werden als „Komponenten“ gespeichert was das automatische Zusammenfügen des endgültigen Dokuments ermöglicht.