9 Fachbegriffe, die Technische Redakteur:innen kennen sollten

Melina Kininger von

Fachbegriffe Technische Redatkion

Im Fachbereich der Technischen Dokumentation begegnen einem tagtäglich unterschiedliche Fachbegriffe. Gerade wenn Du noch relativ neu in der Technischen Dokumentation bist, kann dies oft zu Verwirrung führen. Daher habe ich Dir in diesem Beitrag 9 wichtige Fachbegriffe in der Technischen Redaktion aufgelistet und erklärt.

Terminologie

Das Wort Terminologie ist besonders wichtig, wenn es um das standardisierte Verfassen von Technischen Dokumentationen geht. Durch eine festgelegte und im nächsten Schritt dann auch korrekt verwendete Terminologie, wird sichergestellt, dass immer die gleichen Wörter verwendet werden.

Lass uns an dieser Stelle einen Blick auf die genaue Definition des Wortes Terminologie werfen: Der Begriff Terminologie beschreibt die Gesamtheit der Fachwörter in einem Themenbereich. So gebe ich Dir in diesem Beitrag zum Beispiel Einblick in die Terminologie des Fachthemas Technische Dokumentation.

Content-Management-System (CMS)

In einem Content-Management-System werden, wie der Name schon sagt, Inhalte gemanagt bzw. verwaltet. Vielleicht kennst Du solche CMS bereits aus der Webseitenerstellung. Denn dort finden diese auch Verwendung. Beispielsweise WordPress ist ein solches CMS. Diese CMS nennen sich dann aber Web-Content-Management-System.

In der Technischen Redaktion wird ein CMS primär mit dem Ziel eingesetzt, das Erstellen von Technischen Dokumenten effizienter zu machen. Ein CMS wird unter anderem für die Aufgliederung von Dokumentationen in einzelne Module bzw. Sinneseinheiten verwendet. Durch diese Aufgliederung können die einzelnen Module in unterschiedlichen Dokumenten wiederverwendet werden. Doppelter Content wird dadurch vermieden, was wiederum eine Menge an Arbeit spart. Aus den einzelnen Modulen können dann im Handumdrehen passende Informationsprodukte generiert werden. In der Technischen Dokumentation wird daher meist von einem Component-Content-Management-Sysetem (CCMS) gesprochen.

Ein CMS wird des Weiteren für folgende Dinge eingesetzt:

  • Trennung von Layout und Inhalt
  • Workflow-Steuerung
  • Versionierung
  • Verwaltung von Inhalten in mehrere Sprachen
  • Arbeiten im Team an den gleichen Inhalten

Single Sourcing

Wenn in der Technischen Dokumentation von Single Sourcing gesprochen wird, ist damit gemeint, dass ein Inhalt an verschiedenen Stellen verwendet wird, er aber nur einmal wirklich vorhanden ist.

Du kannst Dir das so vorstellen: Inhalt A wird in Dokumentation 1 und Dokumentation 2 verwendet. Nun wird der Inhalt aber nicht direkt in die Dokumentationen hineinkopiert, sondern lediglich referenziert. So bleibt sichergestellt, dass der Inhalt nur an einer Stelle seine Quelle hat. Das hat den Vorteil, dass bei Änderungen nicht alle Dokumentationen, in denen der Inhalt A verwendet wird, angepasst werden müssen. Lediglich eine gemeinsame Quelle muss angepasst werden.

Single Sourcing spart Dir einiges an Zeit. Zudem wird die Dokumentationserstellung weniger fehleranfällig, da Du Deine Inhalte immer nur an einer Stelle und einmal anpassen musst. Single Sourcing lässt sich wunderbar über ein CMS (wie oben schon erklärt) umsetzen.

Content-Delivery-Portal (CDP)

Auch hier ist der Name wieder sprechend. In einem CDP werden Inhalte einem Nutzer über das Internet bereitgestellt. Damit ist ein CDP ein Portal, welches dem Leser alle relevanten Informationen zu einem Produkt abrufbar macht.

Das Ziel eines CDP ist es, dem Leser immer genau die Information bereitzustellen, die er benötigt. Damit bieten CDP eine sehr gute Ergänzung zu klassischen Dokumentationen im PDF-Format. Die Informationen werden dem Leser in einem CDP sozusagen Häppchenweise vermittelt. Zugang zu den Inhalten hat der Leser dabei beispielsweise über einen Strukturbaum oder über die Suche des CDPs.

