Redaktionsprozess: DITA optimiert die Technische Doku

Wikipedia sagt: DITA steht für Darwin Information Typing Architecture. Dort lesen Sie auch, dass es sich um ein Dokumentenformat handelt, welches auf XML beruht. XML steht für Extensible Markup Language. Außerdem werden Sie mit DTD konfrontiert, was für Dokumenttypdefinition steht. Sie verstehen gerade nur Bahnhof? Kein Problem: Wir bringen Licht ins Dunkel und erklären, wie Sie DITA nutzen können, um Ihren Redaktionsprozess in der Technischen Dokumentation auf Vordermann zu bringen.

 

 

Der Redaktionsprozess und DITA

 

Der Redaktionsprozess in der Technischen Dokumentation umfasst die Beschaffung, Zusammenstellung und Gestaltung von Informationen, die für eine Veröffentlichung vorgesehen sind. Regeln sorgen dafür, dass der Nutzer eine Chance hat, die benötigten Informationen zu finden und zu verstehen. Das betrifft sowohl die Formulierung der Inhalte als auch die Formatierung der Texte und die Einordnung von grafischen Elementen.

 

 

Auszeichnung von Texten damals

 

In der Zeit, als „Drucker“ noch ausschließlich ein Beruf war, mussten die Redakteure dem Drucker mitteilen, wie das Endprodukt aussehen soll. Zu diesem Zweck haben sie den Text mit Anweisungen versehen. Zum Beispiel:

 

  • Überschrift 1 – Schriftart, Schriftgröße, Ausrichtung in der Zeile, Abstand zum Text…
  • Bild – Größe, Einfügeort, Textfluss, Beschriftung…
  • Fließtext – Blocksatz, Anzahl Spalten, Absatzanfang eingerückt, Abstand zwischen den Absätzen…
  • Liste – Aufzählungszeichen, Abstände…

 

 

Die Anweisungen wurden Auszeichnung genannt. Der ausgezeichnete Text konnte demnach grottenschlecht sein – Hauptsache der Drucker wusste, was er zu tun hatte. Übrigens bestanden die Auszeichnungen damals häufig aus Symbolen, also Zeichen, die der Drucker deuten konnte. Mit der Auszeichnung eines Textes war der Redaktionsprozess – bis auf das Korrekturlesen – beendet.

 

 

Auszeichnung von Texten heute

 

Heute denkt beim Begriff „Drucker“ kaum noch jemand an den Beruf. Aber die Art und Weise, wie dem Bürogerät mitgeteilt wird, wie es die Farben auf dem Papier verteilen soll, ist im Prinzip die gleiche geblieben. Und was dem Drucker recht ist, ist dem Bildschirm billig. Da läuft es genauso.

 

XML MarkupEs wurden maschinenlesbare Sprachen für die benötigten Anweisungen entwickelt. Der Oberbegriff dafür lautet Auszeichnungsprachen oder englisch: Markup Language (ML). Eine davon ist die eXtensible Markup Language (XML).

 

Der werktätige Drucker hatte eine Lehre absolviert. Der maschinelle Drucker (einschließlich Bildschirmbeleuchter) ist eigentlich dämlich. Dem muss man vieles ganz ausführlich erklären. Eine Erklärung wird im gehobenen Sprachgebrauch zur Deklaration. Die steht meistens ziemlich am Anfang von Programmen.

 

Um dabei den Überblick zu behalten, schafft man sich ein System von Dokumenttypen. Man legt fest, wie gleichartige Dokumente aufgebaut sein sollen, was drin stehen soll und vergibt einen Namen. Die Festlegung ist die Dokumenttypdefinition (DTD). Dann kann man in der Deklaration zum Beispiel sagen, mit „viv“ meine ich ein verlinktes Inhaltsverzeichnis. Das Programm guckt in der DTD nach und sieht, dass es aus den Überschriften, den zugehörigen Seitenzahlen und den Links zu den entsprechenden Seiten besteht.

 

 

Was bedeutet das für den Redaktionsprozess?

 

