Einfach zum Ziel   
 Produkt.Design   Produkt.Dokumentation   Produkt.Werbung 

Home Sonstige Leistungen Schaufenster Unternehmen Kontakt

Anwenderhandbuch für ein Content-Management-System:

Online und Offline aus einer Quelle

Ausgangspunkt

Ein Unternehmen aus der Online-Branche hatte ein Content Management-System in Java geschrieben, das über einen beliebigen Internet-Browser mit Inhalten gefüllt werden konnte. Die Inhalte waren bislang ausschließlich zur Publikation im Internet gedacht. Es gab ein rudimentäres Hilfesystem auf HTML-Basis, ein Handbuch jedoch nicht.

Konzept

Bei unserem Gesellschafter wurde ein Handbuch (Papier) angefragt. Statt einfach ein Angebot für ein Handbuch abzugeben, empfahl unser Gesellschafter, das "Handbuch" im Content Manager selbst zu schreiben. Dies würde drei Vorteile auf einmal bringen:

  • Intensive praktische Beschäftigung mit dem Content Manager, was sich in der Qualität der Hinweise im Handbuch ausdrücken würde
  • Bereitstellung einer umfassenden Online-Hilfe im HTML-Format durch einfache Generierung aus dem Content Manager heraus
  • Bereitstellung eines Handbuchs

Während die Generierung einer Online-Hilfe aus den im Content Manager zuvor erfassten Inhalten für dieses System quasi Standardaufgabe war — es war ja für HTML-Publikationen entwickelt — mussten zur Generierung eines druckfähigen Handbuchs auf Knopfdruck noch spezifische Routinen geschrieben werden: HTML lässt sich noch nicht mit Standardtools auf Knopfdruck in ein Druckwerk mit Kopf- und Fußzeilen, Überschriften, Querverweisen, Inhaltsverzeichnissen, Index und was sonst so alles ein gutes Buch ausmacht, konvertieren.

Lösung

Da das Konzept und sein Mehrwert den Auftraggeber überzeugte, wurden die Texte für Handbuch und Hilfesystem im Content Manager geschrieben, Screenshots und andere Grafiken in der für den Content Manager üblichen Weise eingebunden. Über zwei verschiedene Templates wurden einerseits das Hilfesystem, andererseits die Ausgangsdateien für das Handbuch generiert. Im Content Manager hinterlegte Kommentar-Tags sorgten dafür, dass für das Layout-Programm (Word) der Buchausgabe notwendige Metainformationen bereitgestellt wurden.

Eine Anzahl extra erstellter VBA-Makros (Visual Basic for Applications) besorgte die Umsetzung der HTML-Dateien in ein druckbares Handbuch, mit allen Querverweisen, Index und Inhaltsverzeichnis auf Knopfdruck, auch Absätze wurden bei Seitenumbrüchen korrekt zusammengehalten, Kapitel und Abschnitte nummeriert, Grafiken korrekt eingebunden usw. Als die nächste Software-Version dokumentiert wurde, konnte ohne manuellen Aufwand aus den neuen HTML-Dateien die nächste Handbuch-Version generiert werden. Die Makros sind in ihrer Struktur natürlich hinreichend allgemein, so dass auch andere Projekte damit konvertiert werden können. Dabei können die HTML-Dateien auch aus anderen Quellen als diesem spezifischen Content Manager stammen.

Das Druckbild (erstes Bild unten) zeigt verschiedene Auszeichnungen, die per <p class="xxx">-Tags schon in den Quelldaten definiert wurden. Das Warnzeichen (das Dreieck mit Ausrufezeichen) gibt es nur im Handbuch und ist allen Absätzen mit dem Tag <p class="Hinweis"> zugewiesen worden. Deutlich ist auch die nur im Handbuch vorhandene Nummerierung der Überschriften und der korrekte Verweis auf andere Abschnitte (hier: 1.3.1 und 1.3.2) zu sehen. Das zweite Bild zeigt einen Screenshot, wie sich der Text dem Redakteur im Content Manager darstellt.

(Ein Ausschnitt des Handbuchs im Druckbild)
Ein Ausschnitt des Handbuchs im Druckbild

(Ein (anderer) Abschnitt des Handbuchs wie er sich im Content Manager darstellt)
Ein (anderer) Abschnitt des Handbuchs wie er sich im Content Manager darstellt