Modularisierung

Basierend auf "Sinneinheiten" M. Mattusch 1995

Bedingung:

Die Menge bzw. das System in denen die Module verwaltet werden, ist/wird kontrolliert.

 

Regeln:

  1. Zu einem Thema gibt es nur ein Modul.
  2. Das Modul beschreibt das Thema vollständig.
  3. In den Modulen werden allgemeine Begriffe verwendet, keine spezifischen Produkt- oder Markennamen (Stichwort Terminologiearbeit).
  4. Produkt- bzw. Markennamen werden jeweils in einem Modul geführt und als einer der einleitenden Teile einer Gesamtdokumentation verwendet. Es wird dann in einem Modul darauf hingewiesen, dass im Weiteren nur noch allgemeine Bezeichnungen verwendet werden (Beispiel Begriff "Maschine").
  5. Die Module werden aufgrund ihrer Überschrift klassifiziert. Weiterhin werden zusätzliche Metadaten und Klassifizierungsmerkmale in Eigenschaftsfeldern der Module geführt.

 

Abbildungen:

  • In Abbildungen werden nur Objekte referenziert.
  • Abbildungsuntertitel benennen nur Objekte.
  • Handlungen, die zu den Objekten in der Abbildung gehören, werden in separaten Modulen beschrieben, die entweder vor oder hinter der Abbildung stehen.
    • Grund: Um die Abbildung zum Beispiel für verschiedene Handlungsanweisungen wieder verwenden zu können, darf die Abbildung selbst und der Abbildungstitel keine spezifischen Stichworte zu Handlungen enthalten.

Verwaltung:

Stichwort PI-Mod.

Wann lohnt sich Modularisierung?

 

Modularisierung bedeutet auch Aufwand.

Sie lohnt sich, wenn ein Thema (das in einem Modul vollständig abgehandelt wird) an verschiedenen Stellen wiederverwendet wird. Damit kann man sicherstellen, dass:

  • Die Konsistenz des Inhalts gewahrt bleibt
  • Das Änderungen sofort auch an allen Stellen der Wiederverwendung angewandt werden.

 

Wenn man sicher sein kann, dass man ein Thema nur an einer einzigen Stelle braucht und dieses Thema nie wieder verwenden und nie wieder finden will/muss, kann man auf eine Modularisierung verzichten.