Varianten in der technischen Dokumentation (3) – Plug-In im strukturierten FrameMaker

Immer wieder begegnen wir Varianten in der technischen Dokumentation und immer möchten und müssen wir ihnen Herr werden. In meinem ersten Beitrag zum Themengebiet „Varianten in der technischen Dokumentation“ habe ich den Einsatz von Variablen diskutiert. Diese sind geeignet, kleinere Unterschiede zwischen Dokumenten zu steuern. In der technischen Dokumentation differenzieren Texte häufig nicht nur durch verwendete Produktnamen oder Leistungsangaben. Dann stoßen wir mit dem Werkzeug „Variablen“ an Grenzen. Mit diesem Aspekt setzte sich ein zweiter Beitrag zum Thema Varianten auseinander. Die beiden ersten Artikel konzentrierten sich auf das Arbeiten mit dem sogenannten unstrukturierten FrameMaker. In diesem Beitrag wende ich mich nun dem strukturierten FrameMaker zu und möchte Ihnen ein Plug-In vorstellen, mit dem Sie die Varianten in Ihrer Dokumentation verwalten können – ohne ein Redaktionssystem einzusetzen.

Plug-in AXCM

Seit einigen Jahren gibt es das kostenlose Plug-In AXCM, welches das Variantenmangement effektiv unterstützt. Das Plug-In ist von einem US-amerikanischen Redakteur und Programmierer und kann hier geladen werden. Einzige Schwachstelle ist das nur bedingt hilfreiche Manual.

Mit Hilfe des Plug-In können Sie

  • Varianten einfärben
  • Varianten filteren
  • Attributwerte validieren

Vorgehensweise

  • Plug-In installieren, es erscheint in der FrameMaker-Oberfläche der neue Menüpunkt „AXCM“
  • Im FrameMaker die Farben definieren, die Sie zum Einfärben der Varianten verwenden möchten (FrameMaker: Darstellung > Farbe > Definition)
  • Im Plug-In die Attribute und Attributwerte anlegen (AXCM > Main Settings > Attribute Library)
  • Classic Schemes anlegen und verwalten (AXCM > Main Settings). Sie können Schemata für die Einfärbung und für das Filtern festlegen.
  • Generelles Verhalten des Plug-Ins steuern (AXCM > Local Preferences)

Vor Sie mit dem Färben (AXCM > Coloring), Filtern (AXCM > Filtering) und Validieren (AXCM > Validation) starten, beachten Sie bitte noch folgende Aspekte:

  • Wenn eine Textstelle mehrere Varianten gilt, dann weisen dieser Stelle mehrere Attributwerte zu. Die Attributwerte werden mit einem Leerzeichen als Trennzeichen eingegeben.
  • Wenn Sie filtern, prüfen Sie immer, dass der inhaltliche Zusammenhang sowie die Gültigkeit der Querverweise auch nachdem Filtern bestehen.
  • Empfehlung: Legen Sie für jede Variante eine Buchdatei an und passen Sie die Buchattribute entsprechend an.
  • Empfehlung: Entwickeln Sie im Vorfeld einen Produktionsplan, aus dem ersichtlich ist, welche Variante wie produziert (z. B. PDF, HTML) wird.

Nun wünsche ich Ihnen viel Spaß und Erfolg beim Variantenmanagement im strukturierten FrameMaker. Wenn Sie Fragen oder Anmerkungen haben, freue ich mich von Ihnen zu hören ed.sreog-attirb@ofni oder 0151 16512182.

Anmerkung
Der Beitrag basiert vor allem auf meinen Erfahrungen in meiner letzte Station als Angestellte bei voltwerk electronics GmbH. In einem Projekt wurde gemeinsam mit parson communication und cap studio eine FrameMaker-Anwendung auf Basis von PI-Mod entwickelt. Für die Wiederverwendung von Textmodulen wurde das Plug-In InsetPlus, für das Variantenmanagement das Plug-In AXCM eingesetzt (beide von West Street Consulting). Mehr Informationen zum Projekt finden Sie hier.

Schreibe einen Kommentar