Modularisierung in der Technischen Redaktion

Wie lange bleibt uns das gute altbewährte Papier noch als Träger für Informationen erhalten? Wo bringen andere Medien Vorteile? Wie wird sich die Technische Redaktion verändern, um die Vorteile nutzen zu können? Die Technische Redaktion orientiert sich selbstverständlich an der Technik. Dort ist die Automatisierung in vollem Gang, die durch den Einsatz von Modulen an Effizienz gewinnt. Aus diesem Grund setzt sich Modularisierung auch in der Technischen Dokumentation immer mehr durch. Aber was verbirgt sich eigentlich hinter diesem Begriff?

 

 

Was bedeutet Modularisierung?

 

Ein Modul ist ein Teil eines Systems, das – unabhängig von den anderen Teilen – eine bestimmte Funktion ausübt. In einem technischen System ist das zum Beispiel ein Motor, der in unterschiedlichen Maschinen arbeiten kann. Ebenso kann eine Maschine mit verschiedenen Motortypen ausgerüstet sein. Kettensägen gibt es etwa mit Elektro- oder Verbrennungsmotoren.

 

Modularisierung bedeutet, Systeme zu entwickeln, die aus Modulen zusammengesetzt sind. Die einzelnen Teile können dann zu einer Vielzahl unterschiedlicher Systeme zusammengesetzt werden. Das Gegenteil davon ist der integrale Aufbau, bei dem die Bestandteile so aufeinander abgestimmt sind, dass sie nur im dafür vorgesehenen System genutzt werden können.

 

Ein System, das aus Modulen aufgebaut ist, braucht eine Architektur, sprich Regeln, nach denen die Einzelteile zusammenwirken. Besonders wichtig sind dabei die Anordnung der Komponenten und die Schnittstellen zwischen ihnen. In einem System aus Motor, Kupplung und Getriebe muss die Kupplung zwischen Motor und Getriebe eingebaut werden. An einer anderen Stelle wäre sie fehl am Platze. Und auch die Verbindungen zwischen den Bauteilen müssen klar definiert sein, damit alles zusammenpasst.

 

 

Was heißt Modularisierung in der Technischen Redaktion?

 

modularisierung technische dokumentationDie Technische Redaktion sammelt Informationen zu Produkten und bereitet sie für die Veröffentlichung vor. Als Ergebnis entstehen Anleitungen für den richtigen Gebrauch, die erforderliche Wartung, die Vermeidung von Gefahren und die Beseitigung von Störungen. Konventionelle Anleitungen sind nach dem Muster von Büchern aufgebaut:

 

  • Deckblatt
  • Inhaltsverzeichnis
  • einzelne Kapitel
  • Begriffserklärungen
  • Index

 

 

Bestimmte Angaben wiederholen sich in allen Anleitungen. Andere unterscheiden sich nur geringfügig. Zur Arbeitserleichterung und Zeiteinsparung dienen Textbausteine.

 

Die Textbausteine sind im Prinzip Module. Die Modularisierung der Technischen Redaktion bedeutet, alle Informationen in die Form von Textbausteinen zu bringen und nach Bedarf zusammenzustellen. Dafür ist eine entsprechende Architektur erforderlich, die vorgibt, wie die Informationen bereitgestellt werden sollen. Content Management Systeme und spezielle Standards wie DITA stellen eine derartige Architektur zur Verfügung.

 

 

Wie verändern Module die Arbeit der Technischen Redaktion?

 

Die Modularisierung erfordert, die Textbausteine nach klaren Regeln zu schreiben. Aufbau, Stil und Terminologie müssen einheitlich sein. Nur dann können Sie das Ziel einer hohen Wiederverwendbarkeit erreichen. Die Textbausteine sollen schließlich in jeder Anwendung zusammenpassen.

Soll ein Text als unabhängiger Baustein verwendbar sein, muss er in sich abgeschlossen sein. Er darf sich nicht auf andere Textstellen beziehen. Im Hintergrund steht immer eine Frage. Auf eine einfache Formel gebracht, bedeutet dies: Information = beseitigte Ungewissheit. Und wer etwas wissen will, fragt. Manche Fragen lassen sich mit einem Satz beantworten, andere brauchen ausführliche Erklärungen. Entsprechend unterschiedlich groß sind die Textbausteine. Sie können ein ganzes Kapitel umfassen, einen Absatz, eine Wortgruppe oder auch eine Wertetabelle.

Die Textbausteine müssen klassifizierbar und adressierbar sein. Klassifizierbar bedeutet, der Text muss einer Aufgabe zugeordnet werden können, die einen bestimmten Informationstyp erfordert. Informationstypen sind zum Beispiel

 

module textbausteine

  • ein Sicherheitshinweis
  • eine Begriffserklärung
  • eine Handlungsanweisung
  • die Beschreibung einer Eigenschaft
  • eine Ersatzeilliste

 

 

