modulare Dokumentation

Grundkonzepte: Was ist Modularisierung?

Mit einem modularen Content Management System (CCMS) wie SCHEMA ST4 können Sie Inhalte in Form von Modulen, Topics oder Knoten verwalten. Das bedeutet unter anderem, dass Sie für ein Kapitel nur einmal einen einzigen Abschnitt erstellen und ihn dann an verschiedenen Stellen wiederverwenden können. Änderungen im Original werden automatisch in den Wiederverwendungen eingefügt.

In diesem Beitrag werfen wir einen Blick darauf, was Modularisierung im Wesentlichen bedeutet und wie man letztlich mit Knoten in SCHEMA ST4 arbeitet.

In einem CCMS ist es nicht mehr möglich, Inhalte linear wie in einem einzelnen fortlaufenden Dokument zu verwalten, sondern Inhalte werden aus Abschnitten oder Kapiteln “modular”, erstellt und am Ende zu einer endgültigen Struktur in einem Projekt zusammengefügt.

 

Was bedeutet ein Knoten? Ein Knoten ist eine für sich stehende Inhaltseinheit, z.B. ein Sicherheitshinweis: “Achtung: Schutzhandschuhe tragen”. Unser Sicherheitshinweis wurde als Knoten erstellt, da er in verschiedenen Kapiteln und Dokumenten verwendet werden kann.

Die Größe des Knotens hängt im Wesentlichen vom CMS-Informationsmodell ab. Man könnte meinen, je fragmentierter die Inhalte, desto flexibler wird das System. Dies ist jedoch nicht immer der Fall!

Inhalte, die wir in einem CCMS modular in Form von Knoten verwalten, haben immer einen bestimmten Zweck. Die einzelnen Knoten können je nach Projekt Teile einer Betriebsanleitung, einer Fehleranalyse oder auch eines Marketingtextes sein.

Typische Knoten sind Kurzbeschreibungen von Produkten in Form von Lauftexten, Sicherheitshinweisenn, technischen Daten, Grafiken, Produktbezeichnungen, usw.

Unser Praxisbeispiel: eine Wartungstabelle

Wie sieht das ST4 aus? Betrachten wir ein Beispiel aus einem Wartungskapitel.

Werfen wir einen Blick darauf, wie wir diesen Abschnitt modularisieren können.

Knoten identifizieren

Die Stärke eines CCMS liegt insbesondere in der modularen Erstellung von Inhalten. Eines der besten Merkmale ist, dass Sie Inhalte, z.B. einen Sicherheitshinweis, nur einmal erstellen müssen und diesen dann wiederverwenden können. Die folgenden Fragen sind beim Umstrukturieren der Dokumentation und beim Schreiben von Knoten wichtig:
• Worin unterscheiden sich die Varianten voneinander?
• Wo kann ich Inhalte wiederverwenden?
Hier sehen Sie, dass wir bei Verwendung des Begriffs Modularisierung auch automatisch von Wiederverwendung sprechen.
Deshalb ist es nötig, den Text und die Größe des Knotens so zu gestalten, dass dieser wiederverwendbar wird. Wir können z. B. unterteilen in:
• Produktgruppen
• Endverbraucher

Granularität der Knoten

In ST4 können Sie die Knoten natürlich in verschiedenen Größen und in verschiedenne Projekten verwenden. Im Wesentlichen gibt es zwei Kategorien, die die Größe und Verwendung eines Knotens bestimmen:
Abschnittsebene (Kategorie 1) oder Wortebene (Kategorie 2). Die folgenden Kriterien helfen Ihnen, die richtige Entscheidung zu treffen:

Kategorie 1: Modularisierung auf Abschnittsebene

•       Ganze Sätze, Absätze oder Kapitel, die in verschiedenen Kontexten wiederverwendet werden können. Die Länge des Textes und der Knoten variiert je nach Bedarf.

Kategorie 2: Modularisierung auf Wortebene

•       Feste Begriffe wie die Produktnomenklatur werden in einer einzigen filterbaren Variable zusammengefasst.

Glossar: Modularisierung

Es gibt mehrere Möglichkeiten, Knoten im ST4-Informationspool anzulegen. Definieren wir, wie:

Fragment

  • Ein Fragment ist ein Inhaltscontainer, der zur Wiederverwendung auf Abschnittsebene bestimmt ist. Das Fragment muss immer in einen Knoten eingefügt werden.

Grafik-Ressourcen

  • Die Grafiken werden in einem Behälter „Grafik-Ressource“ gespeichert, der mit einem Diamanten vergleichbar ist. Die Grafiken können sprachneutral sein. In diesem Fall werden sie immer auf die gleiche Weise veröffentlicht. Eine Grafik-Ressource kann aber auch automatisch je nach Sprache der Veröffentlichung variieren. Dann sind die Grafiken in unserem Container nicht sprachneutral, sondern sprachabhängig.

Variablen

  • Ein Objekt, das je nach Produktvariante unterschiedliche Inhalte, wie z.B. Namen wiedergeben kann. Die Inhalte werden durch entsprechende Filter zugewiesen.

Im Projekt:

Filter und Metadaten

  • Der Filtermechanismus ermöglicht es Ihnen, Inhalte bei der Erstellung von Dokumenten ein- oder auszuschließen. Filter filtern Metadaten oder Variablen (z.B. Metadaten der Vertriebsregion: Deutschland).

Spezifisches Layout

  • Wir können während der Produktion unserem Knoten unterschiedliche Layouts zuzuordnen. Das erhöht die Wiederverwendung eines Knotens.

Sind Sie an SCHEMA ST4 oder Beratung zu diesem Thema interessiert? Dann kontaktieren Sie uns!

Diesen Artikel teilen

Share on facebook
Share on xing
Share on twitter
Share on linkedin
Share on print
Share on email

Schreibe einen Kommentar