Mit den beschriebenen Methoden können Sie den Redaktionsprozess effizienter gestalten. Und DITA hilft dabei, die Möglichkeiten der Effizienzsteigerung ausschöpfen zu können. Das D in DITA steht für Darwin, tatsächlich Charles Darwin, der sich viel Ärger eingehandelt hat, als er erklärte, wie die Arten von Lebewesen entstanden sind: durch Vererbung und Spezialisierung. Diese Grundidee findet sich in DITA wieder. I und T bedeuten Information und Typisierung. DITA bringt umfangreiche Dokumenttypdefinitionen mit und ermöglicht deren Anpassung an individuelle Bedürfnisse. Das A für Architektur weist auf den Aufbau der Informationsstruktur und die Regeln für die Verarbeitung und Wiederwendung von Informationen hin.

 

DITA und der Redaktionsprozess
Der praktische Nutzen von DITA für den Redaktionsprozess besteht hauptsächlich darin, dass einmal gespeicherte Informationen für unterschiedliche Zwecke zusammengestellt und zielgerichtet an Nutzer weitergeleitet werden können.

 

Die Auszeichnung bestimmt nicht nur die Darstellung, sondern auch die Verarbeitung von Informationen.

 

 

Das hat drei Vorteile:

 

  1. Jede Information braucht nur einmal erstellt und an einem Ort gespeichert zu werden. Ist eine inhaltliche Änderung erforderlich, erfolgt sie dort und überträgt sich automatisch auf alle Kopien.
  2. Die Informationen können beliebig oft wiederverwendet und unterschiedlich zusammengestellt werden. Zu diesem Zweck lassen sich die definierten Dokumenttypen nutzen oder daraus neue Dokumenttypen ableiten.
  3. Der Nutzer erhält über sein Ausgabegerät konkret die Information, die er haben will – und zwar in dem Format, das er braucht.

 

 

Welche Anforderungen stellt DITA an den Redaktionsprozess?

 

Für die Nutzung von DITA im Redaktionsprozess müssen die Informationen in kleinen Einheiten erstellt und mit Metadaten vervollständigt werden. Die Informationseinheiten werden Topics genannt. Ein Topic enthält die Antwort auf eine konkrete Frage. DITA kennt fünf Topictypen:

 

  • Generisches Topic als Basis für die anderen Topictypen, für Antworten auf Fragen, die sich in den anderen Typen nicht unterbringen lassen und für die Erzeugung eigener Topictypen.
  • Konzept ist eine Spezialisierung des generischen Topics und soll eine Frage beantworten, die mit „Was ist…? beginnt.
  • Glossar ist eine Spezialisierung des Konzept-Typs für Begriffsdefinitionen.
  • Aufgabe beantwortet eine Frage nach der Anweisung für eine konkrete Handlung.
  • Referenz ist für die Antwort auf die Frage nach Eigenschaften oder Werten vorgesehen.

 

 

DITA im RedaktionsprozessMetadaten sind Informationen über die Topics, die die Auszeichnung, Zuordnung und Verarbeitung der Informationsinhalte ermöglichen.

 

Die Topics sind voneinander unabhängig. Mit Hilfe von Maps werden die Topics ausgesucht und sortiert, die für die Ausgabe vorgesehen sind. Eine Map enthält die Links zu den Topics und die Struktur, die das Ausgabedokument bekommen soll. Sie entspricht dem Inhaltsverzeichnis des Dokumentes. Über Metadaten lässt sich beeinflussen, wie die Informationen in unterschiedlichen Ausgabeformaten (PDF, Onlin-Hilfe, HTML…) dargestellt werden sollen und welche Informationen für bestimmte Anfragen ausgewählt werden.

 

Bei der Erstellung der Maps und der Zuordnung von Metadaten im Redaktionsprozess hilft das DITA Open Toolkit. Wie der Name andeutet, ist das Toolkit wie auch DITA als Freeware kostenlos nutzbar.

 

 

Fazit und ein letzter Tipp

 

Wie Sie sehen, kann DITA Sie bei der Arbeit im Redaktionsprozess unterstützen. Doch zunächst kommen Sie wohl nicht umhin, etwas Zeit und Mühe zu investieren, um sich in die Materie einzuarbeiten. Unser Tipp: Beschäftigen Sie sich zunächst mit dem Thema XML. Dann wird es Ihnen nicht mehr schwer fallen, Informationen in Form von Topics zu sammeln und daraus bedarfs- und zielgerechte Dokumente für einen effizienteren Redaktionsprozess zusammenzustellen.

 

Bildquellen: Pixabay

Ich habe Interesse an einer Schulung

* Erforderliche Felder
Cookie Consent mit Real Cookie Banner