Adressierbarkeit ist erforderlich, um die Information in dem Moment wiederzufinden, in dem die Frage gestellt wird.

 

 

Wie lässt sich die Modularisierung in der Technischen Redaktion umsetzen?

 

Vorhandene Texte analysieren

 

Um die Modularisierung umzusetzen, brauchen Sie zuerst einen Überblick über die Produkte und Produktvarianten, für die Sie eine Anleitung erstellen wollen. Dann können Sie die Dokumente zu diesen Produkten, die schon vorhanden sind, nach folgenden Gesichtspunkten analysieren:

 

  • Gibt es Bestandteile, die sich immer oder häufig wiederholen?
  • Gibt es Textpassagen, die sich von Dokument zu Dokument nur geringfügig unterscheiden?
  • Sind Informationen vorhanden, die redundant sind, also das Gleiche bedeuten?
  • Werden die Begriffe einheitlich verwendet?
  • Welche Fragen werden in den einzelnen Abschnitten beantwortet?

 

 

Informationstypen ableiten und Regeln festlegen

 

Daraus können Sie Informationstypen ableiten, die Sie für die Klassifizierung nutzen wollen. Für jeden Informationstyp benötigen Sie eine Struktur, mit der Sie den Aufbau der zum jeweiligen Typ gehörenden Textbausteine festlegen. Finden Sie für die Terminologie und die Schreibweise einheitliche Regeln. Denken Sie auch daran, dass Sie in den Texten Variablen verwenden können, die bei einem Abruf der Information bedarfsgerecht durch konkrete Angaben ersetzt werden.

 

 

Überblick über die benötigten Textbausteine herstellen und Verzeichnis einrichten

 

Finden Sie als nächstes heraus, welche Textbausteine Sie benötigen, um alle erforderlichen Informationen zu erfassen. Schaffen Sie sich ein Verzeichnis, in dem Sie die Bausteine übersichtlich abspeichern können.

 

 

Texte formulieren und Metadaten zuordnen

 

Formulieren Sie die Texte für jeden Informationstyp nach den zuvor festgelegten Regeln. Um die Textbausteine bedarfsgerecht wiederzufinden, müssen Sie sie mit Metadaten versehen. Sinnvoll sind zum Beispiel Angaben zum Produkt und der Produktvariante, zur Zielgruppe, zur Textversion und zum übergeordneten Thema.

 

 

Musterbetriebsanleitung erstellen und testen

 

betriebsanleitung user journey

Wenn Sie alle Texte erstellt haben, können Sie eine Musterbetriebsanleitung zusammenstellen und testen, Stichwort User Journey. Teilen Sie die Anleitung an Verteter aus den verschiedenen Zielgruppen, die später auch mit ihr zu tun haben werden. Die Erfahrungen, die Sie zurückgespielt bekommen, können Sie anschließend in Ihre Arbeit einfließen lassen und sowohl die Textbausteine als auch ihre Verarbeitung optimieren.

 

 

Modularisierung in die Technische Redaktion integrieren

 

Um die Modularisierung in die Technische Redaktion zu intergieren, ist es hilfreich, die Regeln in einem Leitfaden zusammenzufassen. Beteiligen Sie alle Technischen Redakteure an der Gestaltung der Regeln. Es gelingt ihnen dann leichter, sich in die neuen Methoden einzuarbeiten.

 

 

Vor- und Nachteile für die Technische Redaktion

 

Die Vorteile der Modularisierung liegen vor allem in

 

  • der Wiederverwendbarkeit der Textbausteine
  • der Vermeidung von Redundanz durch die Speicherung an nur einem Ort
  • der bedarfsgerechten Bereitstellung von Informationen in unterschiedlichen Medien
  • der besseren Verständlichkeit durch einheitliche Strukturen und Begriffe
  • der Verringerung der Kosten für Übersetzungen in Fremdsprachen
  • der Vereinfachung der Aktualisierung und Qualitätskontrolle

 

 

Die Modularisierung der Technischen Redaktion ist dann vorteilhaft, wenn Ihr Unternehmen eine große Anzahl gleicher oder ähnlicher Produkte herstellt, die Wiederverwendbarkeit also auch genutzt wird. Für Einzelanfertigungen, in denen stets spezielle Kundenwünsche umgesetzt werden, ist der Aufwand hingegen meist zu hoch.

 

Haben Sie die neuen Methoden in der Technischen Redaktion etabliert, werden Sie eine deutliche Entlastung spüren.

 

Bildquellen: Pixabay

Maschinenumbau Risikobeurteilung
Tipps & Tricks

Maschinenumbau? Aber sicher!

Seit Ausbruch des Corona-Virus gibt es keine ruhige Minute mehr. Produkte wie Desinfektionsmittel und Schutzausrüstung, aber auch Systeme aus der Lagerlogistik zur Förderung und Verpackung

weiterlesen »

Ich habe Interesse an einer Schulung

* Erforderliche Felder
Cookie Consent mit Real Cookie Banner