Die Auszeichnungssprache XML

Die Abkürzung XML steht für Extensible Markup Language. XML ist eine sogenannte Auszeichnungssprache zur Dokumentenauszeichnung. Mit dieser Auszeichnungssprache können Daten hierarchisch und strukturiert dargestellt werden. Eine Datei, die mit XML geschrieben ist, kann sowohl vom Menschen als auch von einer Maschine erfasst werden.

Aber wie genau sieht eine Datei aus, die mit XML geschrieben ist? Eine solche Datei besteht aus Inhalten und Textauszeichnungen. Diese Auszeichnungen stehen in spitzen Klammern und heißen Tags. Sie werden um die einzelnen Textpassagen gesetzt. Durch diese Tags kann dem Text in einem späteren Schritt beispielsweise ein spezifisches Layout zugewiesen werden.

Modul

In der Technischen Redaktion ist mit einem Modul ein einzelner Inhalts-Baustein gemeint, welcher in Kombination mit anderen Modulen ein gesamtes Dokument ergibt. Oft wird anstatt von Modul auch von Topic gesprochen. Module kommen dann zum Einsatz, wenn man bei der Dokumentationserstellung eine Wiederverwendung von Inhalten anstrebt.

Die Module werden an einer zentralen Stelle, wie einem CMS, verwaltet und mit Metadaten ausgestattet. Wenn nun zu einem bestimmten Produkt ein Technisches Dokument benötigt wird, können durch die Metadaten die passenden Module ausgewählt (und wiederverwendet werden) und ein ganzes zusammenhängendes Dokument erstellt werden. Die Dokumentationserstellung wird so effizienter.

Standardisierung

Das Wort Standardisierung ist in der Technischen Redaktion sehr wichtig. Durch eine gut durchgeführt Standardisierung kommen nicht nur die Technischen Redakteure schneller zum Ziel, sondern auch die Leser der Technischen Dokumente.

Unter einer Standardisierung wird verstanden, dass alle Inhalte, die in der Redaktionsabteilung vorhanden sind, unter bestimmten Vorgaben und damit einheitlich erstellt werden. Das kann zum Beispiel eine einheitliche Terminologie oder auch eine einheitliche Formulierungsweise von Handlungsaufforderungen sein.

Das Standardisieren von Technischen Dokumenten hat wie bereits beschrieben einige Vorteile. Dazu zählen:

  • schnellere und effizientere Dokumentationserstellung
  • bessere Übersetzbarkeit
  • bessere Verständlichkeit für den Nutzer
  • höhere Qualität der Technischen Dokumente

Cross Media Publishing (CMP)

Beim Cross Media Publishing werden diverse unterschiedliche Austauschformate aus einer gemeinsamen Quelle erstellt. Aus einer Quelle werden somit unterschiedliche Medien bespielt. Hierfür werden die entsprechenden Daten medienneutral erstellt und können hierdurch in verschiedenen Medien ohne erneute Bearbeitung veröffentlicht werden.

Diese medienneutrale Erstellung kann beispielsweise durch die Auszeichnungssprache XML geschehen. Hierdurch wird der Inhalt vom Layout getrennt und die Quelldatei bleibt damit medienneutral. Die Layoutinformationen werden dabei erst zum Zeitpunkt der Publikation hinzugefügt.

Metadaten

Metadaten sind Daten, die einem Informationsprodukt angehängt werden. Sie geben beispielsweise Auskunft über den Inhalt, den Verfasser und sonstige Daten, die wichtig sind. Metadaten bestimmen damit die Position des Informationsprodukts im Informationsraum. Zu dem Thema Metadaten haben wir bereits einen Blogbeitrag geschrieben. Schau gerne dort vorbei, wenn Du mehr erfahren möchtest. Hier gehts zum Blogbeitrag über das Thema Metadaten.

Wie Du siehst, hängen die Fachwörter ziemlich stark miteinander zusammen und werden oft zur Beschreibung der jeweils anderen Wörter verwendet. Wenn Du aber einmal die Basics verstanden hast, wird die ganze Sache schon viel einfacher. Ich hoffe, Du konntest durch diesen Beitrag ein gutes Verständnis der wichtigsten Fachbegriffe in der Technischen Dokumentation bekommen.

Falls Du noch mehr spannende Themen rund um die Technische Dokumentation entdecken willst, schau Dich auf unserem Blog um. Es warten viele spannende Themen auf Dich!