Modularisierung in der technischen Redaktion

Standardisierung und Modularisierung

Die Modularisierung in der technisches Dokumentation

 

Hand in Hand mit der Standardisierung geht die Modularisierung. Doch was ist das überhaupt, und macht das überhaupt für alle Produkte Sinn?
Diesen Fragen gehen wir in diesem Blogartikel nach.

 

Am besten lässt sich der Begriff „Modularisierung“, der für die meisten wahrscheinlich doch recht abstrakt ist, mit der Vorgehensweise der Automobilindustrie erklären. Ein Hersteller der verschiedene Marken unter seinem Dach vereint, designed beispielsweise ein neues Chassis für einen SUV.
Dieses Chassis (also das Modul) wird bei zwei verschiedenen Marken mit etwas unterschiedlichen Designs und Ausstattungen verbaut und natürlich unter verschiedenen Namen verkauft.
Das Chassis bleibt aber bei allen Autos gleich. Dadurch können sowohl Produktions- als auch Entwicklungskosten massiv gesenkt werden.

Modularisierung in der technischen Dokumentation

 

Dieser Vorgang lässt sich auch auf die technische Dokumentation ummünzen. Die Module sind hier allerdings keine Chassis, sondern Textbausteine und – wenn erforderlich – auch Grafiken, die immer wieder verwendet werden können.  Das spart natürlich einerseits Kosten und reduziert andererseits den Aufwand. Denn einmal geschrieben und modularisiert, können die Textbausteine immer wieder verwendet werden.

 

Zudem trägt die Modularisierung auch einiges zur Qualitätssicherung bei. Einmal an einer zentralen Stelle geändert, standardisiert und vor allem modularisiert kann beispielsweise eine Bedienungsanleitung immer wieder verwendet werden.

Sinnvoll modularisieren

 

Um die Kosten und den Aufwand zu senken, müssen beziehungsweise sollten, die Module natürlich für viele verschiedene Produkte passen. Das ist aber gar nicht so einfach und in manchen Fällen (leider fast) unmöglich.  Zunächst einmal sollte ein Fahrplan erstellt werden, was eigentlich genau modularisiert werden soll. Hier kann ein Redaktionssystem äußerst hilfreich sein.

 

Weiterhin gilt es festzulegen, wie die Module aussehen sollen. Handelt es sich komplette Kapitel oder eher um einzelne Textbausteine?
Von daher ist es erforderlich, dass sich der technische Redakteur ein sehr genaues Bild von dem Produkt macht, das er standardisieren beziehungsweise modularisieren soll. Denn schließlich muss er wissen, wie das Ganze genau funktioniert.
Extrem wichtig sind auch die Metadaten, die für jedes Modul erstellt werden müssen. Sie beschreiben was sich in dem Modul befindet. Dadurch muss der technische Redakteur nicht erst stundenlang in Kleinstarbeit alle Dateien durchsuchen, wenn das Modul beispielsweise an anderer Stelle benötigt wird.
Außerdem stehen in den Metadaten auch wer das Modul geschrieben hat, in welchem Stadium es sich befindet (falls es noch in Arbeit ist) und ob es bereits Übersetzungen dafür gibt.

Grundsätzlich wird zwischen folgenden Modultypen unterschieden:

  • Module die sich in allen Dokumentation finden, zum Beispiel Sicherheitshinweise
  • Module die sich, zumindest potentiell, in mehreren Dokumenten verwenden lassen könnten
  • Module die nur einmalig zum Einsatz kommen, zum Beispiel für eine Beschreibung beziehungsweise Bedienungsanleitung für eine Einzelanfertigung

 

Bei aller Standardisierung und Modularisierung gilt es außerdem, den Nutzer nicht aus den Augen zu verlieren. Denn für ihn wird schließlich eine Bedienungsanleitung geschrieben.

Wann lohnt eine Modularisierung und wann nicht?

 

Nicht für alle Produkte ist eine Standardisierung und Modularisierung sinnvoll. Bedienungsanleitungen für kurzlebige Produkte sollten eher nicht modularisiert werden. Denn hier lohnt sich der ganze Aufwand gar nicht. Ebenso beispielsweise im Sondermaschinenbau, wo die Maschinen speziell auf die Kundenanforderungen abgestimmt werden. Das gleiche gilt natürlich auch für speziell gefertigte Einzelstücke. Die Standardisierung und Modularisierung lohnt sich dann, wenn Produkte in großer Stückzahl hergestellt werden, und es von vorneherein geplant ist, diese langfristig auf den Markt zu werfen.
Geringfügige Änderungen, beispielsweise bei einem „Facelift“, können schnell im entsprechenden Modul erfasst werden. Somit ist die Bedienungsanleitung immer aktuell. Grundvoraussetzung ist allerdings, dass immer wieder die gleichen Teile, auch mit geringfügigen Änderungen, verbaut werden.

Wenn Sie Unterstützung bei der Standardisierung und Modularisierung benötigen sprechen Sie uns gerne an!

Im nächsten Blogartikel dreht sich alles um den Bestandsschutz von Altanlagen im Maschinenbau